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