Commit | Line | Data |
54310121 |
1 | package CGI::Carp; |
2 | |
3 | =head1 NAME |
4 | |
5 | B<CGI::Carp> - CGI routines for writing to the HTTPD (or other) error log |
6 | |
7 | =head1 SYNOPSIS |
8 | |
9 | use CGI::Carp; |
10 | |
11 | croak "We're outta here!"; |
12 | confess "It was my fault: $!"; |
13 | carp "It was your fault!"; |
14 | warn "I'm confused"; |
15 | die "I'm dying.\n"; |
16 | |
71f3e297 |
17 | use CGI::Carp qw(cluck); |
18 | cluck "I wouldn't do that if I were you"; |
19 | |
20 | use CGI::Carp qw(fatalsToBrowser); |
21 | die "Fatal error messages are now sent to browser"; |
22 | |
54310121 |
23 | =head1 DESCRIPTION |
24 | |
25 | CGI scripts have a nasty habit of leaving warning messages in the error |
26 | logs that are neither time stamped nor fully identified. Tracking down |
27 | the script that caused the error is a pain. This fixes that. Replace |
28 | the usual |
29 | |
30 | use Carp; |
31 | |
32 | with |
33 | |
34 | use CGI::Carp |
35 | |
36 | And the standard warn(), die (), croak(), confess() and carp() calls |
37 | will automagically be replaced with functions that write out nicely |
38 | time-stamped messages to the HTTP server error log. |
39 | |
40 | For example: |
41 | |
42 | [Fri Nov 17 21:40:43 1995] test.pl: I'm confused at test.pl line 3. |
43 | [Fri Nov 17 21:40:43 1995] test.pl: Got an error message: Permission denied. |
44 | [Fri Nov 17 21:40:43 1995] test.pl: I'm dying. |
45 | |
46 | =head1 REDIRECTING ERROR MESSAGES |
47 | |
48 | By default, error messages are sent to STDERR. Most HTTPD servers |
49 | direct STDERR to the server's error log. Some applications may wish |
50 | to keep private error logs, distinct from the server's error log, or |
51 | they may wish to direct error messages to STDOUT so that the browser |
52 | will receive them. |
53 | |
54 | The C<carpout()> function is provided for this purpose. Since |
55 | carpout() is not exported by default, you must import it explicitly by |
56 | saying |
57 | |
58 | use CGI::Carp qw(carpout); |
59 | |
60 | The carpout() function requires one argument, which should be a |
61 | reference to an open filehandle for writing errors. It should be |
62 | called in a C<BEGIN> block at the top of the CGI application so that |
63 | compiler errors will be caught. Example: |
64 | |
65 | BEGIN { |
66 | use CGI::Carp qw(carpout); |
67 | open(LOG, ">>/usr/local/cgi-logs/mycgi-log") or |
68 | die("Unable to open mycgi-log: $!\n"); |
69 | carpout(LOG); |
70 | } |
71 | |
72 | carpout() does not handle file locking on the log for you at this point. |
73 | |
ba056755 |
74 | The real STDERR is not closed -- it is moved to CGI::Carp::SAVEERR. Some |
54310121 |
75 | servers, when dealing with CGI scripts, close their connection to the |
ba056755 |
76 | browser when the script closes STDOUT and STDERR. CGI::Carp::SAVEERR is there to |
54310121 |
77 | prevent this from happening prematurely. |
78 | |
79 | You can pass filehandles to carpout() in a variety of ways. The "correct" |
80 | way according to Tom Christiansen is to pass a reference to a filehandle |
81 | GLOB: |
82 | |
83 | carpout(\*LOG); |
84 | |
85 | This looks weird to mere mortals however, so the following syntaxes are |
86 | accepted as well: |
87 | |
88 | carpout(LOG); |
89 | carpout(main::LOG); |
90 | carpout(main'LOG); |
91 | carpout(\LOG); |
92 | carpout(\'main::LOG'); |
93 | |
94 | ... and so on |
95 | |
424ec8fa |
96 | FileHandle and other objects work as well. |
97 | |
54310121 |
98 | Use of carpout() is not great for performance, so it is recommended |
99 | for debugging purposes or for moderate-use applications. A future |
100 | version of this module may delay redirecting STDERR until one of the |
101 | CGI::Carp methods is called to prevent the performance hit. |
102 | |
103 | =head1 MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW |
104 | |
105 | If you want to send fatal (die, confess) errors to the browser, ask to |
106 | import the special "fatalsToBrowser" subroutine: |
107 | |
108 | use CGI::Carp qw(fatalsToBrowser); |
109 | die "Bad error here"; |
110 | |
111 | Fatal errors will now be echoed to the browser as well as to the log. CGI::Carp |
112 | arranges to send a minimal HTTP header to the browser so that even errors that |
113 | occur in the early compile phase will be seen. |
114 | Nonfatal errors will still be directed to the log file only (unless redirected |
115 | with carpout). |
116 | |
424ec8fa |
117 | =head2 Changing the default message |
118 | |
119 | By default, the software error message is followed by a note to |
120 | contact the Webmaster by e-mail with the time and date of the error. |
121 | If this message is not to your liking, you can change it using the |
122 | set_message() routine. This is not imported by default; you should |
123 | import it on the use() line: |
124 | |
125 | use CGI::Carp qw(fatalsToBrowser set_message); |
126 | set_message("It's not a bug, it's a feature!"); |
127 | |
128 | You may also pass in a code reference in order to create a custom |
129 | error message. At run time, your code will be called with the text |
130 | of the error message that caused the script to die. Example: |
131 | |
132 | use CGI::Carp qw(fatalsToBrowser set_message); |
133 | BEGIN { |
134 | sub handle_errors { |
135 | my $msg = shift; |
136 | print "<h1>Oh gosh</h1>"; |
b2d0d414 |
137 | print "<p>Got an error: $msg</p>"; |
424ec8fa |
138 | } |
139 | set_message(\&handle_errors); |
140 | } |
141 | |
142 | In order to correctly intercept compile-time errors, you should call |
143 | set_message() from within a BEGIN{} block. |
144 | |
6b4ac661 |
145 | =head1 MAKING WARNINGS APPEAR AS HTML COMMENTS |
146 | |
147 | It is now also possible to make non-fatal errors appear as HTML |
148 | comments embedded in the output of your program. To enable this |
149 | feature, export the new "warningsToBrowser" subroutine. Since sending |
150 | warnings to the browser before the HTTP headers have been sent would |
151 | cause an error, any warnings are stored in an internal buffer until |
152 | you call the warningsToBrowser() subroutine with a true argument: |
153 | |
154 | use CGI::Carp qw(fatalsToBrowser warningsToBrowser); |
155 | use CGI qw(:standard); |
156 | print header(); |
157 | warningsToBrowser(1); |
158 | |
159 | You may also give a false argument to warningsToBrowser() to prevent |
160 | warnings from being sent to the browser while you are printing some |
161 | content where HTML comments are not allowed: |
162 | |
163 | warningsToBrowser(0); # disable warnings |
b2d0d414 |
164 | print "<script type=\"text/javascript\"><!--\n"; |
6b4ac661 |
165 | print_some_javascript_code(); |
b2d0d414 |
166 | print "//--></script>\n"; |
6b4ac661 |
167 | warningsToBrowser(1); # re-enable warnings |
168 | |
169 | Note: In this respect warningsToBrowser() differs fundamentally from |
170 | fatalsToBrowser(), which you should never call yourself! |
171 | |
54310121 |
172 | =head1 CHANGE LOG |
173 | |
174 | 1.05 carpout() added and minor corrections by Marc Hedlund |
175 | <hedlund@best.com> on 11/26/95. |
176 | |
177 | 1.06 fatalsToBrowser() no longer aborts for fatal errors within |
178 | eval() statements. |
179 | |
424ec8fa |
180 | 1.08 set_message() added and carpout() expanded to allow for FileHandle |
181 | objects. |
182 | |
183 | 1.09 set_message() now allows users to pass a code REFERENCE for |
184 | really custom error messages. croak and carp are now |
185 | exported by default. Thanks to Gunther Birznieks for the |
186 | patches. |
187 | |
188 | 1.10 Patch from Chris Dean (ctdean@cogit.com) to allow |
189 | module to run correctly under mod_perl. |
190 | |
71f3e297 |
191 | 1.11 Changed order of > and < escapes. |
192 | |
193 | 1.12 Changed die() on line 217 to CORE::die to avoid B<-w> warning. |
194 | |
195 | 1.13 Added cluck() to make the module orthogonal with Carp. |
6b4ac661 |
196 | More mod_perl related fixes. |
197 | |
198 | 1.20 Patch from Ilmari Karonen (perl@itz.pp.sci.fi): Added |
199 | warningsToBrowser(). Replaced <CODE> tags with <PRE> in |
200 | fatalsToBrowser() output. |
71f3e297 |
201 | |
b2d0d414 |
202 | 1.23 ineval() now checks both $^S and inspects the message for the "eval" pattern |
203 | (hack alert!) in order to accomodate various combinations of Perl and |
204 | mod_perl. |
205 | |
54310121 |
206 | =head1 AUTHORS |
207 | |
b2d0d414 |
208 | Copyright 1995-2002, Lincoln D. Stein. All rights reserved. |
71f3e297 |
209 | |
210 | This library is free software; you can redistribute it and/or modify |
211 | it under the same terms as Perl itself. |
54310121 |
212 | |
71f3e297 |
213 | Address bug reports and comments to: lstein@cshl.org |
54310121 |
214 | |
215 | =head1 SEE ALSO |
216 | |
217 | Carp, CGI::Base, CGI::BasePlus, CGI::Request, CGI::MiniSvr, CGI::Form, |
218 | CGI::Response |
219 | |
220 | =cut |
221 | |
222 | require 5.000; |
223 | use Exporter; |
3acbd4f5 |
224 | #use Carp; |
225 | BEGIN { require Carp; } |
7f16a916 |
226 | use File::Spec; |
54310121 |
227 | |
228 | @ISA = qw(Exporter); |
229 | @EXPORT = qw(confess croak carp); |
6b4ac661 |
230 | @EXPORT_OK = qw(carpout fatalsToBrowser warningsToBrowser wrap set_message cluck); |
3538e1d5 |
231 | |
54310121 |
232 | $main::SIG{__WARN__}=\&CGI::Carp::warn; |
233 | $main::SIG{__DIE__}=\&CGI::Carp::die; |
b2d0d414 |
234 | $CGI::Carp::VERSION = '1.23'; |
424ec8fa |
235 | $CGI::Carp::CUSTOM_MSG = undef; |
54310121 |
236 | |
237 | # fancy import routine detects and handles 'errorWrap' specially. |
238 | sub import { |
239 | my $pkg = shift; |
240 | my(%routines); |
424ec8fa |
241 | grep($routines{$_}++,@_,@EXPORT); |
242 | $WRAP++ if $routines{'fatalsToBrowser'} || $routines{'wrap'}; |
6b4ac661 |
243 | $WARN++ if $routines{'warningsToBrowser'}; |
54310121 |
244 | my($oldlevel) = $Exporter::ExportLevel; |
245 | $Exporter::ExportLevel = 1; |
246 | Exporter::import($pkg,keys %routines); |
247 | $Exporter::ExportLevel = $oldlevel; |
248 | } |
249 | |
250 | # These are the originals |
9014bb8e |
251 | sub realwarn { CORE::warn(@_); } |
252 | sub realdie { CORE::die(@_); } |
54310121 |
253 | |
254 | sub id { |
255 | my $level = shift; |
256 | my($pack,$file,$line,$sub) = caller($level); |
7f16a916 |
257 | my($dev,$dirs,$id) = File::Spec->splitpath($file); |
54310121 |
258 | return ($file,$line,$id); |
259 | } |
260 | |
261 | sub stamp { |
262 | my $time = scalar(localtime); |
263 | my $frame = 0; |
ac734d8b |
264 | my ($id,$pack,$file,$dev,$dirs); |
54310121 |
265 | do { |
266 | $id = $file; |
267 | ($pack,$file) = caller($frame++); |
268 | } until !$file; |
7f16a916 |
269 | ($dev,$dirs,$id) = File::Spec->splitpath($id); |
54310121 |
270 | return "[$time] $id: "; |
271 | } |
272 | |
273 | sub warn { |
274 | my $message = shift; |
275 | my($file,$line,$id) = id(1); |
276 | $message .= " at $file line $line.\n" unless $message=~/\n$/; |
6b4ac661 |
277 | _warn($message) if $WARN; |
54310121 |
278 | my $stamp = stamp; |
279 | $message=~s/^/$stamp/gm; |
280 | realwarn $message; |
281 | } |
282 | |
6b4ac661 |
283 | sub _warn { |
284 | my $msg = shift; |
285 | if ($EMIT_WARNINGS) { |
286 | # We need to mangle the message a bit to make it a valid HTML |
287 | # comment. This is done by substituting similar-looking ISO |
288 | # 8859-1 characters for <, > and -. This is a hack. |
289 | $msg =~ tr/<>-/\253\273\255/; |
290 | chomp $msg; |
291 | print STDOUT "<!-- warning: $msg -->\n"; |
292 | } else { |
293 | push @WARNINGS, $msg; |
294 | } |
295 | } |
296 | |
b2d0d414 |
297 | sub ineval { $^S || _longmess() =~ /eval [\{\']/m } |
6b4ac661 |
298 | |
424ec8fa |
299 | # The mod_perl package Apache::Registry loads CGI programs by calling |
300 | # eval. These evals don't count when looking at the stack backtrace. |
301 | sub _longmess { |
302 | my $message = Carp::longmess(); |
71f3e297 |
303 | my $mod_perl = exists $ENV{MOD_PERL}; |
424ec8fa |
304 | $message =~ s,eval[^\n]+Apache/Registry\.pm.*,,s if $mod_perl; |
6b4ac661 |
305 | return $message; |
424ec8fa |
306 | } |
307 | |
54310121 |
308 | sub die { |
3538e1d5 |
309 | realdie @_ if ineval; |
6b4ac661 |
310 | my ($message) = @_; |
3538e1d5 |
311 | my $time = scalar(localtime); |
312 | my($file,$line,$id) = id(1); |
313 | $message .= " at $file line $line." unless $message=~/\n$/; |
314 | &fatalsToBrowser($message) if $WRAP; |
315 | my $stamp = stamp; |
316 | $message=~s/^/$stamp/gm; |
317 | realdie $message; |
54310121 |
318 | } |
319 | |
424ec8fa |
320 | sub set_message { |
321 | $CGI::Carp::CUSTOM_MSG = shift; |
322 | return $CGI::Carp::CUSTOM_MSG; |
323 | } |
324 | |
2371fea9 |
325 | sub confess { CGI::Carp::die Carp::longmess @_; } |
326 | sub croak { CGI::Carp::die Carp::shortmess @_; } |
327 | sub carp { CGI::Carp::warn Carp::shortmess @_; } |
328 | sub cluck { CGI::Carp::warn Carp::longmess @_; } |
54310121 |
329 | |
330 | # We have to be ready to accept a filehandle as a reference |
331 | # or a string. |
332 | sub carpout { |
333 | my($in) = @_; |
424ec8fa |
334 | my($no) = fileno(to_filehandle($in)); |
71f3e297 |
335 | realdie("Invalid filehandle $in\n") unless defined $no; |
54310121 |
336 | |
337 | open(SAVEERR, ">&STDERR"); |
338 | open(STDERR, ">&$no") or |
339 | ( print SAVEERR "Unable to redirect STDERR: $!\n" and exit(1) ); |
340 | } |
341 | |
6b4ac661 |
342 | sub warningsToBrowser { |
343 | $EMIT_WARNINGS = @_ ? shift : 1; |
344 | _warn(shift @WARNINGS) while $EMIT_WARNINGS and @WARNINGS; |
345 | } |
346 | |
54310121 |
347 | # headers |
348 | sub fatalsToBrowser { |
349 | my($msg) = @_; |
71f3e297 |
350 | $msg=~s/&/&/g; |
54310121 |
351 | $msg=~s/>/>/g; |
352 | $msg=~s/</</g; |
424ec8fa |
353 | $msg=~s/\"/"/g; |
354 | my($wm) = $ENV{SERVER_ADMIN} ? |
355 | qq[the webmaster (<a href="mailto:$ENV{SERVER_ADMIN}">$ENV{SERVER_ADMIN}</a>)] : |
356 | "this site's webmaster"; |
357 | my ($outer_message) = <<END; |
358 | For help, please send mail to $wm, giving this error message |
359 | and the time and date of the error. |
360 | END |
361 | ; |
71f3e297 |
362 | my $mod_perl = exists $ENV{MOD_PERL}; |
363 | print STDOUT "Content-type: text/html\n\n" |
364 | unless $mod_perl; |
424ec8fa |
365 | |
6b4ac661 |
366 | warningsToBrowser(1); # emit warnings before dying |
367 | |
424ec8fa |
368 | if ($CUSTOM_MSG) { |
369 | if (ref($CUSTOM_MSG) eq 'CODE') { |
370 | &$CUSTOM_MSG($msg); # nicer to perl 5.003 users |
371 | return; |
372 | } else { |
373 | $outer_message = $CUSTOM_MSG; |
374 | } |
375 | } |
376 | |
71f3e297 |
377 | my $mess = <<END; |
b2d0d414 |
378 | <h1>Software error:</h1> |
379 | <pre>$msg</pre> |
380 | <p> |
71f3e297 |
381 | $outer_message |
b2d0d414 |
382 | </p> |
54310121 |
383 | END |
424ec8fa |
384 | ; |
71f3e297 |
385 | |
3d1a2ec4 |
386 | if ($mod_perl && (my $r = Apache->request)) { |
71f3e297 |
387 | # If bytes have already been sent, then |
388 | # we print the message out directly. |
389 | # Otherwise we make a custom error |
390 | # handler to produce the doc for us. |
391 | if ($r->bytes_sent) { |
392 | $r->print($mess); |
393 | $r->exit; |
394 | } else { |
395 | $r->status(500); |
396 | $r->custom_response(500,$mess); |
397 | } |
398 | } else { |
399 | print STDOUT $mess; |
400 | } |
424ec8fa |
401 | } |
402 | |
403 | # Cut and paste from CGI.pm so that we don't have the overhead of |
404 | # always loading the entire CGI module. |
405 | sub to_filehandle { |
406 | my $thingy = shift; |
407 | return undef unless $thingy; |
408 | return $thingy if UNIVERSAL::isa($thingy,'GLOB'); |
409 | return $thingy if UNIVERSAL::isa($thingy,'FileHandle'); |
410 | if (!ref($thingy)) { |
411 | my $caller = 1; |
412 | while (my $package = caller($caller++)) { |
413 | my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy"; |
414 | return $tmp if defined(fileno($tmp)); |
415 | } |
416 | } |
417 | return undef; |
54310121 |
418 | } |
419 | |
420 | 1; |