lib/CGI/Carp.pm

   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
  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
  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
  74 The real STDERR is not closed -- it is moved to CGI::Carp::SAVEERR.  Some
  75 servers, when dealing with CGI scripts, close their connection to the
  76 browser when the script closes STDOUT and STDERR.  CGI::Carp::SAVEERR is there to
  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
  96 FileHandle and other objects work as well.
  97
  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
 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>";
 137           print "Got an error: $msg";
 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
 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
 164     print "<SCRIPT type=javascript><!--\n";
 165     print_some_javascript_code();
 166     print "//--></SCRIPT>\n";
 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
 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
 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
 191 1.11 Changed order of &gt; and &lt; 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.
 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.
 201
 202 =head1 AUTHORS
 203
 204 Copyright 1995-1998, Lincoln D. Stein.  All rights reserved.
 205
 206 This library is free software; you can redistribute it and/or modify
 207 it under the same terms as Perl itself.
 208
 209 Address bug reports and comments to: lstein@cshl.org
 210
 211 =head1 SEE ALSO
 212
 213 Carp, CGI::Base, CGI::BasePlus, CGI::Request, CGI::MiniSvr, CGI::Form,
 214 CGI::Response
 215
 216 =cut
 217
 218 require 5.000;
 219 use Exporter;
 220 use Carp;
 221 use File::Spec;
 222
 223 @ISA = qw(Exporter);
 224 @EXPORT = qw(confess croak carp);
 225 @EXPORT_OK = qw(carpout fatalsToBrowser warningsToBrowser wrap set_message cluck);
 226
 227 $main::SIG{__WARN__}=\&CGI::Carp::warn;
 228 $main::SIG{__DIE__}=\&CGI::Carp::die;
 229 $CGI::Carp::VERSION = '1.20';
 230 $CGI::Carp::CUSTOM_MSG = undef;
 231
 232 # fancy import routine detects and handles 'errorWrap' specially.
 233 sub import {
 234     my $pkg = shift;
 235     my(%routines);
 236     grep($routines{$_}++,@_,@EXPORT);
 237     $WRAP++ if $routines{'fatalsToBrowser'} || $routines{'wrap'};
 238     $WARN++ if $routines{'warningsToBrowser'};
 239     my($oldlevel) = $Exporter::ExportLevel;
 240     $Exporter::ExportLevel = 1;
 241     Exporter::import($pkg,keys %routines);
 242     $Exporter::ExportLevel = $oldlevel;
 243 }
 244
 245 # These are the originals
 246 sub realwarn { CORE::warn(@_); }
 247 sub realdie { CORE::die(@_); }
 248
 249 sub id {
 250     my $level = shift;
 251     my($pack,$file,$line,$sub) = caller($level);
 252     my($dev,$dirs,$id) = File::Spec->splitpath($file);
 253     return ($file,$line,$id);
 254 }
 255
 256 sub stamp {
 257     my $time = scalar(localtime);
 258     my $frame = 0;
 259      my ($id,$pack,$file,$dev,$dirs);
 260     do {
 261         $id = $file;
 262         ($pack,$file) = caller($frame++);
 263     } until !$file;
 264     ($dev,$dirs,$id) = File::Spec->splitpath($id);
 265     return "[$time] $id: ";
 266 }
 267
 268 sub warn {
 269     my $message = shift;
 270     my($file,$line,$id) = id(1);
 271     $message .= " at $file line $line.\n" unless $message=~/\n$/;
 272     _warn($message) if $WARN;
 273     my $stamp = stamp;
 274     $message=~s/^/$stamp/gm;
 275     realwarn $message;
 276 }
 277
 278 sub _warn {
 279     my $msg = shift;
 280     if ($EMIT_WARNINGS) {
 281         # We need to mangle the message a bit to make it a valid HTML
 282         # comment.  This is done by substituting similar-looking ISO
 283         # 8859-1 characters for <, > and -.  This is a hack.
 284         $msg =~ tr/<>-/\253\273\255/;
 285         chomp $msg;
 286         print STDOUT "<!-- warning: $msg -->\n";
 287     } else {
 288         push @WARNINGS, $msg;
 289     }
 290 }
 291
 292 sub ineval { _longmess() =~ /eval [\{\']/m }
 293
 294 # The mod_perl package Apache::Registry loads CGI programs by calling
 295 # eval.  These evals don't count when looking at the stack backtrace.
 296 sub _longmess {
 297     my $message = Carp::longmess();
 298     my $mod_perl = exists $ENV{MOD_PERL};
 299     $message =~ s,eval[^\n]+Apache/Registry\.pm.*,,s if $mod_perl;
 300     return $message;
 301 }
 302
 303 sub die {
 304   realdie @_ if ineval;
 305   my ($message) = @_;
 306   my $time = scalar(localtime);
 307   my($file,$line,$id) = id(1);
 308   $message .= " at $file line $line." unless $message=~/\n$/;
 309   &fatalsToBrowser($message) if $WRAP;
 310   my $stamp = stamp;
 311   $message=~s/^/$stamp/gm;
 312   realdie $message;
 313 }
 314
 315 sub set_message {
 316     $CGI::Carp::CUSTOM_MSG = shift;
 317     return $CGI::Carp::CUSTOM_MSG;
 318 }
 319
 320 # Avoid generating "subroutine redefined" warnings with the following
 321 # hack:
 322 {
 323     local $^W=0;
 324     eval <<EOF;
 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 \@_; }
 329 EOF
 330     ;
 331 }
 332
 333 # We have to be ready to accept a filehandle as a reference
 334 # or a string.
 335 sub carpout {
 336     my($in) = @_;
 337     my($no) = fileno(to_filehandle($in));
 338     realdie("Invalid filehandle $in\n") unless defined $no;
 339
 340     open(SAVEERR, ">&STDERR");
 341     open(STDERR, ">&$no") or
 342         ( print SAVEERR "Unable to redirect STDERR: $!\n" and exit(1) );
 343 }
 344
 345 sub warningsToBrowser {
 346     $EMIT_WARNINGS = @_ ? shift : 1;
 347     _warn(shift @WARNINGS) while $EMIT_WARNINGS and @WARNINGS;
 348 }
 349
 350 # headers
 351 sub fatalsToBrowser {
 352     my($msg) = @_;
 353     $msg=~s/&/&amp;/g;
 354     $msg=~s/>/&gt;/g;
 355     $msg=~s/</&lt;/g;
 356     $msg=~s/\"/&quot;/g;
 357     my($wm) = $ENV{SERVER_ADMIN} ?
 358         qq[the webmaster (<a href="mailto:$ENV{SERVER_ADMIN}">$ENV{SERVER_ADMIN}</a>)] :
 359         "this site's webmaster";
 360     my ($outer_message) = <<END;
 361 For help, please send mail to $wm, giving this error message
 362 and the time and date of the error.
 363 END
 364     ;
 365     my $mod_perl = exists $ENV{MOD_PERL};
 366     print STDOUT "Content-type: text/html\n\n"
 367         unless $mod_perl;
 368
 369     warningsToBrowser(1);    # emit warnings before dying
 370
 371     if ($CUSTOM_MSG) {
 372         if (ref($CUSTOM_MSG) eq 'CODE') {
 373             &$CUSTOM_MSG($msg); # nicer to perl 5.003 users
 374             return;
 375         } else {
 376             $outer_message = $CUSTOM_MSG;
 377         }
 378     }
 379
 380     my $mess = <<END;
 381 <H1>Software error:</H1>
 382 <PRE>$msg</PRE>
 383 <P>
 384 $outer_message
 385 END
 386     ;
 387
 388     if ($mod_perl && (my $r = Apache->request)) {
 389         # If bytes have already been sent, then
 390         # we print the message out directly.
 391         # Otherwise we make a custom error
 392         # handler to produce the doc for us.
 393         if ($r->bytes_sent) {
 394             $r->print($mess);
 395             $r->exit;
 396         } else {
 397             $r->status(500);
 398             $r->custom_response(500,$mess);
 399         }
 400     } else {
 401         print STDOUT $mess;
 402     }
 403 }
 404
 405 # Cut and paste from CGI.pm so that we don't have the overhead of
 406 # always loading the entire CGI module.
 407 sub to_filehandle {
 408     my $thingy = shift;
 409     return undef unless $thingy;
 410     return $thingy if UNIVERSAL::isa($thingy,'GLOB');
 411     return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
 412     if (!ref($thingy)) {
 413         my $caller = 1;
 414         while (my $package = caller($caller++)) {
 415             my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
 416             return $tmp if defined(fileno($tmp));
 417         }
 418     }
 419     return undef;
 420 }
 421
 422 1;