4 use File::Basename qw(&basename &dirname);
6 # List explicitly here the variables you want Configure to
7 # generate. Metaconfig only looks for shell variables, so you
8 # have to mention them as if they were shell variables, not
9 # %Config entries. Thus you write
11 # to ensure Configure will look for $Config{startperl}.
13 # This forces PL files to create target in same directory as PL file.
14 # This is so that make depend always knows where to find PL derivatives.
16 $file = basename($0, '.PL');
17 $file .= '.com' if $^O eq 'VMS';
19 open OUT,">$file" or die "Can't create $file: $!";
21 print "Extracting $file (with variable substitutions)\n";
23 # In this section, perl variables will be expanded during extraction.
24 # You can use $Config{...} to use Configure variables.
26 print OUT <<"!GROK!THIS!";
28 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
29 if \$running_under_some_shell;
32 # In the following, perl variables are not expanded during extraction.
34 print OUT <<'!NO!SUBS!';
40 eval "use Mail::Send;";
41 $::HaveSend = ($@ eq "");
42 eval "use Mail::Util;";
43 $::HaveUtil = ($@ eq "");
52 my($Version) = "1.18";
54 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
55 # Changed in 1.07 to see more sendmail execs, and added pipe output.
56 # Changed in 1.08 to use correct address for sendmail.
57 # Changed in 1.09 to close the REP file before calling it up in the editor.
58 # Also removed some old comments duplicated elsewhere.
59 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
60 # temp filename generation.
61 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
62 # Changed in 1.12 to check for editor errors, make save/send distinction
63 # clearer and add $ENV{REPLYTO}.
64 # Changed in 1.13 to hopefully make it more difficult to accidentally
66 # Changed in 1.14 to make the prompts a little more clear on providing
67 # helpful information. Also let file read fail gracefully.
68 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
69 # Also report selected environment variables.
70 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
71 # Changed in 1.17 Win32 support added. GSAR 97-04-12
72 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
74 # TODO: - Allow the user to re-name the file on mail failure, and
75 # make sure failure (transmission-wise) of Mail::Send is
79 my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename,
80 $subject, $from, $verbose, $ed,
81 $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok);
85 if($::opt_h) { Help(); exit; }
89 Please use perlbug interactively. If you want to
90 include a file, you can use the -f switch.
95 if($::opt_d or !-t STDOUT) { Dump(*STDOUT); exit; }
98 Edit() unless $usefile;
106 # -------- Setup --------
108 $Is_MSWin32 = $^O eq 'MSWin32';
109 $Is_VMS = $^O eq 'VMS';
111 getopts("dhva:s:b:f:r:e:SCc:to:");
114 # This comment is needed to notify metaconfig that we are
115 # using the $perladmin, $cf_by, and $cf_time definitions.
118 # -------- Configuration ---------
121 $perlbug = 'perlbug@perl.com';
125 $testaddress = 'perlbug-test@perl.com';
128 $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug);
130 # Users address, used in message and in Reply-To header
131 $from = $::opt_r || "";
133 # Include verbose configuration information
134 $verbose = $::opt_v || 0;
136 # Subject of bug-report message
137 $subject = $::opt_s || "";
140 $usefile = ($::opt_f || 0);
142 # File to send as report
143 $file = $::opt_f || "";
146 $body = $::opt_b || "";
149 $ed = ( $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT} ||
150 ($Is_VMS ? "edit/tpu" : $Is_MSWin32 ? "notepad" : "vi")
153 # OK - send "OK" report for build on this system
156 if ( $::opt_o eq 'k' ) {
157 # force these options
158 $::opt_S = 1; # don't prompt for send
159 $::opt_C = 1; # don't send a copy to the local admin
160 $::opt_v = 1; $verbose = 1;
161 $::opt_s = 1; $subject = "OK: perl $] on "
162 . $::Config{'osname'} . ' '
163 . $::Config{'osvers'};
164 $::opt_b = 1; $body = "Perl reported to build OK on this system\n";
173 # Possible administrator addresses, in order of confidence
174 # (Note that cf_email is not mentioned to metaconfig, since
175 # we don't really want it. We'll just take it if we have to.)
177 # This has to be after the $ok stuff above because of the way
178 # that $::opt_C is forced.
179 $cc = ($::opt_C ? "" : (
180 $::opt_c || $::Config{perladmin} || $::Config{cf_email} || $::Config{cf_by}
184 $me = ($Is_MSWin32 ? $ENV{'USERNAME'} : getpwuid($<));
191 # Explain what perlbug is
194 This program provides an easy way to create a message reporting a bug
195 in perl, and e-mail it to $address. It is *NOT* intended for
196 sending test messages or simply verifying that perl works, *NOR* is it
197 intended for reporting bugs in third-party perl modules. It is *ONLY*
198 a means of reporting verifiable problems with the core perl distribution,
199 and any solutions to such problems, to the people who maintain perl.
201 If you're just looking for help with perl, try posting to the Usenet
202 newsgroup comp.lang.perl.misc. If you're looking for help with using
203 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
209 # Prompt for subject of message, if needed
212 First of all, please provide a subject for the
213 message. It should be a concise description of
214 the bug or problem. "perl bug" or "perl problem"
215 is not a concise description.
224 while( $subject =~ /^\s*$/ ) {
225 print "\nPlease enter a subject: ";
235 # Prompt for return address, if needed
238 # Try and guess return address
242 $domain = Mail::Util::maildomain();
243 } elsif ($Is_MSWin32) {
244 $domain = $ENV{'USERDOMAIN'};
246 require Sys::Hostname;
247 $domain = Sys::Hostname::hostname();
249 $domain = `hostname`.".".`domainname`;
250 $domain =~ s/[\r\n]+//g;
257 } elsif ($Is_VMS && !$::Config{'d_socket'}) {
258 $guess = "$domain\:\:$me";
260 $guess = "$me\@$domain" if $domain;
261 $guess = "$me\@unknown.addresss" unless $domain;
264 $guess = $ENV{'REPLYTO'} if defined($ENV{'REPLYTO'});
265 $guess = $ENV{"REPLY-TO"} if defined($ENV{'REPLY-TO'});
272 Your e-mail address will be useful if you need to be contacted. If the
273 default shown is not your full internet e-mail address, please correct it.
280 So that you may be contacted if necessary, please enter
281 your full internet e-mail address here.
286 if ( $ok && $guess ne '' ) {
292 print "Your address [$guess]: ";
297 if($from eq "") { $from = $guess }
302 #if( $from =~ /^(.*)\@(.*)$/ ) {
307 if( $from eq $cc or $me eq $cc ) {
308 # Try not to copy ourselves
313 # Prompt for administrator address, unless an override was given
314 if( !$::opt_C and !$::opt_c ) {
318 A copy of this report can be sent to your local
319 perl administrator. If the address is wrong, please
320 correct it, or enter 'none' or 'yourself' to not send
325 print "Local perl administrator [$cc]: ";
327 my($entry) = scalar(<>);
332 if($me eq $cc) { $cc = "" }
337 if($cc =~ /^(none|yourself|me|myself|ourselves)$/i) { $cc = "" }
339 $andcc = " and $cc" if $cc;
343 # Prompt for editor, if no override is given
344 if(! $::opt_e and ! $::opt_f and ! $::opt_b) {
348 Now you need to supply the bug report. Try to make
349 the report concise but descriptive. Include any
350 relevant detail. If you are reporting something
351 that does not work as you think it should, please
352 try to include example of both the actual
353 result, and what you expected.
355 Some information about your local
356 perl configuration will automatically be included
357 at the end of the report. If you are using any
358 unusual version of perl, please try and confirm
359 exactly which versions are relevant.
361 You will probably want to use an editor to enter
362 the report. If "$ed" is the editor you want
363 to use, then just press Enter, otherwise type in
364 the name of the editor you would like to use.
366 If you would like to use a prepared file, type
367 "file", and you will be asked for the filename.
371 print "Editor [$ed]: ";
373 my($entry) =scalar(<>);
377 if($entry eq "file") {
379 } elsif($entry ne "") {
385 # Generate scratch file to edit report in
388 my($dir) = ($Is_VMS ? 'sys$scratch:' :
389 ($Is_MSWin32 && $ENV{'TEMP'} ? $ENV{'TEMP'} : '/tmp/'));
390 $filename = "bugrep0$$";
391 $dir .= "\\" if $Is_MSWin32 and $dir !~ m|[\\/]$|;
392 $filename++ while -e "$dir$filename";
393 $filename = "$dir$filename";
397 # Prompt for file to read report from, if needed
399 if( $usefile and ! $file) {
403 What is the name of the file that contains your report?
409 my($entry) = scalar(<>);
415 No filename? I'll let you go back and choose an editor again.
421 if(!-f $entry or !-r $entry) {
424 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
425 the file? If you don't want to send a file, just enter a blank line and you
426 can get back to the editor selection.
438 open(REP,">$filename");
441 This is a bug report for perl from $from,
442 generated with the help of perlbug $Version running under perl $].
449 open(F,"<$file") or die "Unable to read report file from `$file': $!\n";
457 -----------------------------------------------------------------
458 [Please enter your report here]
462 [Please do not change anything below this line]
463 -----------------------------------------------------------------
470 # read in the report template once so that
471 # we can track whether the user does any editing.
472 # yes, *all* whitespace is ignored.
473 open(REP, "<$filename");
488 Site configuration information for perl $]:
492 if( $::Config{cf_by} and $::Config{cf_time}) {
493 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
496 print OUT Config::myconfig;
499 print OUT "\nComplete configuration data for perl $]:\n\n";
501 foreach (sort keys %::Config) {
502 $value = $::Config{$_};
504 print OUT "$_='$value'\n";
519 Environment for perl $]:
522 (qw(PATH LD_LIBRARY_PATH
525 grep { /^(?:PERL|LC_)/ } keys %ENV)) {
527 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
539 Please make sure that the name of the editor you want to use is correct.
542 print "Editor [$ed]: ";
544 my($entry) =scalar(<>);
553 if(!$usefile and !$body) {
554 my $sts = system("$ed $filename");
556 #print "\nUnable to run editor!\n";
559 The editor you chose (`$ed') could apparently not be run!
560 Did you mistype the name of your editor? If so, please
561 correct it here, otherwise just press Enter.
564 print "Editor [$ed]: ";
566 my($entry) =scalar(<>);
576 You may want to save your report to a file, so you can edit and mail it
584 # Check that we have a report that has some, eh, report in it.
588 open(REP, "<$filename");
589 # a strange way to check whether any significant editing
590 # have been done: check whether any new non-empty lines
591 # have been added. Yes, the below code ignores *any* space
595 $unseen++ if ($_ ne '' and not exists $REP{$_});
598 while ($unseen == 0) {
601 I am sorry but it looks like you did not report anything.
604 print "Action (Retry Edit/Cancel) ";
605 my ($action) = scalar(<>);
606 if ($action =~ /^[re]/i) { # <R>etry <E>dit
608 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
616 1 while unlink($filename); # remove all versions under VMS
617 print "\nCancelling.\n";
623 # Report is done, prompt for further action
630 Now that you have completed your report, would you like to send
631 the message to $address$andcc, display the message on
632 the screen, re-edit it, or cancel without sending anything?
633 You may also save the message as a file to mail at another time.
637 print "Action (Send/Display/Edit/Cancel/Save to File): ";
638 my($action) = scalar(<>);
641 if( $action =~ /^(f|sa)/i ) { # <F>ile/<Sa>ve
642 print "\n\nName of file to save message in [perlbug.rep]: ";
643 my($file) = scalar(<>);
645 if($file eq "") { $file = "perlbug.rep" }
648 open(REP,"<$filename");
649 print FILE "To: $address\nSubject: $subject\n";
650 print FILE "Cc: $cc\n" if $cc;
651 print FILE "Reply-To: $from\n" if $from;
653 while(<REP>) { print FILE }
657 print "\nMessage saved in `$file'.\n";
660 } elsif( $action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
661 # Display the message
662 open(REP,"<$filename");
663 while(<REP>) { print $_ }
665 } elsif( $action =~ /^se/i ) { # <S>end
668 Are you certain you want to send this message?
669 Please type \"yes\" if you are: ";
670 my($reply) = scalar(<STDIN>);
672 if( $reply eq "yes" ) {
677 That wasn't a clear "yes", so I won't send your message. If you are sure
678 your message should be sent, type in "yes" (without the quotes) at the
684 } elsif( $action =~ /^[er]/i ) { # <E>dit, <R>e-edit
687 #system("$ed $filename");
688 } elsif( $action =~ /^[qc]/i ) { # <C>ancel, <Q>uit
690 } elsif( $action =~ /^s/ ) {
693 I'm sorry, but I didn't understand that. Please type "send" or "save".
704 # Message has been accepted for transmission -- Send the message
708 $msg = new Mail::Send Subject => $subject, To => $address;
710 $msg->cc($cc) if $cc;
711 $msg->add("Reply-To",$from) if $from;
715 open(REP,"<$filename");
716 while(<REP>) { print $fh $_ }
723 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
724 ($cc =~ /@/ and $cc !~ /^\w+%"/) ){
726 foreach (qw[ IN MX SMTP UCX PONY WINS ],'') {
727 $prefix = "$_%",last if $ENV{"MAIL\$PROTOCOL_$_"};
729 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
730 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
732 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
733 my($sts) = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
734 if ($sts) { die "Can't spawn off mail\n\t(leaving bug report in $filename): $sts\n;" }
738 foreach (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail))
740 $sendmail = $_, last if -e $_;
743 paraprint <<"EOF", die "\n" if $sendmail eq "";
745 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
746 the perl package Mail::Send has not been installed, so I can't send your bug
747 report. We apologize for the inconvenience.
749 So you may attempt to find some way of sending your message, it has
750 been left in the file `$filename'.
754 open(SENDMAIL,"|$sendmail -t");
755 print SENDMAIL "To: $address\n";
756 print SENDMAIL "Subject: $subject\n";
757 print SENDMAIL "Cc: $cc\n" if $cc;
758 print SENDMAIL "Reply-To: $from\n" if $from;
759 print SENDMAIL "\n\n";
760 open(REP,"<$filename");
761 while(<REP>) { print SENDMAIL $_ }
769 print "\nMessage sent.\n";
771 1 while unlink($filename); # remove all versions under VMS
778 A program to help generate bug reports about perl5, and mail them.
779 It is designed to be used interactively. Normally no arguments will
783 $0 [-v] [-a address] [-s subject] [-b body | -f file ]
784 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
786 Simplest usage: run "$0", and follow the prompts.
790 -v Include Verbose configuration data in the report
791 -f File containing the body of the report. Use this to
792 quickly send a prepared message.
793 -S Send without asking for confirmation.
794 -a Address to send the report to. Defaults to `$address'.
795 -c Address to send copy of report to. Defaults to `$cc'.
796 -C Don't send copy to administrator.
797 -s Subject to include with the message. You will be prompted
798 if you don't supply one on the command line.
799 -b Body of the report. If not included on the command line, or
800 in a file with -f, you will get a chance to edit the message.
801 -r Your return address. The program will ask you to confirm
802 this if you don't give it here.
804 -t Test mode. The target address defaults to `$testaddress'.
805 -d Data mode (the default if you redirect or pipe output.)
806 This prints out your configuration data, without mailing
807 anything. You can use this with -v to get more complete data.
808 -ok Report successful build on this sytem to perl porters (use alone).
809 -h Print this help message.
815 my @paragraphs = split /\n{2,}/, "@_";
817 for (@paragraphs) { # implicit local $_
827 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
835 perlbug - how to submit bug reports on Perl
839 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
840 S<[ B<-b> I<body> | B<-f> I<file> ]> S<[ B<-r> I<returnaddress> ]>
841 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
842 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-h> ]>
844 B<perlbug> S<[ B<-r> I<returnaddress> ]> B<-ok>
848 A program to help generate bug reports about perl or the modules that
849 come with it, and mail them.
851 If you have found a bug with a non-standard port (one that was not part
852 of the I<standard distribution>), a binary distribution, or a
853 non-standard module (such as Tk, CGI, etc), then please see the
854 documentation that came with that distribution to determine the correct
855 place to report bugs.
857 C<perlbug> is designed to be used interactively. Normally no arguments
858 will be needed. Simply run it, and follow the prompts.
860 If you are unable to run B<perlbug> (most likely because you don't have
861 a working setup to send mail that perlbug recognizes), you may have to
862 compose your own report, and email it to B<perlbug@perl.com>. You might
863 find the B<-d> option useful to get summary information in that case.
865 In any case, when reporting a bug, please make sure you have run through
870 =item What version of perl you are running?
872 Type C<perl -v> at the command line to find out.
874 =item Are you running the latest released version of perl?
876 Look at http://www.perl.com/ to find out. If it is not the latest
877 released version, get that one and see whether your bug has been
878 fixed. Note that bug reports about old versions of perl, especially
879 those prior to the 5.0 release, are likely to fall upon deaf ears.
880 You are on your own if you continue to use perl1 .. perl4.
882 =item Are you sure what you have is a bug?
884 A significant number of the bug reports we get turn out to be documented
885 features in perl. Make sure the behavior you are witnessing doesn't fall
886 under that category, by glancing through the documentation that comes
887 with perl (we'll admit this is no mean task, given the sheer volume of
888 it all, but at least have a look at the sections that I<seem> relevant).
890 Be aware of the familiar traps that perl programmers of various hues
891 fall into. See L<perltrap>.
893 Try to study the problem under the perl debugger, if necessary.
896 =item Do you have a proper test case?
898 The easier it is to reproduce your bug, the more likely it will be
899 fixed, because if no one can duplicate the problem, no one can fix it.
900 A good test case has most of these attributes: fewest possible number
901 of lines; few dependencies on external commands, modules, or
902 libraries; runs on most platforms unimpeded; and is self-documenting.
904 A good test case is almost always a good candidate to be on the perl
905 test suite. If you have the time, consider making your test case so
906 that it will readily fit into the standard test suite.
908 =item Can you describe the bug in plain English?
910 The easier it is to understand a reproducible bug, the more likely it
911 will be fixed. Anything you can provide by way of insight into the
912 problem helps a great deal. In other words, try to analyse the
913 problem to the extent you feel qualified and report your discoveries.
915 =item Can you fix the bug yourself?
917 A bug report which I<includes a patch to fix it> will almost
918 definitely be fixed. Use the C<diff> program to generate your patches
919 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
920 package, so you should be able to get it from any of the GNU software
921 repositories). If you do submit a patch, the cool-dude counter at
922 perlbug@perl.com will register you as a savior of the world. Your
923 patch may be returned with requests for changes, or requests for more
924 detailed explanations about your fix.
926 Here are some clues for creating quality patches: Use the B<-c> or
927 B<-u> switches to the diff program (to create a so-called context or
928 unified diff). Make sure the patch is not reversed (the first
929 argument to diff is typically the original file, the second argument
930 your changed file). Make sure you test your patch by applying it with
931 the C<patch> program before you send it on its way. Try to follow the
932 same style as the code you are trying to patch. Make sure your patch
933 really does work (C<make test>, if the thing you're patching supports
936 =item Can you use C<perlbug> to submit the report?
938 B<perlbug> will, amongst other things, ensure your report includes
939 crucial information about your version of perl. If C<perlbug> is unable
940 to mail your report after you have typed it in, you may have to compose
941 the message yourself, add the output produced by C<perlbug -d> and email
942 it to B<perlbug@perl.com>. If, for some reason, you cannot run
943 C<perlbug> at all on your system, be sure to include the entire output
944 produced by running C<perl -V> (note the uppercase V).
948 Having done your bit, please be prepared to wait, to be told the bug
949 is in your code, or even to get no reply at all. The perl maintainers
950 are busy folks, so if your problem is a small one or if it is
951 difficult to understand, they may not respond with a personal reply.
952 If it is important to you that your bug be fixed, do monitor the
953 C<Changes> file in any development releases since the time you submitted
954 the bug, and encourage the maintainers with kind words (but never any
955 flames!). Feel free to resend your bug report if the next released
956 version of perl comes out and your bug is still present.
964 Address to send the report to. Defaults to `perlbug@perl.com'.
968 Body of the report. If not included on the command line, or
969 in a file with B<-f>, you will get a chance to edit the message.
973 Don't send copy to administrator.
977 Address to send copy of report to. Defaults to the address of the
978 local perl administrator (recorded when perl was built).
982 Data mode (the default if you redirect or pipe output). This prints out
983 your configuration data, without mailing anything. You can use this
984 with B<-v> to get more complete data.
992 File containing the body of the report. Use this to quickly send a
997 Prints a brief summary of the options.
1001 Report successful build on this system to perl porters. Forces B<-S>,
1002 B<-C>, and B<-v>. Forces and supplies values for B<-s> and B<-b>. Only
1003 prompts for a return address if it cannot guess it (for use with
1004 B<make>). Honors return address specified with B<-r>.
1008 Your return address. The program will ask you to confirm its default
1009 if you don't use this option.
1013 Send without asking for confirmation.
1017 Subject to include with the message. You will be prompted if you don't
1018 supply one on the command line.
1022 Test mode. The target address defaults to `perlbug-test@perl.com'.
1026 Include verbose configuration data in the report.
1032 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1033 by Gurusamy Sarathy (E<lt>gsar@umich.eduE<gt>), Tom Christiansen
1034 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1035 and Charles F. Randall (E<lt>cfr@pobox.comE<gt>).
1039 perl(1), perldebug(1), perltrap(1), diff(1), patch(1)
1043 None known (guess what must have been used to report them?)
1049 close OUT or die "Can't close $file: $!";
1050 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1051 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';