#!/usr/local/bin/perl use Config; use File::Basename qw(&basename &dirname); use Cwd; use File::Spec::Functions; # List explicitly here the variables you want Configure to # generate. Metaconfig only looks for shell variables, so you # have to mention them as if they were shell variables, not # %Config entries. Thus you write # $startperl # to ensure Configure will look for $Config{startperl}. # $perlpath # This forces PL files to create target in same directory as PL file. # This is so that make depend always knows where to find PL derivatives. $origdir = cwd; chdir dirname($0); $file = basename($0, '.PL'); $file .= '.com' if $^O eq 'VMS'; open OUT, ">$file" or die "Can't create $file: $!"; # extract patchlevel.h information open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h") or die "Can't open patchlevel.h: $!"; my $patchlevel_date = (stat PATCH_LEVEL)[9]; while () { last if $_ =~ /^\s*static\s+char.*?local_patches\[\]\s*=\s*{\s*$/; } my @patches; while () { last if /^\s*}/; chomp; s/^\s+,?\s*"?//; s/"?\s*,?$//; s/(['\\])/\\$1/g; push @patches, $_ unless $_ eq 'NULL'; } my $patch_desc = "'" . join("',\n '", @patches) . "'"; my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches; close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!"; # TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is # used, compare $Config::config_sh with the stored version. If they differ then # append a list of individual differences to the bug report. print "Extracting $file (with variable substitutions)\n"; # In this section, perl variables will be expanded during extraction. # You can use $Config{...} to use Configure variables. my $extract_version = sprintf("v%vd", $^V); print OUT <<"!GROK!THIS!"; $Config{startperl} eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' if \$running_under_some_shell; my \$config_tag1 = '$extract_version - $Config{cf_time}'; my \$patchlevel_date = $patchlevel_date; my \$patch_tags = '$patch_tags'; my \@patches = ( $patch_desc ); !GROK!THIS! # In the following, perl variables are not expanded during extraction. print OUT <<'!NO!SUBS!'; use Config; use File::Spec; # keep perlbug Perl 5.005 compatible use Getopt::Std; use strict; sub paraprint; BEGIN { eval "use Mail::Send;"; $::HaveSend = ($@ eq ""); eval "use Mail::Util;"; $::HaveUtil = ($@ eq ""); }; my $Version = "1.31"; # Changed in 1.06 to skip Mail::Send and Mail::Util if not available. # Changed in 1.07 to see more sendmail execs, and added pipe output. # Changed in 1.08 to use correct address for sendmail. # Changed in 1.09 to close the REP file before calling it up in the editor. # Also removed some old comments duplicated elsewhere. # Changed in 1.10 to run under VMS without Mail::Send; also fixed # temp filename generation. # Changed in 1.11 to clean up some text and removed Mail::Send deactivator. # Changed in 1.12 to check for editor errors, make save/send distinction # clearer and add $ENV{REPLYTO}. # Changed in 1.13 to hopefully make it more difficult to accidentally # send mail # Changed in 1.14 to make the prompts a little more clear on providing # helpful information. Also let file read fail gracefully. # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs. # Also report selected environment variables. # Changed in 1.16 to include @INC, and allow user to re-edit if no changes. # Changed in 1.17 Win32 support added. GSAR 97-04-12 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18 # Changed in 1.19 '-ok' default not '-v' # add local patch information # warn on '-ok' if this is an old system; add '-okay' # Changed in 1.20 Added patchlevel.h reading and version/config checks # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt # Changed in 1.24 Added '-F' to save report HVDS 98-07-01 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000 # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000 # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000 # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000 # TODO: - Allow the user to re-name the file on mail failure, and # make sure failure (transmission-wise) of Mail::Send is # accounted for. # - Test -b option my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity, $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok); my $perl_version = $^V ? sprintf("v%vd", $^V) : $]; my $config_tag2 = "$perl_version - $Config{cf_time}"; Init(); if ($::opt_h) { Help(); exit; } if ($::opt_d) { Dump(*STDOUT); exit; } if (!-t STDIN && !($ok and not $::opt_n)) { paraprint < { 'default' => 'core', 'ok' => 'install', 'opts' => [qw(core docs install library utilities)], # patch, notabug }, 'severity' => { 'default' => 'low', 'ok' => 'none', 'opts' => [qw(critical high medium low wishlist none)], # zero }, ); die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts); my $alt = ""; if ($ok) { $alt = $alts{$name}{'ok'}; } else { my @alts = @{$alts{$name}{'opts'}}; paraprint < 5) { die "Invalid $name: aborting.\n"; } print "Please enter a \u$name [$alts{$name}{'default'}]: "; $alt = <>; chomp $alt; if ($alt =~ /^\s*$/) { $alt = $alts{$name}{'default'}; } } while !((($alt) = grep(/^$alt/i, @alts))); } lc $alt; } sub Init { # -------- Setup -------- $Is_MSWin32 = $^O eq 'MSWin32'; $Is_VMS = $^O eq 'VMS'; $Is_MacOS = $^O eq 'MacOS'; @ARGV = split m/\s+/, MacPerl::Ask('Provide command-line args here (-h for help):') if $Is_MacOS && $MacPerl::Version =~ /App/; if (!getopts("dhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; }; # This comment is needed to notify metaconfig that we are # using the $perladmin, $cf_by, and $cf_time definitions. # -------- Configuration --------- # perlbug address $perlbug = 'perlbug@perl.org'; # Test address $testaddress = 'perlbug-test@perl.com'; # Target address $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug); # Users address, used in message and in Reply-To header $from = $::opt_r || ""; # Include verbose configuration information $verbose = $::opt_v || 0; # Subject of bug-report message $subject = $::opt_s || ""; # Send a file $usefile = ($::opt_f || 0); # File to send as report $file = $::opt_f || ""; # File to output to $outfile = $::opt_F || ""; # Body of report $body = $::opt_b || ""; # Editor $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT} || ($Is_VMS && "edit/tpu") || ($Is_MSWin32 && "notepad") || ($Is_MacOS && '') || "vi"; # Not OK - provide build failure template by finessing OK report if ($::opt_n) { if (substr($::opt_n, 0, 2) eq 'ok' ) { $::opt_o = substr($::opt_n, 1); } else { Help(); exit(); } } # OK - send "OK" report for build on this system $ok = 0; if ($::opt_o) { if ($::opt_o eq 'k' or $::opt_o eq 'kay') { my $age = time - $patchlevel_date; if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) { my $date = localtime $patchlevel_date; print <<"EOF"; "perlbug -ok" and "perlbug -nok" do not report on Perl versions which are more than 60 days old. This Perl version was constructed on $date. If you really want to report this, use "perlbug -okay" or "perlbug -nokay". EOF exit(); } # force these options unless ($::opt_n) { $::opt_S = 1; # don't prompt for send $::opt_b = 1; # we have a body $body = "Perl reported to build OK on this system.\n"; } $::opt_C = 1; # don't send a copy to the local admin $::opt_s = 1; # we have a subject line $subject = ($::opt_n ? 'Not ' : '') . "OK: perl $perl_version ${patch_tags}on" ." $::Config{'archname'} $::Config{'osvers'} $subject"; $ok = 1; } else { Help(); exit(); } } # Possible administrator addresses, in order of confidence # (Note that cf_email is not mentioned to metaconfig, since # we don't really want it. We'll just take it if we have to.) # # This has to be after the $ok stuff above because of the way # that $::opt_C is forced. $cc = $::opt_C ? "" : ( $::opt_c || $::Config{'perladmin'} || $::Config{'cf_email'} || $::Config{'cf_by'} ); # My username $me = $Is_MSWin32 ? $ENV{'USERNAME'} : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'} : $Is_MacOS ? $ENV{'USER'} : eval { getpwuid($<) }; # May be missing $from = $::Config{'cf_email'} if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me && ($me eq $::Config{'cf_by'}); } # sub Init sub Query { # Explain what perlbug is unless ($ok) { paraprint <; my $err = 0; while ($subject !~ /\S/) { print "\nPlease enter a subject: "; $subject = <>; if ($err++ > 5) { die "Aborting.\n"; } } chop $subject; } # Prompt for return address, if needed unless ($from) { # Try and guess return address my $guess; $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || ''; if ($Is_MacOS) { require Mac::InternetConfig; $guess = $Mac::InternetConfig::InternetConfig{ Mac::InternetConfig::kICEmail() }; } unless ($guess) { my $domain; if ($::HaveUtil) { $domain = Mail::Util::maildomain(); } elsif ($Is_MSWin32) { $domain = $ENV{'USERDOMAIN'}; } else { require Sys::Hostname; $domain = Sys::Hostname::hostname(); } if ($domain) { if ($Is_VMS && !$::Config{'d_socket'}) { $guess = "$domain\:\:$me"; } else { $guess = "$me\@$domain" if $domain; } } } if ($guess) { unless ($ok) { paraprint <; chop $from; $from = $guess if $from eq ''; } } if ($from eq $cc or $me eq $cc) { # Try not to copy ourselves $cc = "yourself"; } # Prompt for administrator address, unless an override was given if( !$::opt_C and !$::opt_c ) { paraprint <; chop $entry; if ($entry ne "") { $cc = $entry; $cc = '' if $me eq $cc; } } $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i; $andcc = " and $cc" if $cc; # Prompt for editor, if no override is given editor: unless ($::opt_e || $::opt_f || $::opt_b) { paraprint <; chop $entry; $usefile = 0; if ($entry eq "file") { $usefile = 1; } elsif ($entry ne "") { $ed = $entry; } } # Prompt for category of bug $category ||= ask_for_alternatives('category'); # Prompt for severity of bug $severity ||= ask_for_alternatives('severity'); # Generate scratch file to edit report in $filename = filename(); # Prompt for file to read report from, if needed if ($usefile and !$file) { filename: paraprint <; chop $entry; if ($entry eq "") { paraprint <$filename") or die "Unable to create report file `$filename': $!\n"; my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success"; print REP <) { print REP $_ } close(F) or die "Error closing `$file': $!"; } else { print REP <) { s/\s+//g; $REP{$_}++; } close(REP) or die "Error closing report file `$filename': $!"; } # sub Query sub Dump { local(*OUT) = @_; print OUT <; chop $entry; $ed = $entry unless $entry eq ''; } tryagain: my $sts; $sts = system("$ed $filename") unless $Is_MacOS; if ($Is_MacOS) { require ExtUtils::MakeMaker; ExtUtils::MM_MacOS::launch_file($filename); paraprint <; } if ($sts) { paraprint <; chop $entry; if ($entry ne "") { $ed = $entry; goto tryagain; } else { paraprint <) { s/\s+//g; $unseen++ if $_ ne '' and not exists $REP{$_}; } while ($unseen == 0) { paraprint <); if ($action =~ /^[re]/i) { # etry dit goto tryagain; } elsif ($action =~ /^[cq]/i) { # ancel, uit Cancel(); } } } # sub Edit sub Cancel { 1 while unlink($filename); # remove all versions under VMS print "\nCancelling.\n"; exit(0); } sub NowWhat { # Report is done, prompt for further action if( !$::opt_S ) { while(1) { paraprint <; chop $action; if ($action =~ /^(f|sa)/i) { # ile/ve print "\n\nName of file to save message in [perlbug.rep]: "; my $file = scalar <>; chop $file; $file = "perlbug.rep" if $file eq ""; unless (open(FILE, ">$file")) { print "\nError opening $file: $!\n\n"; goto retry; } open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n"; print FILE "To: $address\nSubject: $subject\n"; print FILE "Cc: $cc\n" if $cc; print FILE "Reply-To: $from\n" if $from; print FILE "\n"; while () { print FILE } close(REP) or die "Error closing report file `$filename': $!"; close(FILE) or die "Error closing $file: $!"; print "\nMessage saved in `$file'.\n"; exit; } elsif ($action =~ /^(d|l|sh)/i ) { # isplay, ist, ow # Display the message open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n"; while () { print $_ } close(REP) or die "Error closing report file `$filename': $!"; } elsif ($action =~ /^se/i) { # end # Send the message print "Are you certain you want to send this message?\n" . 'Please type "yes" if you are: '; my $reply = scalar ; chop $reply; if ($reply eq "yes") { last; } else { paraprint <dit, e-edit # edit the message Edit(); } elsif ($action =~ /^[qc]/i) { # ancel, uit Cancel(); } elsif ($action =~ /^s/) { paraprint <$outfile" or die "Couldn't open '$outfile': $!\n"; goto sendout; } if ($::HaveSend) { $msg = new Mail::Send Subject => $subject, To => $address; $msg->cc($cc) if $cc; $msg->add("Reply-To",$from) if $from; $fh = $msg->open; open(REP, "<$filename") or die "Couldn't open `$filename': $!\n"; while () { print $fh $_ } close(REP) or die "Error closing $filename: $!"; $fh->close; print "\nMessage sent.\n"; } elsif ($Is_VMS) { if ( ($address =~ /@/ and $address !~ /^\w+%"/) or ($cc =~ /@/ and $cc !~ /^\w+%"/) ) { my $prefix; foreach (qw[ IN MX SMTP UCX PONY WINS ], '') { $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"}; } $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/; $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/; } $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g; my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]); if ($sts) { die <) { print SENDMAIL $_ } close(REP) or die "Error closing $filename: $!"; if (close(SENDMAIL)) { printf "\nMessage %s.\n", $outfile ? "saved" : "sent"; } else { warn "\nSendmail returned status '", $? >> 8, "'\n"; } } 1 while unlink($filename); # remove all versions under VMS } # sub Send sub Help { print <catfile($dir, $filename); $filename = File::Spec->catfile($dir, $filename); } sub paraprint { my @paragraphs = split /\n{2,}/, "@_"; print "\n\n"; for (@paragraphs) { # implicit local $_ s/(\S)\s*\n/$1 /g; write; print "\n"; } } format STDOUT = ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~ $_ . __END__ =head1 NAME perlbug - how to submit bug reports on Perl =head1 SYNOPSIS B S<[ B<-v> ]> S<[ B<-a> I
]> S<[ B<-s> I ]> S<[ B<-b> I | B<-f> I ]> S<[ B<-F> I ]> S<[ B<-r> I ]> S<[ B<-e> I ]> S<[ B<-c> I | B<-C> ]> S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]> B S<[ B<-v> ]> S<[ B<-r> I ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]> =head1 DESCRIPTION A program to help generate bug reports about perl or the modules that come with it, and mail them. If you have found a bug with a non-standard port (one that was not part of the I), a binary distribution, or a non-standard module (such as Tk, CGI, etc), then please see the documentation that came with that distribution to determine the correct place to report bugs. C is designed to be used interactively. Normally no arguments will be needed. Simply run it, and follow the prompts. If you are unable to run B (most likely because you don't have a working setup to send mail that perlbug recognizes), you may have to compose your own report, and email it to B. You might find the B<-d> option useful to get summary information in that case. In any case, when reporting a bug, please make sure you have run through this checklist: =over 4 =item What version of Perl you are running? Type C at the command line to find out. =item Are you running the latest released version of perl? Look at http://www.perl.com/ to find out. If it is not the latest released version, get that one and see whether your bug has been fixed. Note that bug reports about old versions of Perl, especially those prior to the 5.0 release, are likely to fall upon deaf ears. You are on your own if you continue to use perl1 .. perl4. =item Are you sure what you have is a bug? A significant number of the bug reports we get turn out to be documented features in Perl. Make sure the behavior you are witnessing doesn't fall under that category, by glancing through the documentation that comes with Perl (we'll admit this is no mean task, given the sheer volume of it all, but at least have a look at the sections that I relevant). Be aware of the familiar traps that perl programmers of various hues fall into. See L. Check in L to see what any Perl error message(s) mean. If message isn't in perldiag, it probably isn't generated by Perl. Consult your operating system documentation instead. If you are on a non-UNIX platform check also L, as some features may be unimplemented or work differently. Try to study the problem under the Perl debugger, if necessary. See L. =item Do you have a proper test case? The easier it is to reproduce your bug, the more likely it will be fixed, because if no one can duplicate the problem, no one can fix it. A good test case has most of these attributes: fewest possible number of lines; few dependencies on external commands, modules, or libraries; runs on most platforms unimpeded; and is self-documenting. A good test case is almost always a good candidate to be on the perl test suite. If you have the time, consider making your test case so that it will readily fit into the standard test suite. Remember also to include the B error messages, if any. "Perl complained something" is not an exact error message. If you get a core dump (or equivalent), you may use a debugger (B, B, etc) to produce a stack trace to include in the bug report. NOTE: unless your Perl has been compiled with debug info (often B<-g>), the stack trace is likely to be somewhat hard to use because it will most probably contain only the function names and not their arguments. If possible, recompile your Perl with debug info and reproduce the dump and the stack trace. =item Can you describe the bug in plain English? The easier it is to understand a reproducible bug, the more likely it will be fixed. Anything you can provide by way of insight into the problem helps a great deal. In other words, try to analyze the problem (to the extent you can) and report your discoveries. =item Can you fix the bug yourself? A bug report which I will almost definitely be fixed. Use the C program to generate your patches (C is being maintained by the GNU folks as part of the B package, so you should be able to get it from any of the GNU software repositories). If you do submit a patch, the cool-dude counter at perlbug@perl.com will register you as a savior of the world. Your patch may be returned with requests for changes, or requests for more detailed explanations about your fix. Here are some clues for creating quality patches: Use the B<-c> or B<-u> switches to the diff program (to create a so-called context or unified diff). Make sure the patch is not reversed (the first argument to diff is typically the original file, the second argument your changed file). Make sure you test your patch by applying it with the C program before you send it on its way. Try to follow the same style as the code you are trying to patch. Make sure your patch really does work (C, if the thing you're patching supports it). =item Can you use C to submit the report? B will, amongst other things, ensure your report includes crucial information about your version of perl. If C is unable to mail your report after you have typed it in, you may have to compose the message yourself, add the output produced by C and email it to B. If, for some reason, you cannot run C at all on your system, be sure to include the entire output produced by running C (note the uppercase V). Whether you use C or send the email manually, please make your Subject line informative. "a bug" not informative. Neither is "perl crashes" nor "HELP!!!". These don't help. A compact description of what's wrong is fine. =back Having done your bit, please be prepared to wait, to be told the bug is in your code, or even to get no reply at all. The Perl maintainers are busy folks, so if your problem is a small one or if it is difficult to understand or already known, they may not respond with a personal reply. If it is important to you that your bug be fixed, do monitor the C file in any development releases since the time you submitted the bug, and encourage the maintainers with kind words (but never any flames!). Feel free to resend your bug report if the next released version of perl comes out and your bug is still present. =head1 OPTIONS =over 8 =item B<-a> Address to send the report to. Defaults to `perlbug@perl.com'. =item B<-b> Body of the report. If not included on the command line, or in a file with B<-f>, you will get a chance to edit the message. =item B<-C> Don't send copy to administrator. =item B<-c> Address to send copy of report to. Defaults to the address of the local perl administrator (recorded when perl was built). =item B<-d> Data mode (the default if you redirect or pipe output). This prints out your configuration data, without mailing anything. You can use this with B<-v> to get more complete data. =item B<-e> Editor to use. =item B<-f> File containing the body of the report. Use this to quickly send a prepared message. =item B<-F> File to output the results to instead of sending as an email. Useful particularly when running perlbug on a machine with no direct internet connection. =item B<-h> Prints a brief summary of the options. =item B<-ok> Report successful build on this system to perl porters. Forces B<-S> and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only prompts for a return address if it cannot guess it (for use with B). Honors return address specified with B<-r>. You can use this with B<-v> to get more complete data. Only makes a report if this system is less than 60 days old. =item B<-okay> As B<-ok> except it will report on older systems. =item B<-nok> Report unsuccessful build on this system. Forces B<-C>. Forces and supplies a value for B<-s>, then requires you to edit the report and say what went wrong. Alternatively, a prepared report may be supplied using B<-f>. Only prompts for a return address if it cannot guess it (for use with B). Honors return address specified with B<-r>. You can use this with B<-v> to get more complete data. Only makes a report if this system is less than 60 days old. =item B<-nokay> As B<-nok> except it will report on older systems. =item B<-r> Your return address. The program will ask you to confirm its default if you don't use this option. =item B<-S> Send without asking for confirmation. =item B<-s> Subject to include with the message. You will be prompted if you don't supply one on the command line. =item B<-t> Test mode. The target address defaults to `perlbug-test@perl.com'. =item B<-v> Include verbose configuration data in the report. =back =head1 AUTHORS Kenneth Albanowski (Ekjahds@kjahds.comE), subsequently Itored by Gurusamy Sarathy (Egsar@activestate.comE), Tom Christiansen (Etchrist@perl.comE), Nathan Torkington (Egnat@frii.comE), Charles F. Randall (Ecfr@pobox.comE), Mike Guy (Emjtg@cam.a.ukE), Dominic Dunlop (Edomo@computer.orgE), Hugo van der Sanden (Ehv@crypt0.demon.co.ukE), Jarkko Hietaniemi (Ejhi@iki.fiE), Chris Nandor (Epudge@pobox.comE), Jon Orwant (Eorwant@media.mit.eduE, and Richard Foley (Erichard@rfi.netE). =head1 SEE ALSO perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1), diff(1), patch(1), dbx(1), gdb(1) =head1 BUGS None known (guess what must have been used to report them?) =cut !NO!SUBS! close OUT or die "Can't close $file: $!"; chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; chdir $origdir;