Commit | Line | Data |
---|---|---|
37fa004c | 1 | #!/usr/local/bin/perl |
2 | ||
3 | use Config; | |
4 | use File::Basename qw(&basename &dirname); | |
8a5546a1 | 5 | use Cwd; |
1948c06a | 6 | use File::Spec::Functions; |
37fa004c | 7 | |
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 | |
12 | # $startperl | |
13 | # to ensure Configure will look for $Config{startperl}. | |
84902520 | 14 | # $perlpath |
37fa004c | 15 | |
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. | |
8a5546a1 | 18 | $origdir = cwd; |
44a8e56a | 19 | chdir dirname($0); |
20 | $file = basename($0, '.PL'); | |
774d564b | 21 | $file .= '.com' if $^O eq 'VMS'; |
37fa004c | 22 | |
55d729e4 | 23 | open OUT, ">$file" or die "Can't create $file: $!"; |
37fa004c | 24 | |
84902520 TB |
25 | # extract patchlevel.h information |
26 | ||
1948c06a CN |
27 | open PATCH_LEVEL, "<" . catfile(updir, "patchlevel.h") |
28 | or die "Can't open patchlevel.h: $!"; | |
84902520 TB |
29 | |
30 | my $patchlevel_date = (stat PATCH_LEVEL)[9]; | |
31 | ||
32 | while (<PATCH_LEVEL>) { | |
fb73857a | 33 | last if $_ =~ /^\s*static\s+char.*?local_patches\[\]\s*=\s*{\s*$/; |
55d729e4 | 34 | } |
84902520 | 35 | |
fb73857a | 36 | my @patches; |
84902520 | 37 | while (<PATCH_LEVEL>) { |
fb73857a | 38 | last if /^\s*}/; |
84902520 | 39 | chomp; |
5963b987 GS |
40 | s/^\s+,?\s*"?//; |
41 | s/"?\s*,?$//; | |
84902520 | 42 | s/(['\\])/\\$1/g; |
fb73857a | 43 | push @patches, $_ unless $_ eq 'NULL'; |
55d729e4 GS |
44 | } |
45 | my $patch_desc = "'" . join("',\n '", @patches) . "'"; | |
46 | my $patch_tags = join "", map /(\S+)/ ? "+$1 " : (), @patches; | |
84902520 | 47 | |
c0a6bf09 | 48 | close(PATCH_LEVEL) or die "Error closing patchlevel.h: $!"; |
84902520 | 49 | |
5edeba26 TB |
50 | # TO DO (prehaps): store/embed $Config::config_sh into perlbug. When perlbug is |
51 | # used, compare $Config::config_sh with the stored version. If they differ then | |
52 | # append a list of individual differences to the bug report. | |
53 | ||
84902520 | 54 | |
37fa004c | 55 | print "Extracting $file (with variable substitutions)\n"; |
56 | ||
57 | # In this section, perl variables will be expanded during extraction. | |
58 | # You can use $Config{...} to use Configure variables. | |
59 | ||
b22c7a20 | 60 | my $extract_version = sprintf("v%vd", $^V); |
1ec03f31 | 61 | |
37fa004c | 62 | print OUT <<"!GROK!THIS!"; |
5f05dabc | 63 | $Config{startperl} |
64 | eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' | |
65 | if \$running_under_some_shell; | |
84902520 | 66 | |
1ec03f31 | 67 | my \$config_tag1 = '$extract_version - $Config{cf_time}'; |
fb73857a | 68 | |
84902520 | 69 | my \$patchlevel_date = $patchlevel_date; |
fb73857a | 70 | my \$patch_tags = '$patch_tags'; |
71 | my \@patches = ( | |
55d729e4 | 72 | $patch_desc |
fb73857a | 73 | ); |
37fa004c | 74 | !GROK!THIS! |
75 | ||
76 | # In the following, perl variables are not expanded during extraction. | |
77 | ||
78 | print OUT <<'!NO!SUBS!'; | |
79 | ||
80 | use Config; | |
1ec03f31 | 81 | use File::Spec; # keep perlbug Perl 5.005 compatible |
37fa004c | 82 | use Getopt::Std; |
37fa004c | 83 | use strict; |
84 | ||
85 | sub paraprint; | |
86 | ||
55d729e4 GS |
87 | BEGIN { |
88 | eval "use Mail::Send;"; | |
89 | $::HaveSend = ($@ eq ""); | |
90 | eval "use Mail::Util;"; | |
91 | $::HaveUtil = ($@ eq ""); | |
003a92ef NC |
92 | # use secure tempfiles wherever possible |
93 | eval "require File::Temp;"; | |
94 | $::HaveTemp = ($@ eq ""); | |
55d729e4 | 95 | }; |
c07a80fd | 96 | |
003a92ef | 97 | my $Version = "1.35"; |
c07a80fd | 98 | |
99 | # Changed in 1.06 to skip Mail::Send and Mail::Util if not available. | |
a5f75d66 AD |
100 | # Changed in 1.07 to see more sendmail execs, and added pipe output. |
101 | # Changed in 1.08 to use correct address for sendmail. | |
c07a80fd | 102 | # Changed in 1.09 to close the REP file before calling it up in the editor. |
103 | # Also removed some old comments duplicated elsewhere. | |
104 | # Changed in 1.10 to run under VMS without Mail::Send; also fixed | |
a5f75d66 | 105 | # temp filename generation. |
c07a80fd | 106 | # Changed in 1.11 to clean up some text and removed Mail::Send deactivator. |
a5f75d66 AD |
107 | # Changed in 1.12 to check for editor errors, make save/send distinction |
108 | # clearer and add $ENV{REPLYTO}. | |
84478119 | 109 | # Changed in 1.13 to hopefully make it more difficult to accidentally |
110 | # send mail | |
ab3ef367 | 111 | # Changed in 1.14 to make the prompts a little more clear on providing |
112 | # helpful information. Also let file read fail gracefully. | |
8ecf1a0c KA |
113 | # Changed in 1.15 to add warnings to stop people using perlbug for non-bugs. |
114 | # Also report selected environment variables. | |
774d564b | 115 | # Changed in 1.16 to include @INC, and allow user to re-edit if no changes. |
137443ea | 116 | # Changed in 1.17 Win32 support added. GSAR 97-04-12 |
1b0e3b9e | 117 | # Changed in 1.18 add '-ok' option for reporting build success. CFR 97-06-18 |
84902520 TB |
118 | # Changed in 1.19 '-ok' default not '-v' |
119 | # add local patch information | |
120 | # warn on '-ok' if this is an old system; add '-okay' | |
fb73857a | 121 | # Changed in 1.20 Added patchlevel.h reading and version/config checks |
55d729e4 GS |
122 | # Changed in 1.21 Added '-nok' for reporting build failure DFD 98-05-05 |
123 | # Changed in 1.22 Heavy reformatting & minor bugfixes HVDS 98-05-10 | |
cca87523 | 124 | # Changed in 1.23 Restore -ok(ay): say 'success'; don't prompt |
105f9295 | 125 | # Changed in 1.24 Added '-F<file>' to save report HVDS 98-07-01 |
8b49bb9a | 126 | # Changed in 1.25 Warn on failure to open save file. HVDS 98-07-12 |
eedd3c36 | 127 | # Changed in 1.26 Don't require -t STDIN for -ok. HVDS 98-07-15 |
1948c06a | 128 | # Changed in 1.27 Added Mac OS and File::Spec support CNANDOR 99-07-27 |
50d3c28b | 129 | # Changed in 1.28 Additional questions for Perlbugtron RFOLEY 20.03.2000 |
975b416b | 130 | # Changed in 1.29 Perlbug(tron): auto(-ok), short prompts RFOLEY 05-05-2000 |
b0c10877 | 131 | # Changed in 1.30 Added warnings on failure to open files MSTEVENS 13-07-2000 |
c0a6bf09 | 132 | # Changed in 1.31 Add checks on close().Fix my $var unless. TJENNESS 26-07-2000 |
93b42772 | 133 | # Changed in 1.32 Use File::Spec->tmpdir TJENNESS 20-08-2000 |
489b74f8 | 134 | # Changed in 1.33 Don't require -t STDOUT for -ok. |
de94c9df | 135 | # Changed in 1.34 Added Message-Id RFOLEY 18-06-2002 |
003a92ef | 136 | # Changed in 1.35 Use File::Temp (patch from Solar Designer) NWCLARK 28-02-2004 |
c07a80fd | 137 | |
1b0e3b9e | 138 | # TODO: - Allow the user to re-name the file on mail failure, and |
55d729e4 | 139 | # make sure failure (transmission-wise) of Mail::Send is |
c07a80fd | 140 | # accounted for. |
1b0e3b9e | 141 | # - Test -b option |
37fa004c | 142 | |
de94c9df | 143 | my( $file, $usefile, $cc, $address, $perlbug, $testaddress, $filename, $messageid, $domain, |
7f2de2d2 | 144 | $subject, $from, $verbose, $ed, $outfile, $Is_MacOS, $category, $severity, |
8843dda6 SR |
145 | $fh, $me, $Is_MSWin32, $Is_Linux, $Is_VMS, $msg, $body, $andcc, %REP, $ok, |
146 | $Is_OpenBSD); | |
37fa004c | 147 | |
b22c7a20 | 148 | my $perl_version = $^V ? sprintf("v%vd", $^V) : $]; |
1ec03f31 GS |
149 | |
150 | my $config_tag2 = "$perl_version - $Config{cf_time}"; | |
fb73857a | 151 | |
37fa004c | 152 | Init(); |
153 | ||
55d729e4 GS |
154 | if ($::opt_h) { Help(); exit; } |
155 | if ($::opt_d) { Dump(*STDOUT); exit; } | |
eedd3c36 | 156 | if (!-t STDIN && !($ok and not $::opt_n)) { |
55d729e4 GS |
157 | paraprint <<EOF; |
158 | Please use perlbug interactively. If you want to | |
84478119 | 159 | include a file, you can use the -f switch. |
160 | EOF | |
55d729e4 | 161 | die "\n"; |
84478119 | 162 | } |
c07a80fd | 163 | |
37fa004c | 164 | Query(); |
cca87523 | 165 | Edit() unless $usefile || ($ok and not $::opt_n); |
37fa004c | 166 | NowWhat(); |
167 | Send(); | |
168 | ||
169 | exit; | |
170 | ||
975b416b | 171 | sub ask_for_alternatives { # (category|severity) |
50d3c28b | 172 | my $name = shift; |
975b416b GS |
173 | my %alts = ( |
174 | 'category' => { | |
175 | 'default' => 'core', | |
176 | 'ok' => 'install', | |
177 | 'opts' => [qw(core docs install library utilities)], # patch, notabug | |
178 | }, | |
179 | 'severity' => { | |
180 | 'default' => 'low', | |
181 | 'ok' => 'none', | |
182 | 'opts' => [qw(critical high medium low wishlist none)], # zero | |
7f2de2d2 | 183 | }, |
975b416b | 184 | ); |
7f2de2d2 | 185 | die "Invalid alternative($name) requested\n" unless grep(/^$name$/, keys %alts); |
50d3c28b | 186 | my $alt = ""; |
975b416b GS |
187 | if ($ok) { |
188 | $alt = $alts{$name}{'ok'}; | |
189 | } else { | |
190 | my @alts = @{$alts{$name}{'opts'}}; | |
191 | paraprint <<EOF; | |
50d3c28b GS |
192 | Please pick a \u$name from the following: |
193 | ||
194 | @alts | |
195 | ||
196 | EOF | |
975b416b GS |
197 | my $err = 0; |
198 | do { | |
199 | if ($err++ > 5) { | |
200 | die "Invalid $name: aborting.\n"; | |
201 | } | |
202 | print "Please enter a \u$name [$alts{$name}{'default'}]: "; | |
203 | $alt = <>; | |
204 | chomp $alt; | |
205 | if ($alt =~ /^\s*$/) { | |
206 | $alt = $alts{$name}{'default'}; | |
207 | } | |
208 | } while !((($alt) = grep(/^$alt/i, @alts))); | |
209 | } | |
50d3c28b GS |
210 | lc $alt; |
211 | } | |
212 | ||
37fa004c | 213 | sub Init { |
55d729e4 GS |
214 | # -------- Setup -------- |
215 | ||
216 | $Is_MSWin32 = $^O eq 'MSWin32'; | |
217 | $Is_VMS = $^O eq 'VMS'; | |
afc5e478 | 218 | $Is_Linux = lc($^O) eq 'linux'; |
8843dda6 | 219 | $Is_OpenBSD = lc($^O) eq 'openbsd'; |
1948c06a CN |
220 | $Is_MacOS = $^O eq 'MacOS'; |
221 | ||
222 | @ARGV = split m/\s+/, | |
223 | MacPerl::Ask('Provide command-line args here (-h for help):') | |
224 | if $Is_MacOS && $MacPerl::Version =~ /App/; | |
55d729e4 | 225 | |
890b8eb0 | 226 | if (!getopts("Adhva:s:b:f:F:r:e:SCc:to:n:")) { Help(); exit; }; |
55d729e4 GS |
227 | |
228 | # This comment is needed to notify metaconfig that we are | |
229 | # using the $perladmin, $cf_by, and $cf_time definitions. | |
230 | ||
231 | # -------- Configuration --------- | |
232 | ||
233 | # perlbug address | |
8db473c3 | 234 | $perlbug = 'perlbug@perl.org'; |
55d729e4 GS |
235 | |
236 | # Test address | |
3e79b69b | 237 | $testaddress = 'perlbug-test@perl.org'; |
55d729e4 GS |
238 | |
239 | # Target address | |
240 | $address = $::opt_a || ($::opt_t ? $testaddress : $perlbug); | |
241 | ||
242 | # Users address, used in message and in Reply-To header | |
243 | $from = $::opt_r || ""; | |
244 | ||
245 | # Include verbose configuration information | |
246 | $verbose = $::opt_v || 0; | |
247 | ||
248 | # Subject of bug-report message | |
249 | $subject = $::opt_s || ""; | |
250 | ||
251 | # Send a file | |
252 | $usefile = ($::opt_f || 0); | |
253 | ||
254 | # File to send as report | |
255 | $file = $::opt_f || ""; | |
256 | ||
105f9295 HS |
257 | # File to output to |
258 | $outfile = $::opt_F || ""; | |
259 | ||
55d729e4 GS |
260 | # Body of report |
261 | $body = $::opt_b || ""; | |
de94c9df | 262 | |
55d729e4 GS |
263 | # Editor |
264 | $ed = $::opt_e || $ENV{VISUAL} || $ENV{EDITOR} || $ENV{EDIT} | |
265 | || ($Is_VMS && "edit/tpu") | |
266 | || ($Is_MSWin32 && "notepad") | |
1948c06a | 267 | || ($Is_MacOS && '') |
55d729e4 GS |
268 | || "vi"; |
269 | ||
270 | # Not OK - provide build failure template by finessing OK report | |
271 | if ($::opt_n) { | |
272 | if (substr($::opt_n, 0, 2) eq 'ok' ) { | |
273 | $::opt_o = substr($::opt_n, 1); | |
274 | } else { | |
275 | Help(); | |
276 | exit(); | |
277 | } | |
278 | } | |
279 | ||
280 | # OK - send "OK" report for build on this system | |
281 | $ok = 0; | |
282 | if ($::opt_o) { | |
283 | if ($::opt_o eq 'k' or $::opt_o eq 'kay') { | |
284 | my $age = time - $patchlevel_date; | |
285 | if ($::opt_o eq 'k' and $age > 60 * 24 * 60 * 60 ) { | |
286 | my $date = localtime $patchlevel_date; | |
287 | print <<"EOF"; | |
288 | "perlbug -ok" and "perlbug -nok" do not report on Perl versions which | |
289 | are more than 60 days old. This Perl version was constructed on | |
290 | $date. If you really want to report this, use | |
291 | "perlbug -okay" or "perlbug -nokay". | |
84902520 | 292 | EOF |
1b0e3b9e CR |
293 | exit(); |
294 | } | |
55d729e4 GS |
295 | # force these options |
296 | unless ($::opt_n) { | |
297 | $::opt_S = 1; # don't prompt for send | |
298 | $::opt_b = 1; # we have a body | |
299 | $body = "Perl reported to build OK on this system.\n"; | |
300 | } | |
301 | $::opt_C = 1; # don't send a copy to the local admin | |
302 | $::opt_s = 1; # we have a subject line | |
303 | $subject = ($::opt_n ? 'Not ' : '') | |
1ec03f31 | 304 | . "OK: perl $perl_version ${patch_tags}on" |
55d729e4 GS |
305 | ." $::Config{'archname'} $::Config{'osvers'} $subject"; |
306 | $ok = 1; | |
307 | } else { | |
308 | Help(); | |
309 | exit(); | |
1b0e3b9e | 310 | } |
55d729e4 | 311 | } |
37fa004c | 312 | |
55d729e4 GS |
313 | # Possible administrator addresses, in order of confidence |
314 | # (Note that cf_email is not mentioned to metaconfig, since | |
315 | # we don't really want it. We'll just take it if we have to.) | |
316 | # | |
317 | # This has to be after the $ok stuff above because of the way | |
318 | # that $::opt_C is forced. | |
319 | $cc = $::opt_C ? "" : ( | |
320 | $::opt_c || $::Config{'perladmin'} | |
321 | || $::Config{'cf_email'} || $::Config{'cf_by'} | |
322 | ); | |
323 | ||
de94c9df RF |
324 | if ($::HaveUtil) { |
325 | $domain = Mail::Util::maildomain(); | |
326 | } elsif ($Is_MSWin32) { | |
327 | $domain = $ENV{'USERDOMAIN'}; | |
328 | } else { | |
329 | require Sys::Hostname; | |
330 | $domain = Sys::Hostname::hostname(); | |
331 | } | |
332 | ||
333 | # Message-Id - rjsf | |
334 | $messageid = "<$::Config{'version'}_${$}_".time."\@$domain>"; | |
335 | ||
55d729e4 GS |
336 | # My username |
337 | $me = $Is_MSWin32 ? $ENV{'USERNAME'} | |
338 | : $^O eq 'os2' ? $ENV{'USER'} || $ENV{'LOGNAME'} | |
1948c06a | 339 | : $Is_MacOS ? $ENV{'USER'} |
55d729e4 | 340 | : eval { getpwuid($<) }; # May be missing |
c0830f08 RB |
341 | |
342 | $from = $::Config{'cf_email'} | |
343 | if !$from && $::Config{'cf_email'} && $::Config{'cf_by'} && $me && | |
344 | ($me eq $::Config{'cf_by'}); | |
55d729e4 | 345 | } # sub Init |
37fa004c | 346 | |
347 | sub Query { | |
55d729e4 GS |
348 | # Explain what perlbug is |
349 | unless ($ok) { | |
37fa004c | 350 | paraprint <<EOF; |
8ecf1a0c KA |
351 | This program provides an easy way to create a message reporting a bug |
352 | in perl, and e-mail it to $address. It is *NOT* intended for | |
54310121 | 353 | sending test messages or simply verifying that perl works, *NOR* is it |
354 | intended for reporting bugs in third-party perl modules. It is *ONLY* | |
355 | a means of reporting verifiable problems with the core perl distribution, | |
356 | and any solutions to such problems, to the people who maintain perl. | |
357 | ||
358 | If you're just looking for help with perl, try posting to the Usenet | |
359 | newsgroup comp.lang.perl.misc. If you're looking for help with using | |
360 | perl with CGI, try posting to comp.infosystems.www.programming.cgi. | |
37fa004c | 361 | EOF |
1b0e3b9e | 362 | } |
37fa004c | 363 | |
55d729e4 | 364 | # Prompt for subject of message, if needed |
2e7f46bf JH |
365 | |
366 | if (TrivialSubject($subject)) { | |
367 | $subject = ''; | |
368 | } | |
369 | ||
55d729e4 GS |
370 | unless ($subject) { |
371 | paraprint <<EOF; | |
372 | First of all, please provide a subject for the | |
373 | message. It should be a concise description of | |
774d564b | 374 | the bug or problem. "perl bug" or "perl problem" |
375 | is not a concise description. | |
37fa004c | 376 | EOF |
55d729e4 GS |
377 | |
378 | my $err = 0; | |
2e7f46bf JH |
379 | do { |
380 | print "Subject: "; | |
55d729e4 | 381 | $subject = <>; |
2e7f46bf JH |
382 | chomp $subject; |
383 | if ($err++ == 5) { | |
55d729e4 GS |
384 | die "Aborting.\n"; |
385 | } | |
2e7f46bf | 386 | } while (TrivialSubject($subject)); |
55d729e4 GS |
387 | } |
388 | ||
389 | # Prompt for return address, if needed | |
390 | unless ($from) { | |
391 | # Try and guess return address | |
392 | my $guess; | |
393 | ||
394 | $guess = $ENV{'REPLY-TO'} || $ENV{'REPLYTO'} || ''; | |
1948c06a CN |
395 | if ($Is_MacOS) { |
396 | require Mac::InternetConfig; | |
397 | $guess = $Mac::InternetConfig::InternetConfig{ | |
398 | Mac::InternetConfig::kICEmail() | |
399 | }; | |
400 | } | |
401 | ||
55d729e4 | 402 | unless ($guess) { |
de94c9df RF |
403 | # move $domain to where we can use it elsewhere |
404 | if ($domain) { | |
55d729e4 GS |
405 | if ($Is_VMS && !$::Config{'d_socket'}) { |
406 | $guess = "$domain\:\:$me"; | |
41f926b8 | 407 | } else { |
55d729e4 | 408 | $guess = "$me\@$domain" if $domain; |
c07a80fd | 409 | } |
55d729e4 GS |
410 | } |
411 | } | |
37fa004c | 412 | |
55d729e4 GS |
413 | if ($guess) { |
414 | unless ($ok) { | |
415 | paraprint <<EOF; | |
a5f75d66 AD |
416 | Your e-mail address will be useful if you need to be contacted. If the |
417 | default shown is not your full internet e-mail address, please correct it. | |
37fa004c | 418 | EOF |
55d729e4 GS |
419 | } |
420 | } else { | |
421 | paraprint <<EOF; | |
422 | So that you may be contacted if necessary, please enter | |
a5f75d66 | 423 | your full internet e-mail address here. |
37fa004c | 424 | EOF |
37fa004c | 425 | } |
37fa004c | 426 | |
55d729e4 GS |
427 | if ($ok && $guess) { |
428 | # use it | |
429 | $from = $guess; | |
430 | } else { | |
431 | # verify it | |
432 | print "Your address [$guess]: "; | |
433 | $from = <>; | |
2e7f46bf | 434 | chomp $from; |
55d729e4 GS |
435 | $from = $guess if $from eq ''; |
436 | } | |
437 | } | |
37fa004c | 438 | |
55d729e4 GS |
439 | if ($from eq $cc or $me eq $cc) { |
440 | # Try not to copy ourselves | |
441 | $cc = "yourself"; | |
442 | } | |
37fa004c | 443 | |
55d729e4 GS |
444 | # Prompt for administrator address, unless an override was given |
445 | if( !$::opt_C and !$::opt_c ) { | |
446 | paraprint <<EOF; | |
37fa004c | 447 | A copy of this report can be sent to your local |
55d729e4 | 448 | perl administrator. If the address is wrong, please |
c07a80fd | 449 | correct it, or enter 'none' or 'yourself' to not send |
450 | a copy. | |
37fa004c | 451 | EOF |
55d729e4 GS |
452 | print "Local perl administrator [$cc]: "; |
453 | my $entry = scalar <>; | |
2e7f46bf | 454 | chomp $entry; |
37fa004c | 455 | |
55d729e4 GS |
456 | if ($entry ne "") { |
457 | $cc = $entry; | |
458 | $cc = '' if $me eq $cc; | |
37fa004c | 459 | } |
55d729e4 | 460 | } |
37fa004c | 461 | |
55d729e4 GS |
462 | $cc = '' if $cc =~ /^(none|yourself|me|myself|ourselves)$/i; |
463 | $andcc = " and $cc" if $cc; | |
37fa004c | 464 | |
55d729e4 | 465 | # Prompt for editor, if no override is given |
ab3ef367 | 466 | editor: |
55d729e4 GS |
467 | unless ($::opt_e || $::opt_f || $::opt_b) { |
468 | paraprint <<EOF; | |
c07a80fd | 469 | Now you need to supply the bug report. Try to make |
55d729e4 | 470 | the report concise but descriptive. Include any |
ab3ef367 | 471 | relevant detail. If you are reporting something |
472 | that does not work as you think it should, please | |
55d729e4 | 473 | try to include example of both the actual |
ab3ef367 | 474 | result, and what you expected. |
475 | ||
476 | Some information about your local | |
55d729e4 | 477 | perl configuration will automatically be included |
ab3ef367 | 478 | at the end of the report. If you are using any |
479 | unusual version of perl, please try and confirm | |
480 | exactly which versions are relevant. | |
37fa004c | 481 | |
482 | You will probably want to use an editor to enter | |
483 | the report. If "$ed" is the editor you want | |
484 | to use, then just press Enter, otherwise type in | |
485 | the name of the editor you would like to use. | |
486 | ||
c07a80fd | 487 | If you would like to use a prepared file, type |
37fa004c | 488 | "file", and you will be asked for the filename. |
37fa004c | 489 | EOF |
55d729e4 GS |
490 | print "Editor [$ed]: "; |
491 | my $entry =scalar <>; | |
2e7f46bf | 492 | chomp $entry; |
55d729e4 GS |
493 | |
494 | $usefile = 0; | |
495 | if ($entry eq "file") { | |
496 | $usefile = 1; | |
497 | } elsif ($entry ne "") { | |
498 | $ed = $entry; | |
37fa004c | 499 | } |
55d729e4 | 500 | } |
37fa004c | 501 | |
50d3c28b | 502 | # Prompt for category of bug |
975b416b | 503 | $category ||= ask_for_alternatives('category'); |
50d3c28b GS |
504 | |
505 | # Prompt for severity of bug | |
975b416b | 506 | $severity ||= ask_for_alternatives('severity'); |
50d3c28b | 507 | |
55d729e4 GS |
508 | # Generate scratch file to edit report in |
509 | $filename = filename(); | |
37fa004c | 510 | |
55d729e4 GS |
511 | # Prompt for file to read report from, if needed |
512 | if ($usefile and !$file) { | |
ab3ef367 | 513 | filename: |
55d729e4 | 514 | paraprint <<EOF; |
37fa004c | 515 | What is the name of the file that contains your report? |
37fa004c | 516 | EOF |
55d729e4 GS |
517 | print "Filename: "; |
518 | my $entry = scalar <>; | |
2e7f46bf | 519 | chomp $entry; |
37fa004c | 520 | |
55d729e4 GS |
521 | if ($entry eq "") { |
522 | paraprint <<EOF; | |
523 | No filename? I'll let you go back and choose an editor again. | |
ab3ef367 | 524 | EOF |
55d729e4 GS |
525 | goto editor; |
526 | } | |
527 | ||
528 | unless (-f $entry and -r $entry) { | |
529 | paraprint <<EOF; | |
ab3ef367 | 530 | I'm sorry, but I can't read from `$entry'. Maybe you mistyped the name of |
531 | the file? If you don't want to send a file, just enter a blank line and you | |
532 | can get back to the editor selection. | |
ab3ef367 | 533 | EOF |
55d729e4 | 534 | goto filename; |
37fa004c | 535 | } |
55d729e4 GS |
536 | $file = $entry; |
537 | } | |
37fa004c | 538 | |
55d729e4 | 539 | # Generate report |
b0c10877 | 540 | open(REP,">$filename") or die "Unable to create report file `$filename': $!\n"; |
cca87523 | 541 | my $reptype = !$ok ? "bug" : $::opt_n ? "build failure" : "success"; |
37fa004c | 542 | |
55d729e4 | 543 | print REP <<EOF; |
84902520 | 544 | This is a $reptype report for perl from $from, |
1ec03f31 | 545 | generated with the help of perlbug $Version running under perl $perl_version. |
37fa004c | 546 | |
547 | EOF | |
548 | ||
55d729e4 GS |
549 | if ($body) { |
550 | print REP $body; | |
551 | } elsif ($usefile) { | |
552 | open(F, "<$file") | |
553 | or die "Unable to read report file from `$file': $!\n"; | |
554 | while (<F>) { | |
555 | print REP $_ | |
556 | } | |
c0a6bf09 | 557 | close(F) or die "Error closing `$file': $!"; |
55d729e4 GS |
558 | } else { |
559 | print REP <<EOF; | |
774d564b | 560 | |
561 | ----------------------------------------------------------------- | |
562 | [Please enter your report here] | |
563 | ||
564 | ||
565 | ||
566 | [Please do not change anything below this line] | |
567 | ----------------------------------------------------------------- | |
568 | EOF | |
55d729e4 GS |
569 | } |
570 | Dump(*REP); | |
c0a6bf09 | 571 | close(REP) or die "Error closing report file: $!"; |
55d729e4 GS |
572 | |
573 | # read in the report template once so that | |
574 | # we can track whether the user does any editing. | |
575 | # yes, *all* whitespace is ignored. | |
b0c10877 | 576 | open(REP, "<$filename") or die "Unable to open report file `$filename': $!\n"; |
55d729e4 GS |
577 | while (<REP>) { |
578 | s/\s+//g; | |
579 | $REP{$_}++; | |
580 | } | |
c0a6bf09 | 581 | close(REP) or die "Error closing report file `$filename': $!"; |
55d729e4 | 582 | } # sub Query |
c07a80fd | 583 | |
584 | sub Dump { | |
55d729e4 | 585 | local(*OUT) = @_; |
37fa004c | 586 | |
50d3c28b GS |
587 | print OUT <<EFF; |
588 | --- | |
589 | Flags: | |
590 | category=$category | |
591 | severity=$severity | |
890b8eb0 NC |
592 | EFF |
593 | if ($::opt_A) { | |
594 | print OUT <<EFF; | |
595 | ack=no | |
596 | EFF | |
597 | } | |
598 | print OUT <<EFF; | |
50d3c28b GS |
599 | --- |
600 | EFF | |
601 | print OUT "This perlbug was built using Perl $config_tag1\n", | |
1ec03f31 | 602 | "It is being executed now by Perl $config_tag2.\n\n" |
55d729e4 | 603 | if $config_tag2 ne $config_tag1; |
fb73857a | 604 | |
55d729e4 | 605 | print OUT <<EOF; |
1ec03f31 | 606 | Site configuration information for perl $perl_version: |
37fa004c | 607 | |
608 | EOF | |
55d729e4 GS |
609 | if ($::Config{cf_by} and $::Config{cf_time}) { |
610 | print OUT "Configured by $::Config{cf_by} at $::Config{cf_time}.\n\n"; | |
611 | } | |
612 | print OUT Config::myconfig; | |
37fa004c | 613 | |
55d729e4 GS |
614 | if (@patches) { |
615 | print OUT join "\n ", "Locally applied patches:", @patches; | |
616 | print OUT "\n"; | |
617 | }; | |
84902520 | 618 | |
55d729e4 | 619 | print OUT <<EOF; |
8ecf1a0c | 620 | |
774d564b | 621 | --- |
1ec03f31 | 622 | \@INC for perl $perl_version: |
774d564b | 623 | EOF |
55d729e4 GS |
624 | for my $i (@INC) { |
625 | print OUT " $i\n"; | |
626 | } | |
774d564b | 627 | |
55d729e4 | 628 | print OUT <<EOF; |
8ecf1a0c | 629 | |
774d564b | 630 | --- |
1ec03f31 | 631 | Environment for perl $perl_version: |
8ecf1a0c | 632 | EOF |
5cf1d1f1 JH |
633 | my @env = |
634 | qw(PATH LD_LIBRARY_PATH LANG PERL_BADLANG SHELL HOME LOGDIR LANGUAGE); | |
635 | push @env, $Config{ldlibpthname} if $Config{ldlibpthname} ne ''; | |
27414c22 | 636 | push @env, grep /^(?:PERL|LC_|LANG|CYGWIN)/, keys %ENV; |
8876aa85 JH |
637 | my %env; |
638 | @env{@env} = @env; | |
639 | for my $env (sort keys %env) { | |
55d729e4 GS |
640 | print OUT " $env", |
641 | exists $ENV{$env} ? "=$ENV{$env}" : ' (unset)', | |
642 | "\n"; | |
643 | } | |
644 | if ($verbose) { | |
1ec03f31 | 645 | print OUT "\nComplete configuration data for perl $perl_version:\n\n"; |
55d729e4 GS |
646 | my $value; |
647 | foreach (sort keys %::Config) { | |
648 | $value = $::Config{$_}; | |
649 | $value =~ s/'/\\'/g; | |
650 | print OUT "$_='$value'\n"; | |
84902520 | 651 | } |
55d729e4 GS |
652 | } |
653 | } # sub Dump | |
37fa004c | 654 | |
655 | sub Edit { | |
55d729e4 GS |
656 | # Edit the report |
657 | if ($usefile || $body) { | |
658 | paraprint <<EOF; | |
ab3ef367 | 659 | Please make sure that the name of the editor you want to use is correct. |
ab3ef367 | 660 | EOF |
55d729e4 GS |
661 | print "Editor [$ed]: "; |
662 | my $entry =scalar <>; | |
2e7f46bf | 663 | chomp $entry; |
55d729e4 GS |
664 | $ed = $entry unless $entry eq ''; |
665 | } | |
a5f75d66 | 666 | |
55d729e4 | 667 | tryagain: |
c0a6bf09 TJ |
668 | my $sts; |
669 | $sts = system("$ed $filename") unless $Is_MacOS; | |
1948c06a CN |
670 | if ($Is_MacOS) { |
671 | require ExtUtils::MakeMaker; | |
672 | ExtUtils::MM_MacOS::launch_file($filename); | |
673 | paraprint <<EOF; | |
674 | Press Enter when done. | |
675 | EOF | |
676 | scalar <>; | |
677 | } | |
55d729e4 GS |
678 | if ($sts) { |
679 | paraprint <<EOF; | |
a5f75d66 AD |
680 | The editor you chose (`$ed') could apparently not be run! |
681 | Did you mistype the name of your editor? If so, please | |
55d729e4 | 682 | correct it here, otherwise just press Enter. |
a5f75d66 | 683 | EOF |
55d729e4 GS |
684 | print "Editor [$ed]: "; |
685 | my $entry =scalar <>; | |
2e7f46bf | 686 | chomp $entry; |
a5f75d66 | 687 | |
55d729e4 GS |
688 | if ($entry ne "") { |
689 | $ed = $entry; | |
690 | goto tryagain; | |
691 | } else { | |
692 | paraprint <<EOF; | |
a5f75d66 AD |
693 | You may want to save your report to a file, so you can edit and mail it |
694 | yourself. | |
695 | EOF | |
774d564b | 696 | } |
55d729e4 | 697 | } |
774d564b | 698 | |
55d729e4 GS |
699 | return if ($ok and not $::opt_n) || $body; |
700 | # Check that we have a report that has some, eh, report in it. | |
701 | my $unseen = 0; | |
702 | ||
b0c10877 | 703 | open(REP, "<$filename") or die "Couldn't open `$filename': $!\n"; |
55d729e4 GS |
704 | # a strange way to check whether any significant editing |
705 | # have been done: check whether any new non-empty lines | |
706 | # have been added. Yes, the below code ignores *any* space | |
707 | # in *any* line. | |
708 | while (<REP>) { | |
709 | s/\s+//g; | |
710 | $unseen++ if $_ ne '' and not exists $REP{$_}; | |
711 | } | |
774d564b | 712 | |
55d729e4 GS |
713 | while ($unseen == 0) { |
714 | paraprint <<EOF; | |
774d564b | 715 | I am sorry but it looks like you did not report anything. |
774d564b | 716 | EOF |
55d729e4 GS |
717 | print "Action (Retry Edit/Cancel) "; |
718 | my ($action) = scalar(<>); | |
719 | if ($action =~ /^[re]/i) { # <R>etry <E>dit | |
720 | goto tryagain; | |
721 | } elsif ($action =~ /^[cq]/i) { # <C>ancel, <Q>uit | |
722 | Cancel(); | |
723 | } | |
724 | } | |
725 | } # sub Edit | |
774d564b | 726 | |
727 | sub Cancel { | |
728 | 1 while unlink($filename); # remove all versions under VMS | |
729 | print "\nCancelling.\n"; | |
730 | exit(0); | |
37fa004c | 731 | } |
732 | ||
733 | sub NowWhat { | |
55d729e4 GS |
734 | # Report is done, prompt for further action |
735 | if( !$::opt_S ) { | |
736 | while(1) { | |
737 | paraprint <<EOF; | |
738 | Now that you have completed your report, would you like to send | |
739 | the message to $address$andcc, display the message on | |
2e7f46bf JH |
740 | the screen, re-edit it, display/change the subject, |
741 | or cancel without sending anything? | |
37fa004c | 742 | You may also save the message as a file to mail at another time. |
37fa004c | 743 | EOF |
8b49bb9a | 744 | retry: |
2e7f46bf | 745 | print "Action (Send/Display/Edit/Subject/Save to File): "; |
55d729e4 | 746 | my $action = scalar <>; |
2e7f46bf | 747 | chomp $action; |
55d729e4 GS |
748 | |
749 | if ($action =~ /^(f|sa)/i) { # <F>ile/<Sa>ve | |
fd49642c PP |
750 | my $file_save = $outfile || "perlbug.rep"; |
751 | print "\n\nName of file to save message in [$file_save]: "; | |
55d729e4 | 752 | my $file = scalar <>; |
2e7f46bf | 753 | chomp $file; |
fd49642c | 754 | $file = $file_save if $file eq ""; |
55d729e4 | 755 | |
8b49bb9a HS |
756 | unless (open(FILE, ">$file")) { |
757 | print "\nError opening $file: $!\n\n"; | |
758 | goto retry; | |
759 | } | |
b0c10877 | 760 | open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n"; |
55d729e4 GS |
761 | print FILE "To: $address\nSubject: $subject\n"; |
762 | print FILE "Cc: $cc\n" if $cc; | |
763 | print FILE "Reply-To: $from\n" if $from; | |
de94c9df | 764 | print FILE "Message-Id: $messageid\n" if $messageid; |
55d729e4 GS |
765 | print FILE "\n"; |
766 | while (<REP>) { print FILE } | |
c0a6bf09 TJ |
767 | close(REP) or die "Error closing report file `$filename': $!"; |
768 | close(FILE) or die "Error closing $file: $!"; | |
55d729e4 GS |
769 | |
770 | print "\nMessage saved in `$file'.\n"; | |
771 | exit; | |
772 | } elsif ($action =~ /^(d|l|sh)/i ) { # <D>isplay, <L>ist, <Sh>ow | |
773 | # Display the message | |
b0c10877 | 774 | open(REP, "<$filename") or die "Couldn't open file `$filename': $!\n"; |
55d729e4 | 775 | while (<REP>) { print $_ } |
c0a6bf09 | 776 | close(REP) or die "Error closing report file `$filename': $!"; |
2e7f46bf JH |
777 | } elsif ($action =~ /^su/i) { # <Su>bject |
778 | print "Subject: $subject\n"; | |
779 | print "If the above subject is fine, just press Enter.\n"; | |
780 | print "If not, type in the new subject.\n"; | |
781 | print "Subject: "; | |
782 | my $reply = scalar <STDIN>; | |
783 | chomp $reply; | |
784 | if ($reply ne '') { | |
785 | unless (TrivialSubject($reply)) { | |
786 | $subject = $reply; | |
787 | print "Subject: $subject\n"; | |
788 | } | |
789 | } | |
55d729e4 GS |
790 | } elsif ($action =~ /^se/i) { # <S>end |
791 | # Send the message | |
792 | print "Are you certain you want to send this message?\n" | |
793 | . 'Please type "yes" if you are: '; | |
794 | my $reply = scalar <STDIN>; | |
2e7f46bf | 795 | chomp $reply; |
55d729e4 GS |
796 | if ($reply eq "yes") { |
797 | last; | |
798 | } else { | |
799 | paraprint <<EOF; | |
ab3ef367 | 800 | That wasn't a clear "yes", so I won't send your message. If you are sure |
801 | your message should be sent, type in "yes" (without the quotes) at the | |
802 | confirmation prompt. | |
ab3ef367 | 803 | EOF |
55d729e4 GS |
804 | } |
805 | } elsif ($action =~ /^[er]/i) { # <E>dit, <R>e-edit | |
806 | # edit the message | |
807 | Edit(); | |
808 | } elsif ($action =~ /^[qc]/i) { # <C>ancel, <Q>uit | |
809 | Cancel(); | |
01544859 | 810 | } elsif ($action =~ /^s/i) { |
55d729e4 | 811 | paraprint <<EOF; |
84478119 | 812 | I'm sorry, but I didn't understand that. Please type "send" or "save". |
813 | EOF | |
55d729e4 | 814 | } |
37fa004c | 815 | } |
55d729e4 GS |
816 | } |
817 | } # sub NowWhat | |
37fa004c | 818 | |
2e7f46bf JH |
819 | sub TrivialSubject { |
820 | my $subject = shift; | |
821 | if ($subject =~ | |
822 | /^(y(es)?|no?|help|perl( (bug|problem))?|bug|problem)$/i || | |
823 | length($subject) < 4 || | |
824 | $subject !~ /\s/) { | |
825 | print "\nThat doesn't look like a good subject. Please be more verbose.\n\n"; | |
826 | return 1; | |
827 | } else { | |
828 | return 0; | |
829 | } | |
830 | } | |
831 | ||
37fa004c | 832 | sub Send { |
55d729e4 | 833 | # Message has been accepted for transmission -- Send the message |
105f9295 HS |
834 | if ($outfile) { |
835 | open SENDMAIL, ">$outfile" or die "Couldn't open '$outfile': $!\n"; | |
836 | goto sendout; | |
837 | } | |
afc5e478 SB |
838 | |
839 | # on linux certain mail implementations won't accept the subject | |
840 | # as "~s subject" and thus the Subject header will be corrupted | |
841 | # so don't use Mail::Send to be safe | |
8843dda6 | 842 | if ($::HaveSend && !$Is_Linux && !$Is_OpenBSD) { |
55d729e4 GS |
843 | $msg = new Mail::Send Subject => $subject, To => $address; |
844 | $msg->cc($cc) if $cc; | |
845 | $msg->add("Reply-To",$from) if $from; | |
846 | ||
847 | $fh = $msg->open; | |
b0c10877 | 848 | open(REP, "<$filename") or die "Couldn't open `$filename': $!\n"; |
55d729e4 | 849 | while (<REP>) { print $fh $_ } |
c0a6bf09 | 850 | close(REP) or die "Error closing $filename: $!"; |
55d729e4 GS |
851 | $fh->close; |
852 | ||
853 | print "\nMessage sent.\n"; | |
854 | } elsif ($Is_VMS) { | |
855 | if ( ($address =~ /@/ and $address !~ /^\w+%"/) or | |
856 | ($cc =~ /@/ and $cc !~ /^\w+%"/) ) { | |
857 | my $prefix; | |
858 | foreach (qw[ IN MX SMTP UCX PONY WINS ], '') { | |
859 | $prefix = "$_%", last if $ENV{"MAIL\$PROTOCOL_$_"}; | |
860 | } | |
861 | $address = qq[${prefix}"$address"] unless $address =~ /^\w+%"/; | |
862 | $cc = qq[${prefix}"$cc"] unless !$cc || $cc =~ /^\w+%"/; | |
863 | } | |
864 | $subject =~ s/"/""/g; $address =~ s/"/""/g; $cc =~ s/"/""/g; | |
865 | my $sts = system(qq[mail/Subject="$subject" $filename. "$address","$cc"]); | |
866 | if ($sts) { | |
867 | die <<EOF; | |
868 | Can't spawn off mail | |
869 | (leaving bug report in $filename): $sts | |
870 | EOF | |
871 | } | |
872 | } else { | |
873 | my $sendmail = ""; | |
874 | for (qw(/usr/lib/sendmail /usr/sbin/sendmail /usr/ucblib/sendmail)) { | |
875 | $sendmail = $_, last if -e $_; | |
876 | } | |
877 | if ($^O eq 'os2' and $sendmail eq "") { | |
878 | my $path = $ENV{PATH}; | |
879 | $path =~ s:\\:/: ; | |
880 | my @path = split /$Config{'path_sep'}/, $path; | |
881 | for (@path) { | |
882 | $sendmail = "$_/sendmail", last if -e "$_/sendmail"; | |
883 | $sendmail = "$_/sendmail.exe", last if -e "$_/sendmail.exe"; | |
884 | } | |
885 | } | |
37fa004c | 886 | |
55d729e4 | 887 | paraprint(<<"EOF"), die "\n" if $sendmail eq ""; |
c07a80fd | 888 | I am terribly sorry, but I cannot find sendmail, or a close equivalent, and |
889 | the perl package Mail::Send has not been installed, so I can't send your bug | |
d121ca8c | 890 | report. We apologize for the inconvenience. |
c07a80fd | 891 | |
892 | So you may attempt to find some way of sending your message, it has | |
893 | been left in the file `$filename'. | |
c07a80fd | 894 | EOF |
01544859 | 895 | open(SENDMAIL, "|$sendmail -t -oi") || die "'|$sendmail -t -oi' failed: $!"; |
105f9295 | 896 | sendout: |
55d729e4 GS |
897 | print SENDMAIL "To: $address\n"; |
898 | print SENDMAIL "Subject: $subject\n"; | |
899 | print SENDMAIL "Cc: $cc\n" if $cc; | |
900 | print SENDMAIL "Reply-To: $from\n" if $from; | |
de94c9df | 901 | print SENDMAIL "Message-Id: $messageid\n" if $messageid; |
55d729e4 | 902 | print SENDMAIL "\n\n"; |
b0c10877 | 903 | open(REP, "<$filename") or die "Couldn't open `$filename': $!\n"; |
55d729e4 | 904 | while (<REP>) { print SENDMAIL $_ } |
c0a6bf09 | 905 | close(REP) or die "Error closing $filename: $!"; |
37fa004c | 906 | |
55d729e4 | 907 | if (close(SENDMAIL)) { |
105f9295 | 908 | printf "\nMessage %s.\n", $outfile ? "saved" : "sent"; |
55d729e4 GS |
909 | } else { |
910 | warn "\nSendmail returned status '", $? >> 8, "'\n"; | |
911 | } | |
912 | } | |
913 | 1 while unlink($filename); # remove all versions under VMS | |
914 | } # sub Send | |
37fa004c | 915 | |
916 | sub Help { | |
55d729e4 | 917 | print <<EOF; |
37fa004c | 918 | |
55d729e4 | 919 | A program to help generate bug reports about perl5, and mail them. |
37fa004c | 920 | It is designed to be used interactively. Normally no arguments will |
921 | be needed. | |
55d729e4 | 922 | |
37fa004c | 923 | Usage: |
105f9295 | 924 | $0 [-v] [-a address] [-s subject] [-b body | -f inpufile ] [ -F outputfile ] |
d121ca8c | 925 | [-r returnaddress] [-e editor] [-c adminaddress | -C] [-S] [-t] [-h] |
890b8eb0 | 926 | $0 [-v] [-r returnaddress] [-A] [-ok | -okay | -nok | -nokay] |
55d729e4 | 927 | |
c07a80fd | 928 | Simplest usage: run "$0", and follow the prompts. |
37fa004c | 929 | |
930 | Options: | |
931 | ||
932 | -v Include Verbose configuration data in the report | |
55d729e4 | 933 | -f File containing the body of the report. Use this to |
37fa004c | 934 | quickly send a prepared message. |
1948c06a | 935 | -F File to output the resulting mail message to, instead of mailing. |
37fa004c | 936 | -S Send without asking for confirmation. |
937 | -a Address to send the report to. Defaults to `$address'. | |
938 | -c Address to send copy of report to. Defaults to `$cc'. | |
939 | -C Don't send copy to administrator. | |
55d729e4 | 940 | -s Subject to include with the message. You will be prompted |
37fa004c | 941 | if you don't supply one on the command line. |
942 | -b Body of the report. If not included on the command line, or | |
943 | in a file with -f, you will get a chance to edit the message. | |
944 | -r Your return address. The program will ask you to confirm | |
945 | this if you don't give it here. | |
55d729e4 | 946 | -e Editor to use. |
37fa004c | 947 | -t Test mode. The target address defaults to `$testaddress'. |
489b74f8 | 948 | -d Data mode. This prints out your configuration data, without mailing |
c07a80fd | 949 | anything. You can use this with -v to get more complete data. |
890b8eb0 | 950 | -A Don't send a bug received acknowledgement to the return address. |
84902520 | 951 | -ok Report successful build on this system to perl porters |
55d729e4 GS |
952 | (use alone or with -v). Only use -ok if *everything* was ok: |
953 | if there were *any* problems at all, use -nok. | |
fb73857a | 954 | -okay As -ok but allow report from old builds. |
55d729e4 GS |
955 | -nok Report unsuccessful build on this system to perl porters |
956 | (use alone or with -v). You must describe what went wrong | |
957 | in the body of the report which you will be asked to edit. | |
958 | -nokay As -nok but allow report from old builds. | |
959 | -h Print this help message. | |
960 | ||
37fa004c | 961 | EOF |
962 | } | |
963 | ||
55d729e4 | 964 | sub filename { |
003a92ef NC |
965 | if ($::HaveTemp) { |
966 | # Good. Use a secure temp file | |
967 | my ($fh, $filename) = File::Temp::tempfile(UNLINK => 1); | |
968 | close($fh); | |
969 | return $filename; | |
970 | } else { | |
971 | # Bah. Fall back to doing things less securely. | |
972 | my $dir = File::Spec->tmpdir(); | |
973 | $filename = "bugrep0$$"; | |
974 | $filename++ while -e File::Spec->catfile($dir, $filename); | |
975 | $filename = File::Spec->catfile($dir, $filename); | |
976 | } | |
55d729e4 GS |
977 | } |
978 | ||
37fa004c | 979 | sub paraprint { |
980 | my @paragraphs = split /\n{2,}/, "@_"; | |
c07a80fd | 981 | print "\n\n"; |
37fa004c | 982 | for (@paragraphs) { # implicit local $_ |
55d729e4 GS |
983 | s/(\S)\s*\n/$1 /g; |
984 | write; | |
985 | print "\n"; | |
37fa004c | 986 | } |
37fa004c | 987 | } |
37fa004c | 988 | |
989 | format STDOUT = | |
990 | ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< ~~ | |
991 | $_ | |
992 | . | |
d121ca8c CS |
993 | |
994 | __END__ | |
995 | ||
996 | =head1 NAME | |
997 | ||
998 | perlbug - how to submit bug reports on Perl | |
999 | ||
1000 | =head1 SYNOPSIS | |
1001 | ||
1002 | B<perlbug> S<[ B<-v> ]> S<[ B<-a> I<address> ]> S<[ B<-s> I<subject> ]> | |
105f9295 HS |
1003 | S<[ B<-b> I<body> | B<-f> I<inputfile> ]> S<[ B<-F> I<outputfile> ]> |
1004 | S<[ B<-r> I<returnaddress> ]> | |
d121ca8c | 1005 | S<[ B<-e> I<editor> ]> S<[ B<-c> I<adminaddress> | B<-C> ]> |
890b8eb0 | 1006 | S<[ B<-S> ]> S<[ B<-t> ]> S<[ B<-d> ]> S<[ B<-A> ]> S<[ B<-h> ]> |
d121ca8c | 1007 | |
55d729e4 | 1008 | B<perlbug> S<[ B<-v> ]> S<[ B<-r> I<returnaddress> ]> |
890b8eb0 | 1009 | S<[ B<-A> ]> S<[ B<-ok> | B<-okay> | B<-nok> | B<-nokay> ]> |
1b0e3b9e | 1010 | |
d121ca8c CS |
1011 | =head1 DESCRIPTION |
1012 | ||
1013 | A program to help generate bug reports about perl or the modules that | |
55d729e4 | 1014 | come with it, and mail them. |
d121ca8c CS |
1015 | |
1016 | If you have found a bug with a non-standard port (one that was not part | |
1017 | of the I<standard distribution>), a binary distribution, or a | |
1018 | non-standard module (such as Tk, CGI, etc), then please see the | |
1019 | documentation that came with that distribution to determine the correct | |
1020 | place to report bugs. | |
1021 | ||
1022 | C<perlbug> is designed to be used interactively. Normally no arguments | |
1023 | will be needed. Simply run it, and follow the prompts. | |
1024 | ||
1025 | If you are unable to run B<perlbug> (most likely because you don't have | |
1026 | a working setup to send mail that perlbug recognizes), you may have to | |
7f2de2d2 | 1027 | compose your own report, and email it to B<perlbug@perl.org>. You might |
d121ca8c CS |
1028 | find the B<-d> option useful to get summary information in that case. |
1029 | ||
1030 | In any case, when reporting a bug, please make sure you have run through | |
1031 | this checklist: | |
1032 | ||
1033 | =over 4 | |
1034 | ||
884baa66 | 1035 | =item What version of Perl you are running? |
d121ca8c CS |
1036 | |
1037 | Type C<perl -v> at the command line to find out. | |
1038 | ||
1039 | =item Are you running the latest released version of perl? | |
1040 | ||
1041 | Look at http://www.perl.com/ to find out. If it is not the latest | |
1042 | released version, get that one and see whether your bug has been | |
884baa66 | 1043 | fixed. Note that bug reports about old versions of Perl, especially |
d121ca8c CS |
1044 | those prior to the 5.0 release, are likely to fall upon deaf ears. |
1045 | You are on your own if you continue to use perl1 .. perl4. | |
1046 | ||
1047 | =item Are you sure what you have is a bug? | |
1048 | ||
1049 | A significant number of the bug reports we get turn out to be documented | |
884baa66 | 1050 | features in Perl. Make sure the behavior you are witnessing doesn't fall |
d121ca8c | 1051 | under that category, by glancing through the documentation that comes |
884baa66 | 1052 | with Perl (we'll admit this is no mean task, given the sheer volume of |
d121ca8c CS |
1053 | it all, but at least have a look at the sections that I<seem> relevant). |
1054 | ||
1055 | Be aware of the familiar traps that perl programmers of various hues | |
1056 | fall into. See L<perltrap>. | |
1057 | ||
f27fa58d MG |
1058 | Check in L<perldiag> to see what any Perl error message(s) mean. |
1059 | If message isn't in perldiag, it probably isn't generated by Perl. | |
1060 | Consult your operating system documentation instead. | |
bdcdfa19 | 1061 | |
1948c06a CN |
1062 | If you are on a non-UNIX platform check also L<perlport>, as some |
1063 | features may be unimplemented or work differently. | |
bdcdfa19 | 1064 | |
884baa66 | 1065 | Try to study the problem under the Perl debugger, if necessary. |
d121ca8c CS |
1066 | See L<perldebug>. |
1067 | ||
1068 | =item Do you have a proper test case? | |
1069 | ||
1070 | The easier it is to reproduce your bug, the more likely it will be | |
1071 | fixed, because if no one can duplicate the problem, no one can fix it. | |
1072 | A good test case has most of these attributes: fewest possible number | |
1073 | of lines; few dependencies on external commands, modules, or | |
1074 | libraries; runs on most platforms unimpeded; and is self-documenting. | |
1075 | ||
1076 | A good test case is almost always a good candidate to be on the perl | |
1077 | test suite. If you have the time, consider making your test case so | |
1078 | that it will readily fit into the standard test suite. | |
1079 | ||
bdcdfa19 JH |
1080 | Remember also to include the B<exact> error messages, if any. |
1081 | "Perl complained something" is not an exact error message. | |
1082 | ||
1083 | If you get a core dump (or equivalent), you may use a debugger | |
1084 | (B<dbx>, B<gdb>, etc) to produce a stack trace to include in the bug | |
1085 | report. NOTE: unless your Perl has been compiled with debug info | |
1086 | (often B<-g>), the stack trace is likely to be somewhat hard to use | |
884baa66 | 1087 | because it will most probably contain only the function names and not |
bdcdfa19 JH |
1088 | their arguments. If possible, recompile your Perl with debug info and |
1089 | reproduce the dump and the stack trace. | |
1090 | ||
d121ca8c CS |
1091 | =item Can you describe the bug in plain English? |
1092 | ||
1093 | The easier it is to understand a reproducible bug, the more likely it | |
1094 | will be fixed. Anything you can provide by way of insight into the | |
884baa66 JH |
1095 | problem helps a great deal. In other words, try to analyze the |
1096 | problem (to the extent you can) and report your discoveries. | |
d121ca8c CS |
1097 | |
1098 | =item Can you fix the bug yourself? | |
1099 | ||
1100 | A bug report which I<includes a patch to fix it> will almost | |
1101 | definitely be fixed. Use the C<diff> program to generate your patches | |
1102 | (C<diff> is being maintained by the GNU folks as part of the B<diffutils> | |
1103 | package, so you should be able to get it from any of the GNU software | |
1104 | repositories). If you do submit a patch, the cool-dude counter at | |
7f2de2d2 | 1105 | perlbug@perl.org will register you as a savior of the world. Your |
d121ca8c CS |
1106 | patch may be returned with requests for changes, or requests for more |
1107 | detailed explanations about your fix. | |
1108 | ||
1109 | Here are some clues for creating quality patches: Use the B<-c> or | |
1110 | B<-u> switches to the diff program (to create a so-called context or | |
1111 | unified diff). Make sure the patch is not reversed (the first | |
1112 | argument to diff is typically the original file, the second argument | |
1113 | your changed file). Make sure you test your patch by applying it with | |
1114 | the C<patch> program before you send it on its way. Try to follow the | |
1115 | same style as the code you are trying to patch. Make sure your patch | |
1116 | really does work (C<make test>, if the thing you're patching supports | |
1117 | it). | |
1118 | ||
1119 | =item Can you use C<perlbug> to submit the report? | |
1120 | ||
1121 | B<perlbug> will, amongst other things, ensure your report includes | |
1122 | crucial information about your version of perl. If C<perlbug> is unable | |
1123 | to mail your report after you have typed it in, you may have to compose | |
1124 | the message yourself, add the output produced by C<perlbug -d> and email | |
7f2de2d2 | 1125 | it to B<perlbug@perl.org>. If, for some reason, you cannot run |
d121ca8c CS |
1126 | C<perlbug> at all on your system, be sure to include the entire output |
1127 | produced by running C<perl -V> (note the uppercase V). | |
1128 | ||
bdcdfa19 | 1129 | Whether you use C<perlbug> or send the email manually, please make |
884baa66 JH |
1130 | your Subject line informative. "a bug" not informative. Neither is |
1131 | "perl crashes" nor "HELP!!!". These don't help. | |
1132 | A compact description of what's wrong is fine. | |
bdcdfa19 | 1133 | |
d121ca8c CS |
1134 | =back |
1135 | ||
1136 | Having done your bit, please be prepared to wait, to be told the bug | |
884baa66 | 1137 | is in your code, or even to get no reply at all. The Perl maintainers |
84902520 TB |
1138 | are busy folks, so if your problem is a small one or if it is difficult |
1139 | to understand or already known, they may not respond with a personal reply. | |
d121ca8c CS |
1140 | If it is important to you that your bug be fixed, do monitor the |
1141 | C<Changes> file in any development releases since the time you submitted | |
1142 | the bug, and encourage the maintainers with kind words (but never any | |
1143 | flames!). Feel free to resend your bug report if the next released | |
1144 | version of perl comes out and your bug is still present. | |
1145 | ||
1146 | =head1 OPTIONS | |
1147 | ||
1148 | =over 8 | |
1149 | ||
1150 | =item B<-a> | |
1151 | ||
3e79b69b | 1152 | Address to send the report to. Defaults to B<perlbug@perl.org>. |
d121ca8c | 1153 | |
890b8eb0 NC |
1154 | =item B<-A> |
1155 | ||
1156 | Don't send a bug received acknowledgement to the reply address. | |
1157 | Generally it is only a sensible to use this option if you are a | |
1158 | perl maintainer actively watching perl porters for your message to | |
1159 | arrive. | |
1160 | ||
d121ca8c CS |
1161 | =item B<-b> |
1162 | ||
1163 | Body of the report. If not included on the command line, or | |
1164 | in a file with B<-f>, you will get a chance to edit the message. | |
1165 | ||
1166 | =item B<-C> | |
1167 | ||
1168 | Don't send copy to administrator. | |
1169 | ||
1170 | =item B<-c> | |
1171 | ||
1172 | Address to send copy of report to. Defaults to the address of the | |
1173 | local perl administrator (recorded when perl was built). | |
1174 | ||
1175 | =item B<-d> | |
1176 | ||
1177 | Data mode (the default if you redirect or pipe output). This prints out | |
1178 | your configuration data, without mailing anything. You can use this | |
1179 | with B<-v> to get more complete data. | |
1180 | ||
1181 | =item B<-e> | |
1182 | ||
55d729e4 | 1183 | Editor to use. |
d121ca8c CS |
1184 | |
1185 | =item B<-f> | |
1186 | ||
1187 | File containing the body of the report. Use this to quickly send a | |
1188 | prepared message. | |
1189 | ||
105f9295 HS |
1190 | =item B<-F> |
1191 | ||
1192 | File to output the results to instead of sending as an email. Useful | |
1193 | particularly when running perlbug on a machine with no direct internet | |
1194 | connection. | |
1195 | ||
d121ca8c CS |
1196 | =item B<-h> |
1197 | ||
1198 | Prints a brief summary of the options. | |
1199 | ||
1b0e3b9e CR |
1200 | =item B<-ok> |
1201 | ||
84902520 TB |
1202 | Report successful build on this system to perl porters. Forces B<-S> |
1203 | and B<-C>. Forces and supplies values for B<-s> and B<-b>. Only | |
1b0e3b9e | 1204 | prompts for a return address if it cannot guess it (for use with |
84902520 TB |
1205 | B<make>). Honors return address specified with B<-r>. You can use this |
1206 | with B<-v> to get more complete data. Only makes a report if this | |
1207 | system is less than 60 days old. | |
1208 | ||
1209 | =item B<-okay> | |
1210 | ||
1211 | As B<-ok> except it will report on older systems. | |
1b0e3b9e | 1212 | |
55d729e4 GS |
1213 | =item B<-nok> |
1214 | ||
1215 | Report unsuccessful build on this system. Forces B<-C>. Forces and | |
1216 | supplies a value for B<-s>, then requires you to edit the report | |
1217 | and say what went wrong. Alternatively, a prepared report may be | |
1218 | supplied using B<-f>. Only prompts for a return address if it | |
1219 | cannot guess it (for use with B<make>). Honors return address | |
1220 | specified with B<-r>. You can use this with B<-v> to get more | |
1221 | complete data. Only makes a report if this system is less than 60 | |
1222 | days old. | |
1223 | ||
1224 | =item B<-nokay> | |
1225 | ||
1226 | As B<-nok> except it will report on older systems. | |
1227 | ||
d121ca8c CS |
1228 | =item B<-r> |
1229 | ||
1230 | Your return address. The program will ask you to confirm its default | |
1231 | if you don't use this option. | |
1232 | ||
1233 | =item B<-S> | |
1234 | ||
1235 | Send without asking for confirmation. | |
1236 | ||
1237 | =item B<-s> | |
1238 | ||
1239 | Subject to include with the message. You will be prompted if you don't | |
1240 | supply one on the command line. | |
1241 | ||
1242 | =item B<-t> | |
1243 | ||
3e79b69b | 1244 | Test mode. The target address defaults to B<perlbug-test@perl.org>. |
d121ca8c CS |
1245 | |
1246 | =item B<-v> | |
1247 | ||
1248 | Include verbose configuration data in the report. | |
1249 | ||
1250 | =back | |
1251 | ||
1252 | =head1 AUTHORS | |
1253 | ||
1254 | Kenneth Albanowski (E<lt>kjahds@kjahds.comE<gt>), subsequently I<doc>tored | |
6e238990 | 1255 | by Gurusamy Sarathy (E<lt>gsar@activestate.comE<gt>), Tom Christiansen |
1b0e3b9e | 1256 | (E<lt>tchrist@perl.comE<gt>), Nathan Torkington (E<lt>gnat@frii.comE<gt>), |
55d729e4 | 1257 | Charles F. Randall (E<lt>cfr@pobox.comE<gt>), Mike Guy |
bdcdfa19 | 1258 | (E<lt>mjtg@cam.a.ukE<gt>), Dominic Dunlop (E<lt>domo@computer.orgE<gt>), |
cc3f2df3 | 1259 | Hugo van der Sanden (E<lt>hv@crypt.org<gt>), |
50d3c28b GS |
1260 | Jarkko Hietaniemi (E<lt>jhi@iki.fiE<gt>), Chris Nandor |
1261 | (E<lt>pudge@pobox.comE<gt>), Jon Orwant (E<lt>orwant@media.mit.eduE<gt>, | |
1262 | and Richard Foley (E<lt>richard@rfi.netE<gt>). | |
d121ca8c CS |
1263 | |
1264 | =head1 SEE ALSO | |
1265 | ||
bdcdfa19 JH |
1266 | perl(1), perldebug(1), perldiag(1), perlport(1), perltrap(1), |
1267 | diff(1), patch(1), dbx(1), gdb(1) | |
d121ca8c CS |
1268 | |
1269 | =head1 BUGS | |
1270 | ||
1271 | None known (guess what must have been used to report them?) | |
1272 | ||
1273 | =cut | |
1274 | ||
37fa004c | 1275 | !NO!SUBS! |
1276 | ||
1277 | close OUT or die "Can't close $file: $!"; | |
1278 | chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; | |
1279 | exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; | |
8a5546a1 | 1280 | chdir $origdir; |