X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/8b49bb9af6b73f5b844abedd87486b1c41fc6b01..e2d73a187ae89e218e7afbba96e00e1370ab2240:/utils/perlbug.PL diff --git a/utils/perlbug.PL b/utils/perlbug.PL index e5c5230..47d23fa 100644 --- a/utils/perlbug.PL +++ b/utils/perlbug.PL @@ -3,6 +3,7 @@ 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 @@ -23,27 +24,35 @@ open OUT, ">$file" or die "Can't create $file: $!"; # extract patchlevel.h information -open PATCH_LEVEL, "<../patchlevel.h" or die "Can't open patchlevel.h: $!"; +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*$/; + last if $_ =~ /^\s*static\s+(?:const\s+)?char.*?local_patches\[\]\s*=\s*{\s*$/; +} + +if (! defined($_)) { + warn "Warning: local_patches section not found in patchlevel.h\n"; } my @patches; while () { last if /^\s*}/; + next if /^\s*#/; # preprocessor stuff + next if /PERL_GIT_UNPUSHED_COMMITS/; # XXX expand instead + next if /"uncommitted-changes"/; # XXX determine if active instead chomp; - s/^\s+,?"?//; - s/"?,?$//; + 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; +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 @@ -55,12 +64,14 @@ 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("%vd", $^V); + print OUT <<"!GROK!THIS!"; $Config{startperl} eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' if \$running_under_some_shell; -my \$config_tag1 = '$] - $Config{cf_time}'; +my \$config_tag1 = '$extract_version - $Config{cf_time}'; my \$patchlevel_date = $patchlevel_date; my \$patch_tags = '$patch_tags'; @@ -73,20 +84,28 @@ my \@patches = ( print OUT <<'!NO!SUBS!'; +use warnings; +use strict; use Config; +use File::Spec; # keep perlbug Perl 5.005 compatible use Getopt::Std; -use strict; +use File::Basename 'basename'; sub paraprint; BEGIN { - eval "use Mail::Send;"; + eval { require Mail::Send;}; $::HaveSend = ($@ eq ""); - eval "use Mail::Util;"; + eval { require Mail::Util; } ; $::HaveUtil = ($@ eq ""); + # use secure tempfiles wherever possible + eval { require File::Temp; }; + $::HaveTemp = ($@ eq ""); + eval { require Module::CoreList; }; + $::HaveCoreList = ($@ eq ""); }; -my $Version = "1.25"; +my $Version = "1.39"; # 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. @@ -116,45 +135,126 @@ my $Version = "1.25"; # 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 - -# TODO: - Allow the user to re-name the file on mail failure, and -# make sure failure (transmission-wise) of Mail::Send is -# accounted for. +# 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 +# Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000 +# Changed in 1.33 Don't require -t STDOUT for -ok. +# Changed in 1.34 Added Message-Id RFOLEY 18-06-2002 +# Changed in 1.35 Use File::Temp (patch from Solar Designer) NWCLARK 28-02-2004 +# Changed in 1.36 Initial Module::CoreList support Alexandr Ciornii 11-07-2007 +# Changed in 1.37 Killed some string evals, rewrote most prose JESSE 2008-06-08 +# Changed in 1.38 Actually enforce the CoreList check, +# Record the module the user enters if they do so +# Refactor prompts to use common code JESSE 2008-06-08 +# Changed in 1.39 Trap mail sending failures (simple ones) so JESSE 2008-06-08 +# users might be able to recover their bug reports +# Refactor mail sending routines +# Unify message building code +# Unify message header building +# Fix "module" prompting to not squish "category" prompting +# use warnings; (except 'once' warnings) +# Unified report fingerprint/change detection code +# Removed some labeled 'gotos' +#TODO: +# make sure failure (transmission-wise) of Mail::Send is accounted for. +# (This may work now. Unsure of the original author's issue -JESSE 2008-06-08) # - Test -b option -my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, - $subject, $from, $verbose, $ed, $outfile, - $fh, $me, $Is_MSWin32, $Is_VMS, $msg, $body, $andcc, %REP, $ok); +my( $file, $usefile, $cc, $address, $bugaddress, $testaddress, $thanksaddress, + $filename, $messageid, $domain, $subject, $from, $verbose, $ed, $outfile, + $fh, $me, $body, $andcc, %REP, $ok, $thanks, $progname, + $Is_MSWin32, $Is_Linux, $Is_VMS, $Is_OpenBSD, + $report_about_module, $category, $severity, + %opt, +); + +my $perl_version = $^V ? sprintf("%vd", $^V) : $]; -my $config_tag2 = "$] - $Config{cf_time}"; +my $config_tag2 = "$perl_version - $Config{cf_time}"; Init(); -if ($::opt_h) { Help(); exit; } -if ($::opt_d) { Dump(*STDOUT); exit; } -if (!-t STDIN) { - paraprint < { + 'default' => 'core', + 'ok' => 'install', + # Inevitably some of these will end up in RT whatever we do: + 'thanks' => 'thanks', + 'opts' => [qw(core docs install library utilities)], # patch, notabug + }, + 'severity' => { + 'default' => 'low', + 'ok' => 'none', + 'thanks' => 'none', + 'opts' => [qw(critical high medium low wishlist none)], # zero + }, + ); + die "Invalid alternative ($name) requested\n" unless grep(/^$name$/, keys %alts); + my $alt = ""; + my $what = $ok || $thanks; + if ($what) { + $alt = $alts{$name}{$what}; + } else { + my @alts = @{$alts{$name}{'opts'}}; + print "\n\n"; + paraprint < 5) { + die "Invalid $name: aborting.\n"; + } + $alt = _prompt('', "\u$name", $alts{$name}{'default'}); + $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_Linux = lc($^O) eq 'linux'; + $Is_OpenBSD = lc($^O) eq 'openbsd'; - getopts("dhva:s:b:f:F:r:e:SCc:to:n:"); + if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:T", \%opt)) { Help(); exit; }; # This comment is needed to notify metaconfig that we are # using the $perladmin, $cf_by, and $cf_time definitions. @@ -162,45 +262,60 @@ sub Init { # -------- Configuration --------- # perlbug address - $perlbug = 'perlbug@perl.com'; + $bugaddress = 'perlbug@perl.org'; # Test address - $testaddress = 'perlbug-test@perl.com'; + $testaddress = 'perlbug-test@perl.org'; + + # Thanks address + $thanksaddress = 'perl-thanks@perl.org'; + + if (basename ($0) =~ /^perlthanks/i) { + # invoked as perlthanks + $opt{T} = 1; + $opt{C} = 1; # don't send a copy to the local admin + } + if ($opt{T}) { + $thanks = 'thanks'; + } + + $progname = $thanks ? 'perlthanks' : 'perlbug'; # Target address - $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug); + $address = $opt{a} || ($opt{t} ? $testaddress + : $thanks ? $thanksaddress : $bugaddress); - # Users address, used in message and in Reply-To header - $from = $::opt_r || ""; + # Users address, used in message and in From and Reply-To headers + $from = $opt{r} || ""; # Include verbose configuration information - $verbose = $::opt_v || 0; + $verbose = $opt{v} || 0; # Subject of bug-report message - $subject = $::opt_s || ""; + $subject = $opt{s} || ""; # Send a file - $usefile = ($::opt_f || 0); + $usefile = ($opt{f} || 0); # File to send as report - $file = $::opt_f || ""; + $file = $opt{f} || ""; # File to output to - $outfile = $::opt_F || ""; + $outfile = $opt{F} || ""; # Body of report - $body = $::opt_b || ""; - + $body = $opt{b} || ""; + # Editor - $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT} + $ed = $opt{e} || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT} || ($Is_VMS && "edit/tpu") || ($Is_MSWin32 && "notepad") || "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); + if ($opt{n}) { + if (substr($opt{n}, 0, 2) eq 'ok' ) { + $opt{o} = substr($opt{n}, 1); } else { Help(); exit(); @@ -208,11 +323,11 @@ sub Init { } # OK - send "OK" report for build on this system - $ok = 0; - if ($::opt_o) { - if ($::opt_o eq 'k' or $::opt_o eq 'kay') { + $ok = ''; + 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 ) { + 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 @@ -223,17 +338,17 @@ EOF exit(); } # force these options - unless ($::opt_n) { - $::opt_S = 1; # don't prompt for send - $::opt_b = 1; # we have a body + 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 $] ${patch_tags}on" + $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; + $ok = 'ok'; } else { Help(); exit(); @@ -245,12 +360,24 @@ EOF # 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'} + # that $opt{C} is forced. + $cc = $opt{C} ? "" : ( + $opt{c} || $::Config{'perladmin'} || $::Config{'cf_email'} || $::Config{'cf_by'} ); + if ($::HaveUtil) { + $domain = Mail::Util::maildomain(); + } elsif ($Is_MSWin32) { + $domain = $ENV{'USERDOMAIN'}; + } else { + require Sys::Hostname; + $domain = Sys::Hostname::hostname(); + } + + # Message-Id - rjsf + $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>"; + # My username $me = $Is_MSWin32 ? $ENV{'USERNAME'} : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'} @@ -264,59 +391,73 @@ EOF 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"; + do { + $subject = _prompt('','Subject'); + if ($err++ == 5) { + if ($thanks) { + $subject = 'Thanks for Perl'; + } else { + die "Aborting.\n"; + } } - } - chop $subject; + } while (TrivialSubject($subject)); } # Prompt for return address, if needed - unless ($from) { + unless ($opt{r}) { # Try and guess return address my $guess; - $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || ''; + $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || $ENV{'EMAIL'} + || $from || ''; + 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) { + # move $domain to where we can use it elsewhere + if ($domain) { if ($Is_VMS && !$::Config{'d_socket'}) { $guess = "$domain\:\:$me"; } else { @@ -328,14 +469,17 @@ EOF if ($guess) { unless ($ok) { paraprint <; - chop $from; + $from = _prompt('','Your address',$guess); $from = $guess if $from eq ''; } } @@ -357,16 +499,13 @@ EOF } # Prompt for administrator address, unless an override was given - if( !$::opt_C and !$::opt_c ) { - paraprint <; - chop $entry; + my $entry = _prompt($description, "Local perl administrator", $cc); if ($entry ne "") { $cc = $entry; @@ -375,37 +514,59 @@ EOF } $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i; - $andcc = " and $cc" if $cc; + if ($cc) { + $andcc = " and $cc" + } else { + $andcc = '' + } # Prompt for editor, if no override is given editor: - unless ($::opt_e || $::opt_f || $::opt_b) { - paraprint <; - chop $entry; + if ($thanks) { + $description = <<"EOF"; +It's now time to compose your thank-you message. + +Some information about your local perl configuration will automatically +be included at the end of your message, because we're curious about +the different ways that people build and use perl. If you'd rather +not share this information, you're welcome to delete it. + +$common_end +EOF + } else { + $description = <<"EOF"; +It's now time to compose your bug report. Try to make the report +concise but descriptive. Please include any detail which you think +might be relevant or might help the volunteers working to improve +perl. If you are reporting something that does not work as you think +it should, please try to include examples of the actual result and of +what you expected. + +Some information about your local perl configuration will automatically +be included at the end of your report. If you are using an unusual +version of perl, it would be useful if you could confirm that you +can replicate the problem on a standard build of perl as well. + +$common_end +EOF + } + + my $entry = _prompt($description, "Editor", $ed); $usefile = 0; if ($entry eq "file") { $usefile = 1; @@ -413,6 +574,46 @@ EOF $ed = $entry; } } + if ($::HaveCoreList && !$ok && !$thanks) { + my $description = <first_release($entry); + if ($entry and not $first_release) { + paraprint <; - chop $entry; + my $entry = _prompt($description, "Filename"); if ($entry eq "") { paraprint <$filename"); - my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success"; + open(REP,">$filename") or die "Unable to create report file '$filename': $!\n"; + my $reptype = !$ok ? ($thanks ? 'thank-you' : 'bug') + : $opt{n} ? "build failure" : "success"; print REP <) { print REP $_ } - close(F); + close(F) or die "Error closing '$file': $!"; } else { - print REP <) { - s/\s+//g; - $REP{$_}++; - } - close(REP); } # sub Query sub Dump { local(*OUT) = @_; - print REP "\n---\n"; - print REP "This perlbug was built using Perl $config_tag1\n", + # these won't have been set if run with -d + $category ||= 'core'; + $severity ||= 'low'; + + print OUT <; - chop $entry; + my $description = "Please make sure that the name of the editor you want to use is correct."; + my $entry = _prompt($description, 'Editor', $ed); $ed = $entry unless $entry eq ''; } -tryagain: - my $sts = system("$ed $filename"); - if ($sts) { - paraprint <; - chop $entry; + _edit_file($ed); +} - if ($entry ne "") { - $ed = $entry; - goto tryagain; - } else { - paraprint <) { - s/\s+//g; - $unseen++ if $_ ne '' and not exists $REP{$_}; - } + # Check that we have a report that has some, eh, report in it. - while ($unseen == 0) { - paraprint <); - if ($action =~ /^[re]/i) { # etry dit - goto tryagain; - } elsif ($action =~ /^[cq]/i) { # ancel, uit - Cancel(); - } + my $action = _prompt( $description, "Action (Retry/Cancel) " ); + if ( $action =~ /^[re]/i ) { # etry dit + next; + } elsif ( $action =~ /^[cq]/i ) { # ancel, uit + Cancel(); # cancel exits + } + } + # Ok. the user did what they needed to; + return; + } -} # sub Edit +} + sub Cancel { 1 while unlink($filename); # remove all versions under VMS - print "\nCancelling.\n"; + print "\nQuitting without sending your message.\n"; exit(0); } sub NowWhat { # Report is done, prompt for further action - if( !$::opt_S ) { + if( !$opt{S} ) { while(1) { - paraprint <; - chop $action; - + print $menu; + my $action = _prompt('', "Action (Send/Display/Edit/Subject/Save to File)");; + print "\n"; 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"); - 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); - close(FILE); - - print "\nMessage saved in `$file'.\n"; - exit; + if ( SaveMessage() ) { exit } } elsif ($action =~ /^(d|l|sh)/i ) { # isplay, ist, ow # Display the message - open(REP, "<$filename"); + open(REP, "<$filename") or die "Couldn't open file '$filename': $!\n"; while () { print $_ } - close(REP); + close(REP) or die "Error closing report file '$filename': $!"; + } elsif ($action =~ /^su/i) { # bject + my $reply = _prompt( "Subject: $subject", "If the above subject is fine, press Enter. Otherwise, type a replacement now\nSubject"); + if ($reply ne '') { + unless (TrivialSubject($reply)) { + $subject = $reply; + print "Subject: $subject\n"; + } + } } 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") { + my $reply = _prompt( "Are you certain you want to send this message?", 'Please type "yes" if you are','no'); + if ($reply =~ /^yes$/) { last; } else { paraprint <dit, e-edit @@ -675,117 +899,94 @@ EOF Edit(); } elsif ($action =~ /^[qc]/i) { # ancel, uit Cancel(); - } elsif ($action =~ /^s/) { + } elsif ($action =~ /^s/i) { paraprint <$outfile" or die "Couldn't open '$outfile': $!\n"; - goto sendout; +sub TrivialSubject { + my $subject = shift; + if ($subject =~ + /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i || + length($subject) < 4 || + $subject !~ /\s/) { + print "\nThe subject you entered wasn't very descriptive. Please try again.\n\n"; + return 1; + } else { + return 0; } - 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"); - while () { print $fh $_ } - close(REP); - $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); - - if (close(SENDMAIL)) { - printf "\nMessage %s.\n", $outfile ? "saved" : "sent"; - } else { - warn "\nSendmail returned status '", $? >> 8, "'\n"; - } + SaveMessage(); + return; } - 1 while unlink($filename); # remove all versions under VMS -} # sub Send + + 1 while unlink($filename); # remove all versions under VMS +} # sub Send sub Help { print < 1); + close($fh); + return $filename; + } else { + # Bah. Fall back to doing things less securely. + my $dir = File::Spec->tmpdir(); + $filename = "bugrep0$$"; + $filename++ while -e File::Spec->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; @@ -831,6 +1037,167 @@ sub paraprint { } } +sub _prompt { + my ($explanation, $prompt, $default) = (@_); + if ($explanation) { + print "\n\n"; + paraprint $explanation; + } + print $prompt. ($default ? " [$default]" :''). ": "; + my $result = scalar(<>); + chomp($result); + $result =~ s/^\s*(.*?)\s*$/$1/s; + if ($default && $result eq '') { + return $default; + } else { + return $result; + } +} + +sub _build_header { + my %attr = (@_); + + my $head = ''; + for my $header (keys %attr) { + $head .= "$header: ".$attr{$header}."\n"; + } + return $head; +} + +sub _message_headers { + my %headers = ( To => $address, Subject => $subject ); + $headers{'Cc'} = $cc if ($cc); + $headers{'Message-Id'} = $messageid if ($messageid); + $headers{'Reply-To'} = $from if ($from); + $headers{'From'} = $from if ($from); + return \%headers; +} + +sub build_complete_message { + my $content = _build_header(%{_message_headers()}) . "\n\n"; + open( REP, "<$filename" ) or die "Couldn't open file '$filename': $!\n"; + while () { $content .= $_; } + close(REP) or die "Error closing report file '$filename': $!"; + return $content; +} + +sub save_message_to_disk { + my $file = shift; + + open OUTFILE, ">$file" or do { warn "Couldn't open '$file': $!\n"; return undef}; + print OUTFILE build_complete_message(); + close(OUTFILE) or do { warn "Error closing $file: $!"; return undef }; + print "\nMessage saved.\n"; + return 1; +} + +sub _send_message_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 "Can't spawn off mail (leaving bug report in $filename): $sts"; + } +} + +sub _send_message_mailsend { + my $msg = Mail::Send->new(); + my %headers = %{_message_headers()}; + for my $key ( keys %headers) { + $msg->add($key => $headers{$key}); + } + + $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 or die "Error sending mail: $!"; + + print "\nMessage sent.\n"; +} + +sub _probe_for_sendmail { + my $sendmail = ""; + for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) { + $sendmail = $_, last if -e $_; + } + if ( $^O eq 'os2' and $sendmail eq "" ) { + my $path = $ENV{PATH}; + $path =~ s:\\:/:; + my @path = split /$Config{'path_sep'}/, $path; + for (@path) { + $sendmail = "$_/sendmail", last if -e "$_/sendmail"; + $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe"; + } + } + return $sendmail; +} + +sub _send_message_sendmail { + my $sendmail = _probe_for_sendmail(); + unless ($sendmail) { + my $message_start = !$Is_Linux && !$Is_OpenBSD ? <<'EOT' : <<'EOT'; +It appears that there is no program which looks like "sendmail" on +your system and that the Mail::Send library from CPAN isn't available. +EOT +It appears that there is no program which looks like "sendmail" on +your system. +EOT + paraprint(<<"EOF"), die "\n"; +$message_start +Because of this, there's no easy way to automatically send your +message. + +A copy of your message has been saved in '$filename' for you to +send to '$address' with your normal mail client. +EOF + } + + open( SENDMAIL, "|-", $sendmail, "-t", "-oi", "-f", $from ) + || die "'|$sendmail -t -oi -f $from' failed: $!"; + print SENDMAIL build_complete_message(); + if ( close(SENDMAIL) ) { + print "\nMessage sent\n"; + } else { + warn "\nSendmail returned status '", $? >> 8, "'\n"; + } +} + + + +# a strange way to check whether any significant editing +# has been done: check whether any new non-empty lines +# have been added. + +sub _fingerprint_lines_in_report { + my $new_lines = 0; + # read in the report template once so that + # we can track whether the user does any editing. + # yes, *all* whitespace is ignored. + + open(REP, "<$filename") or die "Unable to open report file '$filename': $!\n"; + while (my $line = ) { + $line =~ s/\s+//g; + $new_lines++ if (!$REP{$line}); + + } + close(REP) or die "Error closing report file '$filename': $!"; + # returns the number of lines with content that wasn't there when last we looked + return $new_lines; +} + + + format STDOUT = ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~ $_ @@ -844,126 +1211,193 @@ perlbug - how to submit bug reports on Perl =head1 SYNOPSIS +B + 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> ]> +S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]> S<[ B<-T> ]> B S<[ B<-v> ]> S<[ B<-r> I ]> -S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]> + S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]> + +B =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. +This program is designed to help you generate and send bug reports +(and thank-you notes) about perl5 and the modules which ship with it. + +In most cases, you can just run it interactively from a command +line without any special arguments and follow the prompts. + +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-core module (such as Tk, DBI, etc), then please see the +documentation that came with that distribution to determine the +correct place to report bugs. + +If you are unable to send your report using B (most likely +because your system doesn't have a way to send mail that perlbug +recognizes), you may be able to use this tool to compose your report +and save it to a file which you can then send to B +using your regular mail client. -C is designed to be used interactively. Normally no arguments -will be needed. Simply run it, and follow the prompts. +In extreme cases, B may not work well enough on your system +to guide you through composing a bug report. In those cases, you +may be able to use B to get system configuration +information to include in a manually composed bug report to +B. -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: +When reporting a bug, please run through this checklist: =over 4 -=item What version of perl you are running? +=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. +Look at http://www.perl.org/ to find out. If you are not using the +latest released version, please try to replicate your bug on the +latest stable release. + +Note that reports about bugs in old versions of Perl, especially +those which indicate you haven't also tested the current stable +release of Perl, are likely to receive less attention from the +volunteers who build and maintain Perl than reports about bugs in +the current release. + +This tool isn't appropriate for reporting bugs in any version +prior to Perl 5.0. =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). +A significant number of the bug reports we get turn out to be +documented features in Perl. Make sure the issue you've run into +isn't intentional by glancing through the documentation that comes +with the Perl distribution. + +Given the sheer volume of Perl documentation, this isn't a trivial +undertaking, but if you can point to documentation that suggests +the behaviour you're seeing is I, your issue is likely to +receive more attention. You may want to start with B +L for pointers to common traps that new (and experienced) +Perl programmers run into. + +If you're unsure of the meaning of an error message you've run +across, B L for an explanation. If the message +isn't in perldiag, it probably isn't generated by Perl. You may +have luck consulting your operating system documentation instead. -Be aware of the familiar traps that perl programmers of various hues -fall into. See L. +If you are on a non-UNIX platform B L, as some +features may be unimplemented or work differently. -Try to study the problem under the perl debugger, if necessary. -See L. +You may be able to figure out what's going wrong using the Perl +debugger. For information about how to use the debugger B +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. +fixed -- if nobody can duplicate your problem, it probably won't be +addressed. + +A good test case has most of these attributes: short, simple code; +few dependencies on external commands, modules, or libraries; no +platform-dependent code (unless it's a platform-specific bug); +clear, simple documentation. + +A good test case is almost always a good candidate to be included in +Perl's test suite. If you have the time, consider writing your test case so +that it can be easily included into the standard test suite. + +=item Have you included all relevant information? -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. +Be sure to include the B error messages, if any. +"Perl gave an error" 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 crash 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 analyse the -problem to the extent you feel qualified and report your discoveries. +The easier it is to understand a reproducible bug, the more likely +it will be fixed. Any insight you can provide into the problem +will help 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 +definitely be fixed. When sending a patch, please use the C +program with the C<-u> option to generate "unified" diff files. +Bug reports with patches are likely to receive significantly more +attention and interest than those without patches. + +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). +Here are a few hints for creating high-quality patches: + +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 is covered +by Perl's test suite). =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). +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" is not informative. Neither +is "perl crashes" nor is "HELP!!!". These don't help. A compact +description of what's wrong is fine. + +=item Can you use C to submit a thank-you note? + +Yes, you can do this by either using the C<-T> option, or by invoking +the program as C. Thank-you notes are good. It makes people +smile. =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. +Having done your bit, please be prepared to wait, to be told the +bug is in your code, or possibly to get no reply at all. The +volunteers who maintain Perl are busy folks, so if your problem is +an obvious bug in your own code, is difficult to understand or is +a duplicate of an existing report, you may not receive 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. +perl5-porters@perl.org mailing list and the commit logs to development +versions of Perl, and encourage the maintainers with kind words or +offers of frosty beverages. (Please do be kind to the maintainers. +Harassing or flaming them is likely to have the opposite effect of +the one you want.) + +Feel free to update the ticket about your bug on http://rt.perl.org +if a new version of Perl is released and your bug is still present. =head1 OPTIONS @@ -971,7 +1405,14 @@ version of perl comes out and your bug is still present. =item B<-a> -Address to send the report to. Defaults to `perlbug@perl.com'. +Address to send the report to. Defaults to B. + +=item B<-A> + +Don't send a bug received acknowledgement to the reply address. +Generally it is only a sensible to use this option if you are a +perl maintainer actively watching perl porters for your message to +arrive. =item B<-b> @@ -1056,7 +1497,11 @@ supply one on the command line. =item B<-t> -Test mode. The target address defaults to `perlbug-test@perl.com'. +Test mode. The target address defaults to B. + +=item B<-T> + +Send a thank-you note instead of a bug report. =item B<-v> @@ -1066,16 +1511,21 @@ Include verbose configuration data in the report. =head1 AUTHORS -Kenneth Albanowski (Ekjahds@kjahds.comE), subsequently Itored -by Gurusamy Sarathy (Egsar@umich.eduE), 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) -and Hugo van der Sanden (Ehv@crypt0.demon.co.ukE). +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@crypt.org), +Jarkko Hietaniemi (Ejhi@iki.fiE), Chris Nandor +(Epudge@pobox.comE), Jon Orwant (Eorwant@media.mit.eduE, +Richard Foley (Erichard.foley@rfi.netE), and Jesse Vincent +(Ejesse@bestpractical.com). =head1 SEE ALSO -perl(1), perldebug(1), perltrap(1), diff(1), patch(1) +perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1), +diff(1), patch(1), dbx(1), gdb(1) =head1 BUGS @@ -1089,4 +1539,3 @@ 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; -