4 use File::Basename qw(&basename &dirname);
6 use File::Spec::Functions;
8 # List explicitly here the variables you want Configure to
9 # generate. Metaconfig only looks for shell variables, so you
10 # have to mention them as if they were shell variables, not
11 # %Config entries. Thus you write
13 # to ensure Configure will look for $Config{startperl}.
16 # This forces PL files to create target in same directory as PL file.
17 # This is so that make depend always knows where to find PL derivatives.
20 $file = basename($0, '.PL');
21 $file .= '.com' if $^O eq 'VMS';
23 open OUT, ">$file" or die "Can't create $file: $!";
25 # extract patchlevel.h information
27 open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h")
28 or die "Can't open patchlevel.h: $!";
30 my $patchlevel_date = (stat PATCH_LEVEL)[9];
32 while (<PATCH_LEVEL>) {
33 last if $_ =~ /^\s*static\s+(?:const\s+)?char.*?local_patches\[\]\s*=\s*{\s*$/;
37 warn "Warning: local_patches section not found in patchlevel.h\n";
41 while (<PATCH_LEVEL>) {
47 push @patches, $_ unless $_ eq 'NULL';
49 my $patch_desc = "'" . join("',\n '", @patches) . "'";
50 my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches;
52 close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!";
54 # TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is
55 # used, compare $Config::config_sh with the stored version. If they differ then
56 # append a list of individual differences to the bug report.
59 print "Extracting $file (with variable substitutions)\n";
61 # In this section, perl variables will be expanded during extraction.
62 # You can use $Config{...} to use Configure variables.
64 my $extract_version = sprintf("%vd", $^V);
66 print OUT <<"!GROK!THIS!";
68 eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}'
69 if \$running_under_some_shell;
71 my \$config_tag1 = '$extract_version - $Config{cf_time}';
73 my \$patchlevel_date = $patchlevel_date;
74 my \$patch_tags = '$patch_tags';
80 # In the following, perl variables are not expanded during extraction.
82 print OUT <<'!NO!SUBS!';
86 use File::Spec; # keep perlbug Perl 5.005 compatible
88 use File::Basename 'basename';
93 eval "use Mail::Send;";
94 $::HaveSend = ($@ eq "");
95 eval "use Mail::Util;";
96 $::HaveUtil = ($@ eq "");
97 # use secure tempfiles wherever possible
98 eval "require File::Temp;";
99 $::HaveTemp = ($@ eq "");
100 eval { require Module::CoreList; };
101 $::HaveCoreList = ($@ eq "");
104 my $Version = "1.36";
106 # Changed in 1.06 to skip Mail::Send and Mail::Util if not available.
107 # Changed in 1.07 to see more sendmail execs, and added pipe output.
108 # Changed in 1.08 to use correct address for sendmail.
109 # Changed in 1.09 to close the REP file before calling it up in the editor.
110 # Also removed some old comments duplicated elsewhere.
111 # Changed in 1.10 to run under VMS without Mail::Send; also fixed
112 # temp filename generation.
113 # Changed in 1.11 to clean up some text and removed Mail::Send deactivator.
114 # Changed in 1.12 to check for editor errors, make save/send distinction
115 # clearer and add $ENV{REPLYTO}.
116 # Changed in 1.13 to hopefully make it more difficult to accidentally
118 # Changed in 1.14 to make the prompts a little more clear on providing
119 # helpful information. Also let file read fail gracefully.
120 # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs.
121 # Also report selected environment variables.
122 # Changed in 1.16 to include @INC, and allow user to re-edit if no changes.
123 # Changed in 1.17 Win32 support added. GSAR 97-04-12
124 # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18
125 # Changed in 1.19 '-ok' default not '-v'
126 # add local patch information
127 # warn on '-ok' if this is an old system; add '-okay'
128 # Changed in 1.20 Added patchlevel.h reading and version/config checks
129 # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05
130 # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10
131 # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt
132 # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01
133 # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12
134 # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15
135 # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27
136 # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000
137 # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000
138 # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000
139 # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000
140 # Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000
141 # Changed in 1.33 Don't require -t STDOUT for -ok.
142 # Changed in 1.34 Added Message-Id RFOLEY 18-06-2002
143 # Changed in 1.35 Use File::Temp (patch from Solar Designer) NWCLARK 28-02-2004
144 # Changed in 1.36 Initial Module::CoreList support Alexandr Ciornii 11-07-2007
146 # TODO: - Allow the user to re-name the file on mail failure, and
147 # make sure failure (transmission-wise) of Mail::Send is
151 my( $file, $usefile, $cc, $address, $bugaddress, $testaddress, $thanksaddress,
152 $filename, $messageid, $domain, $subject, $from, $verbose, $ed, $outfile,
153 $Is_MacOS, $category, $severity, $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS,
154 $msg, $body, $andcc, %REP, $ok, $thanks, $Is_OpenBSD, $progname);
156 my $perl_version = $^V ? sprintf("%vd", $^V) : $];
158 my $config_tag2 = "$perl_version - $Config{cf_time}";
162 if ($::opt_h) { Help(); exit; }
163 if ($::opt_d) { Dump(*STDOUT); exit; }
164 if (!-t STDIN && !($ok and not $::opt_n)) {
166 Please use $progname interactively. If you want to
167 include a file, you can use the -f switch.
173 Edit() unless $usefile || ($ok and not $::opt_n);
179 sub ask_for_alternatives { # (category|severity)
185 # Inevitably some of these will end up in RT whatever we do:
186 'thanks' => 'thanks',
187 'opts' => [qw(core docs install library utilities)], # patch, notabug
193 'opts' => [qw(critical high medium low wishlist none)], # zero
196 die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts);
198 my $what = $ok || $thanks;
200 $alt = $alts{$name}{$what};
202 my @alts = @{$alts{$name}{'opts'}};
204 Please pick a \u$name from the following:
212 die "Invalid $name: aborting.\n";
214 print "Please enter a \u$name [$alts{$name}{'default'}]: ";
217 if ($alt =~ /^\s*$/) {
218 $alt = $alts{$name}{'default'};
220 } while !((($alt) = grep(/^$alt/i, @alts)));
226 # -------- Setup --------
228 $Is_MSWin32 = $^O eq 'MSWin32';
229 $Is_VMS = $^O eq 'VMS';
230 $Is_Linux = lc($^O) eq 'linux';
231 $Is_OpenBSD = lc($^O) eq 'openbsd';
232 $Is_MacOS = $^O eq 'MacOS';
234 @ARGV = split m/\s+/,
235 MacPerl::Ask('Provide command-line args here (-h for help):')
236 if $Is_MacOS && $MacPerl::Version =~ /App/;
238 if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:T")) { Help(); exit; };
240 # This comment is needed to notify metaconfig that we are
241 # using the $perladmin, $cf_by, and $cf_time definitions.
243 # -------- Configuration ---------
246 $bugaddress = 'perlbug@perl.org';
249 $testaddress = 'perlbug-test@perl.org';
252 $thanksaddress = 'perl-thanks@perl.org';
254 if (basename ($0) =~ /^perlthanks/i) {
255 # invoked as perlthanks
257 $::opt_C = 1; # don't send a copy to the local admin
264 $progname = $thanks ? 'perlthanks' : 'perlbug';
266 $address = $::opt_a || ($::opt_t ? $testaddress
267 : $thanks ? $thanksaddress : $bugaddress);
269 # Users address, used in message and in Reply-To header
270 $from = $::opt_r || "";
272 # Include verbose configuration information
273 $verbose = $::opt_v || 0;
275 # Subject of bug-report message
276 $subject = $::opt_s || "";
279 $usefile = ($::opt_f || 0);
281 # File to send as report
282 $file = $::opt_f || "";
285 $outfile = $::opt_F || "";
288 $body = $::opt_b || "";
291 $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT}
292 || ($Is_VMS && "edit/tpu")
293 || ($Is_MSWin32 && "notepad")
297 # Not OK - provide build failure template by finessing OK report
299 if (substr($::opt_n, 0, 2) eq 'ok' ) {
300 $::opt_o = substr($::opt_n, 1);
307 # OK - send "OK" report for build on this system
310 if ($::opt_o eq 'k' or $::opt_o eq 'kay') {
311 my $age = time - $patchlevel_date;
312 if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) {
313 my $date = localtime $patchlevel_date;
315 "perlbug -ok" and "perlbug -nok" do not report on Perl versions which
316 are more than 60 days old. This Perl version was constructed on
317 $date. If you really want to report this, use
318 "perlbug -okay" or "perlbug -nokay".
322 # force these options
324 $::opt_S = 1; # don't prompt for send
325 $::opt_b = 1; # we have a body
326 $body = "Perl reported to build OK on this system.\n";
328 $::opt_C = 1; # don't send a copy to the local admin
329 $::opt_s = 1; # we have a subject line
330 $subject = ($::opt_n ? 'Not ' : '')
331 . "OK: perl $perl_version ${patch_tags}on"
332 ." $::Config{'archname'} $::Config{'osvers'} $subject";
340 # Possible administrator addresses, in order of confidence
341 # (Note that cf_email is not mentioned to metaconfig, since
342 # we don't really want it. We'll just take it if we have to.)
344 # This has to be after the $ok stuff above because of the way
345 # that $::opt_C is forced.
346 $cc = $::opt_C ? "" : (
347 $::opt_c || $::Config{'perladmin'}
348 || $::Config{'cf_email'} || $::Config{'cf_by'}
352 $domain = Mail::Util::maildomain();
353 } elsif ($Is_MSWin32) {
354 $domain = $ENV{'USERDOMAIN'};
356 require Sys::Hostname;
357 $domain = Sys::Hostname::hostname();
361 $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>";
364 $me = $Is_MSWin32 ? $ENV{'USERNAME'}
365 : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'}
366 : $Is_MacOS ? $ENV{'USER'}
367 : eval { getpwuid($<) }; # May be missing
369 $from = $::Config{'cf_email'}
370 if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me &&
371 ($me eq $::Config{'cf_by'});
375 # Explain what perlbug is
379 This program provides an easy way to send a thank-you message back to the
380 authors and maintainers of perl.
382 If you wish to submit a bug report, please run it without the -T flag
383 (or run the program perlbug rather than perlthanks)
387 This program provides an easy way to create a message reporting a bug
388 in perl, and e-mail it to $address. It is *NOT* intended for
389 sending test messages or simply verifying that perl works, *NOR* is it
390 intended for reporting bugs in third-party perl modules. It is *ONLY*
391 a means of reporting verifiable problems with the core perl distribution,
392 and any solutions to such problems, to the people who maintain perl.
394 If you're just looking for help with perl, try posting to the Usenet
395 newsgroup comp.lang.perl.misc. If you're looking for help with using
396 perl with CGI, try posting to comp.infosystems.www.programming.cgi.
398 When invoked as perlthanks (or with the -T option) it can be used to
399 send a thank-you message to $thanksaddress.
404 # Prompt for subject of message, if needed
406 if (TrivialSubject($subject)) {
412 paraprint "First of all, please provide a subject for the message.\n";
415 First of all, please provide a subject for the
416 message. It should be a concise description of
417 the bug or problem. "perl bug" or "perl problem"
418 is not a concise description.
429 $subject = 'Thanks for Perl';
434 } while (TrivialSubject($subject));
437 # Prompt for return address, if needed
439 # Try and guess return address
442 $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || '';
444 require Mac::InternetConfig;
445 $guess = $Mac::InternetConfig::InternetConfig{
446 Mac::InternetConfig::kICEmail()
451 # move $domain to where we can use it elsewhere
453 if ($Is_VMS && !$::Config{'d_socket'}) {
454 $guess = "$domain\:\:$me";
456 $guess = "$me\@$domain" if $domain;
464 Your e-mail address will be useful if you need to be contacted. If the
465 default shown is not your full internet e-mail address, please correct it.
470 So that you may be contacted if necessary, please enter
471 your full internet e-mail address here.
480 print "Your address [$guess]: ";
483 $from = $guess if $from eq '';
487 if ($from eq $cc or $me eq $cc) {
488 # Try not to copy ourselves
492 # Prompt for administrator address, unless an override was given
493 if( !$::opt_C and !$::opt_c ) {
495 A copy of this report can be sent to your local
496 perl administrator. If the address is wrong, please
497 correct it, or enter 'none' or 'yourself' to not send
500 print "Local perl administrator [$cc]: ";
501 my $entry = scalar <>;
506 $cc = '' if $me eq $cc;
510 $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i;
511 $andcc = " and $cc" if $cc;
513 # Prompt for editor, if no override is given
515 unless ($::opt_e || $::opt_f || $::opt_b) {
516 chomp (my $common_end = <<"EOF");
518 You will probably want to use an editor to enter
519 the report. If "$ed" is the editor you want
520 to use, then just press Enter, otherwise type in
521 the name of the editor you would like to use.
523 If you would like to use a prepared file, type
524 "file", and you will be asked for the filename.
529 Now you need to supply your thank-you message.
531 Some information about your local perl configuration
532 will automatically be included at the end of the message,
533 because we're curious about the different ways that people
534 build perl, but you're welcome to delete it if you wish.
540 Now you need to supply the bug report. Try to make
541 the report concise but descriptive. Include any
542 relevant detail. If you are reporting something
543 that does not work as you think it should, please
544 try to include example of both the actual
545 result, and what you expected.
547 Some information about your local
548 perl configuration will automatically be included
549 at the end of the report. If you are using any
550 unusual version of perl, please try and confirm
551 exactly which versions are relevant.
557 print "Editor [$ed]: ";
558 my $entry =scalar <>;
562 if ($entry eq "file") {
564 } elsif ($entry ne "") {
568 my $report_about_module = '';
569 if ($::HaveCoreList && !$ok && !$thanks) {
571 Is your report about a Perl module? If yes, enter its name. If not, skip.
574 my $entry = scalar <>;
578 $category ||= 'library';
579 $report_about_module = $entry;
580 my $first_release = Module::CoreList->first_release($entry);
581 unless ($first_release) {
583 Module $entry is not a core module. Please check that
584 you entered its name correctly. If it is correct,
585 abort this program, try searching for $entry on
586 search.cpan.org, and report it there.
592 # Prompt for category of bug
593 $category ||= ask_for_alternatives('category');
595 # Prompt for severity of bug
596 $severity ||= ask_for_alternatives('severity');
598 # Generate scratch file to edit report in
599 $filename = filename();
601 # Prompt for file to read report from, if needed
602 if ($usefile and !$file) {
605 What is the name of the file that contains your report?
608 my $entry = scalar <>;
613 No filename? I'll let you go back and choose an editor again.
618 unless (-f $entry and -r $entry) {
620 I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of
621 the file? If you don't want to send a file, just enter a blank line and you
622 can get back to the editor selection.
630 open(REP,">$filename") or die "Unable to create report file `$filename': $!\n";
631 my $reptype = !$ok ? ($thanks ? 'thank-you' : 'bug')
632 : $::opt_n ? "build failure" : "success";
635 This is a $reptype report for perl from $from,
636 generated with the help of perlbug $Version running under perl $perl_version.
644 or die "Unable to read report file from `$file': $!\n";
648 close(F) or die "Error closing `$file': $!";
653 -----------------------------------------------------------------
654 [Please enter your thank you message here]
658 [You're welcome to delete anything below this line if you prefer]
659 -----------------------------------------------------------------
664 -----------------------------------------------------------------
665 [Please enter your report here]
669 [Please do not change anything below this line]
670 -----------------------------------------------------------------
675 close(REP) or die "Error closing report file: $!";
677 # read in the report template once so that
678 # we can track whether the user does any editing.
679 # yes, *all* whitespace is ignored.
680 open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n";
685 close(REP) or die "Error closing report file `$filename': $!";
705 print OUT "This perlbug was built using Perl $config_tag1\n",
706 "It is being executed now by Perl $config_tag2.\n\n"
707 if $config_tag2 ne $config_tag1;
710 Site configuration information for perl $perl_version:
713 if ($::Config{cf_by} and $::Config{cf_time}) {
714 print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n";
716 print OUT Config::myconfig;
719 print OUT join "\n ", "Locally applied patches:", @patches;
726 \@INC for perl $perl_version:
735 Environment for perl $perl_version:
738 qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE);
739 push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne '';
740 push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV;
743 for my $env (sort keys %env) {
745 exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)',
749 print OUT "\nComplete configuration data for perl $perl_version:\n\n";
751 foreach (sort keys %::Config) {
752 $value = $::Config{$_};
754 print OUT "$_='$value'\n";
761 if ($usefile || $body) {
763 Please make sure that the name of the editor you want to use is correct.
765 print "Editor [$ed]: ";
766 my $entry =scalar <>;
768 $ed = $entry unless $entry eq '';
773 $sts = system("$ed $filename") unless $Is_MacOS;
775 require ExtUtils::MakeMaker;
776 ExtUtils::MM_MacOS::launch_file($filename);
778 Press Enter when done.
784 The editor you chose (`$ed') could apparently not be run!
785 Did you mistype the name of your editor? If so, please
786 correct it here, otherwise just press Enter.
788 print "Editor [$ed]: ";
789 my $entry =scalar <>;
797 You may want to save your report to a file, so you can edit and mail it
803 return if ($ok and not $::opt_n) || $body;
804 # Check that we have a report that has some, eh, report in it.
807 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
808 # a strange way to check whether any significant editing
809 # have been done: check whether any new non-empty lines
810 # have been added. Yes, the below code ignores *any* space
814 $unseen++ if $_ ne '' and not exists $REP{$_};
817 while ($unseen == 0) {
819 I am sorry but it looks like you did not report anything.
821 print "Action (Retry Edit/Cancel) ";
822 my ($action) = scalar(<>);
823 if ($action =~ /^[re]/i) { # <R>etry <E>dit
825 } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit
832 1 while unlink($filename); # remove all versions under VMS
833 print "\nCancelling.\n";
838 # Report is done, prompt for further action
842 Now that you have completed your report, would you like to send
843 the message to $address$andcc, display the message on
844 the screen, re-edit it, display/change the subject,
845 or cancel without sending anything?
846 You may also save the message as a file to mail at another time.
849 print "Action (Send/Display/Edit/Subject/Save to File): ";
850 my $action = scalar <>;
853 if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve
854 my $file_save = $outfile || "$progname.rep";
855 print "\n\nName of file to save message in [$file_save]: ";
856 my $file = scalar <>;
858 $file = $file_save if $file eq "";
860 unless (open(FILE, ">$file")) {
861 print "\nError opening $file: $!\n\n";
864 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
865 print FILE "To: $address\nSubject: $subject\n";
866 print FILE "Cc: $cc\n" if $cc;
867 print FILE "Reply-To: $from\n" if $from;
868 print FILE "Message-Id: $messageid\n" if $messageid;
870 while (<REP>) { print FILE }
871 close(REP) or die "Error closing report file `$filename': $!";
872 close(FILE) or die "Error closing $file: $!";
874 print "\nMessage saved in `$file'.\n";
876 } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow
877 # Display the message
878 open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n";
879 while (<REP>) { print $_ }
880 close(REP) or die "Error closing report file `$filename': $!";
881 } elsif ($action =~ /^su/i) { # <Su>bject
882 print "Subject: $subject\n";
883 print "If the above subject is fine, just press Enter.\n";
884 print "If not, type in the new subject.\n";
886 my $reply = scalar <STDIN>;
889 unless (TrivialSubject($reply)) {
891 print "Subject: $subject\n";
894 } elsif ($action =~ /^se/i) { # <S>end
896 print "Are you certain you want to send this message?\n"
897 . 'Please type "yes" if you are: ';
898 my $reply = scalar <STDIN>;
900 if ($reply eq "yes") {
904 That wasn't a clear "yes", so I won't send your message. If you are sure
905 your message should be sent, type in "yes" (without the quotes) at the
909 } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit
912 } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit
914 } elsif ($action =~ /^s/i) {
916 I'm sorry, but I didn't understand that. Please type "send" or "save".
926 /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i ||
927 length($subject) < 4 ||
929 print "\nThat doesn't look like a good subject. Please be more verbose.\n\n";
937 # Message has been accepted for transmission -- Send the message
939 open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n";
943 # on linux certain mail implementations won't accept the subject
944 # as "~s subject" and thus the Subject header will be corrupted
945 # so don't use Mail::Send to be safe
946 if ($::HaveSend && !$Is_Linux && !$Is_OpenBSD) {
947 $msg = new Mail::Send Subject => $subject, To => $address;
948 $msg->cc($cc) if $cc;
949 $msg->add("Reply-To",$from) if $from;
952 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
953 while (<REP>) { print $fh $_ }
954 close(REP) or die "Error closing $filename: $!";
957 print "\nMessage sent.\n";
959 if ( ($address =~ /@/ and $address !~ /^\w+%"/) or
960 ($cc =~ /@/ and $cc !~ /^\w+%"/) ) {
962 foreach (qw[ IN MX SMTP UCX PONY WINS ], '') {
963 $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"};
965 $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/;
966 $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/;
968 $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g;
969 my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]);
973 (leaving bug report in $filename): $sts
978 for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) {
979 $sendmail = $_, last if -e $_;
981 if ($^O eq 'os2' and $sendmail eq "") {
982 my $path = $ENV{PATH};
984 my @path = split /$Config{'path_sep'}/, $path;
986 $sendmail = "$_/sendmail", last if -e "$_/sendmail";
987 $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe";
991 paraprint(<<"EOF"), die "\n" if $sendmail eq "";
992 I am terribly sorry, but I cannot find sendmail, or a close equivalent, and
993 the perl package Mail::Send has not been installed, so I can't send your bug
994 report. We apologize for the inconvenience.
996 So you may attempt to find some way of sending your message, it has
997 been left in the file `$filename'.
999 open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!";
1001 print SENDMAIL "To: $address\n";
1002 print SENDMAIL "Subject: $subject\n";
1003 print SENDMAIL "Cc: $cc\n" if $cc;
1004 print SENDMAIL "Reply-To: $from\n" if $from;
1005 print SENDMAIL "Message-Id: $messageid\n" if $messageid;
1006 print SENDMAIL "\n\n";
1007 open(REP, "<$filename") or die "Couldn't open `$filename': $!\n";
1008 while (<REP>) { print SENDMAIL $_ }
1009 close(REP) or die "Error closing $filename: $!";
1011 if (close(SENDMAIL)) {
1012 printf "\nMessage %s.\n", $outfile ? "saved" : "sent";
1014 warn "\nSendmail returned status '", $? >> 8, "'\n";
1017 1 while unlink($filename); # remove all versions under VMS
1023 A program to help generate bug reports about perl5, and mail them.
1024 It is designed to be used interactively. Normally no arguments will
1028 $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ]
1029 [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h]
1030 $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay]
1032 Simplest usage: run "$0", and follow the prompts.
1036 -v Include Verbose configuration data in the report
1037 -f File containing the body of the report. Use this to
1038 quickly send a prepared message.
1039 -F File to output the resulting mail message to, instead of mailing.
1040 -S Send without asking for confirmation.
1041 -a Address to send the report to. Defaults to `$address'.
1042 -c Address to send copy of report to. Defaults to `$cc'.
1043 -C Don't send copy to administrator.
1044 -s Subject to include with the message. You will be prompted
1045 if you don't supply one on the command line.
1046 -b Body of the report. If not included on the command line, or
1047 in a file with -f, you will get a chance to edit the message.
1048 -r Your return address. The program will ask you to confirm
1049 this if you don't give it here.
1051 -t Test mode. The target address defaults to `$testaddress'.
1052 -T Thank-you mode. The target address defaults to
1053 -d Data mode. This prints out your configuration data, without mailing
1054 anything. You can use this with -v to get more complete data.
1055 -A Don't send a bug received acknowledgement to the return address.
1056 -ok Report successful build on this system to perl porters
1057 (use alone or with -v). Only use -ok if *everything* was ok:
1058 if there were *any* problems at all, use -nok.
1059 -okay As -ok but allow report from old builds.
1060 -nok Report unsuccessful build on this system to perl porters
1061 (use alone or with -v). You must describe what went wrong
1062 in the body of the report which you will be asked to edit.
1063 -nokay As -nok but allow report from old builds.
1064 -h Print this help message.
1071 # Good. Use a secure temp file
1072 my ($fh, $filename) = File::Temp::tempfile(UNLINK => 1);
1076 # Bah. Fall back to doing things less securely.
1077 my $dir = File::Spec->tmpdir();
1078 $filename = "bugrep0$$";
1079 $filename++ while -e File::Spec->catfile($dir, $filename);
1080 $filename = File::Spec->catfile($dir, $filename);
1085 my @paragraphs = split /\n{2,}/, "@_";
1087 for (@paragraphs) { # implicit local $_
1095 ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~
1103 perlbug - how to submit bug reports on Perl
1107 B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]>
1108 S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]>
1109 S<[ B<-r> I<returnaddress> ]>
1110 S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]>
1111 S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]>
1113 B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]>
1114 S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]>
1118 A program to help generate bug reports about perl or the modules that
1119 come with it, and mail them.
1121 If you have found a bug with a non-standard port (one that was not part
1122 of the I<standard distribution>), a binary distribution, or a
1123 non-standard module (such as Tk, CGI, etc), then please see the
1124 documentation that came with that distribution to determine the correct
1125 place to report bugs.
1127 C<perlbug> is designed to be used interactively. Normally no arguments
1128 will be needed. Simply run it, and follow the prompts.
1130 If you are unable to run B<perlbug> (most likely because you don't have
1131 a working setup to send mail that perlbug recognizes), you may have to
1132 compose your own report, and email it to B<perlbug@perl.org>. You might
1133 find the B<-d> option useful to get summary information in that case.
1135 In any case, when reporting a bug, please make sure you have run through
1140 =item What version of Perl you are running?
1142 Type C<perl -v> at the command line to find out.
1144 =item Are you running the latest released version of perl?
1146 Look at http://www.perl.com/ to find out. If it is not the latest
1147 released version, get that one and see whether your bug has been
1148 fixed. Note that bug reports about old versions of Perl, especially
1149 those prior to the 5.0 release, are likely to fall upon deaf ears.
1150 You are on your own if you continue to use perl1 .. perl4.
1152 =item Are you sure what you have is a bug?
1154 A significant number of the bug reports we get turn out to be documented
1155 features in Perl. Make sure the behavior you are witnessing doesn't fall
1156 under that category, by glancing through the documentation that comes
1157 with Perl (we'll admit this is no mean task, given the sheer volume of
1158 it all, but at least have a look at the sections that I<seem> relevant).
1160 Be aware of the familiar traps that perl programmers of various hues
1161 fall into. See L<perltrap>.
1163 Check in L<perldiag> to see what any Perl error message(s) mean.
1164 If message isn't in perldiag, it probably isn't generated by Perl.
1165 Consult your operating system documentation instead.
1167 If you are on a non-UNIX platform check also L<perlport>, as some
1168 features may be unimplemented or work differently.
1170 Try to study the problem under the Perl debugger, if necessary.
1173 =item Do you have a proper test case?
1175 The easier it is to reproduce your bug, the more likely it will be
1176 fixed, because if no one can duplicate the problem, no one can fix it.
1177 A good test case has most of these attributes: fewest possible number
1178 of lines; few dependencies on external commands, modules, or
1179 libraries; runs on most platforms unimpeded; and is self-documenting.
1181 A good test case is almost always a good candidate to be on the perl
1182 test suite. If you have the time, consider making your test case so
1183 that it will readily fit into the standard test suite.
1185 Remember also to include the B<exact> error messages, if any.
1186 "Perl complained something" is not an exact error message.
1188 If you get a core dump (or equivalent), you may use a debugger
1189 (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug
1190 report. NOTE: unless your Perl has been compiled with debug info
1191 (often B<-g>), the stack trace is likely to be somewhat hard to use
1192 because it will most probably contain only the function names and not
1193 their arguments. If possible, recompile your Perl with debug info and
1194 reproduce the dump and the stack trace.
1196 =item Can you describe the bug in plain English?
1198 The easier it is to understand a reproducible bug, the more likely it
1199 will be fixed. Anything you can provide by way of insight into the
1200 problem helps a great deal. In other words, try to analyze the
1201 problem (to the extent you can) and report your discoveries.
1203 =item Can you fix the bug yourself?
1205 A bug report which I<includes a patch to fix it> will almost
1206 definitely be fixed. Use the C<diff> program to generate your patches
1207 (C<diff> is being maintained by the GNU folks as part of the B<diffutils>
1208 package, so you should be able to get it from any of the GNU software
1209 repositories). If you do submit a patch, the cool-dude counter at
1210 perlbug@perl.org will register you as a savior of the world. Your
1211 patch may be returned with requests for changes, or requests for more
1212 detailed explanations about your fix.
1214 Here are some clues for creating quality patches: Use the B<-c> or
1215 B<-u> switches to the diff program (to create a so-called context or
1216 unified diff). Make sure the patch is not reversed (the first
1217 argument to diff is typically the original file, the second argument
1218 your changed file). Make sure you test your patch by applying it with
1219 the C<patch> program before you send it on its way. Try to follow the
1220 same style as the code you are trying to patch. Make sure your patch
1221 really does work (C<make test>, if the thing you're patching supports
1224 =item Can you use C<perlbug> to submit the report?
1226 B<perlbug> will, amongst other things, ensure your report includes
1227 crucial information about your version of perl. If C<perlbug> is unable
1228 to mail your report after you have typed it in, you may have to compose
1229 the message yourself, add the output produced by C<perlbug -d> and email
1230 it to B<perlbug@perl.org>. If, for some reason, you cannot run
1231 C<perlbug> at all on your system, be sure to include the entire output
1232 produced by running C<perl -V> (note the uppercase V).
1234 Whether you use C<perlbug> or send the email manually, please make
1235 your Subject line informative. "a bug" not informative. Neither is
1236 "perl crashes" nor "HELP!!!". These don't help.
1237 A compact description of what's wrong is fine.
1241 Having done your bit, please be prepared to wait, to be told the bug
1242 is in your code, or even to get no reply at all. The Perl maintainers
1243 are busy folks, so if your problem is a small one or if it is difficult
1244 to understand or already known, they may not respond with a personal reply.
1245 If it is important to you that your bug be fixed, do monitor the
1246 C<Changes> file in any development releases since the time you submitted
1247 the bug, and encourage the maintainers with kind words (but never any
1248 flames!). Feel free to resend your bug report if the next released
1249 version of perl comes out and your bug is still present.
1257 Address to send the report to. Defaults to B<perlbug@perl.org>.
1261 Don't send a bug received acknowledgement to the reply address.
1262 Generally it is only a sensible to use this option if you are a
1263 perl maintainer actively watching perl porters for your message to
1268 Body of the report. If not included on the command line, or
1269 in a file with B<-f>, you will get a chance to edit the message.
1273 Don't send copy to administrator.
1277 Address to send copy of report to. Defaults to the address of the
1278 local perl administrator (recorded when perl was built).
1282 Data mode (the default if you redirect or pipe output). This prints out
1283 your configuration data, without mailing anything. You can use this
1284 with B<-v> to get more complete data.
1292 File containing the body of the report. Use this to quickly send a
1297 File to output the results to instead of sending as an email. Useful
1298 particularly when running perlbug on a machine with no direct internet
1303 Prints a brief summary of the options.
1307 Report successful build on this system to perl porters. Forces B<-S>
1308 and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only
1309 prompts for a return address if it cannot guess it (for use with
1310 B<make>). Honors return address specified with B<-r>. You can use this
1311 with B<-v> to get more complete data. Only makes a report if this
1312 system is less than 60 days old.
1316 As B<-ok> except it will report on older systems.
1320 Report unsuccessful build on this system. Forces B<-C>. Forces and
1321 supplies a value for B<-s>, then requires you to edit the report
1322 and say what went wrong. Alternatively, a prepared report may be
1323 supplied using B<-f>. Only prompts for a return address if it
1324 cannot guess it (for use with B<make>). Honors return address
1325 specified with B<-r>. You can use this with B<-v> to get more
1326 complete data. Only makes a report if this system is less than 60
1331 As B<-nok> except it will report on older systems.
1335 Your return address. The program will ask you to confirm its default
1336 if you don't use this option.
1340 Send without asking for confirmation.
1344 Subject to include with the message. You will be prompted if you don't
1345 supply one on the command line.
1349 Test mode. The target address defaults to B<perlbug-test@perl.org>.
1353 Include verbose configuration data in the report.
1359 Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored
1360 by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen
1361 (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>),
1362 Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy
1363 (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>),
1364 Hugo van der Sanden (E<lt>hv@crypt.org<gt>),
1365 Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor
1366 (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>,
1367 and Richard Foley (E<lt>richard@rfi.netE<gt>).
1371 perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1),
1372 diff(1), patch(1), dbx(1), gdb(1)
1376 None known (guess what must have been used to report them?)
1382 close OUT or die "Can't close $file: $!";
1383 chmod 0755, $file or die "Can't reset permissions for $file: $!\n";
1384 exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':';