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 "<p>Got an error: $msg</p>";
 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=\"text/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 OVERRIDING THE NAME OF THE PROGRAM
 173
 174 CGI::Carp includes the name of the program that generated the error or
 175 warning in the messages written to the log and the browser window.
 176 Sometimes, Perl can get confused about what the actual name of the
 177 executed program was.  In these cases, you can override the program
 178 name that CGI::Carp will use for all messages.
 179
 180 The quick way to do that is to tell CGI::Carp the name of the program
 181 in its use statement.  You can do that by adding
 182 "name=cgi_carp_log_name" to your "use" statement.  For example:
 183
 184     use CGI::Carp qw(name=cgi_carp_log_name);
 185
 186 .  If you want to change the program name partway through the program,
 187 you can use the C<set_progname()> function instead.  It is not
 188 exported by default, you must import it explicitly by saying
 189
 190     use CGI::Carp qw(set_progname);
 191
 192 Once you've done that, you can change the logged name of the program
 193 at any time by calling
 194
 195     set_progname(new_program_name);
 196
 197 You can set the program back to the default by calling
 198
 199     set_progname(undef);
 200
 201 Note that this override doesn't happen until after the program has
 202 compiled, so any compile-time errors will still show up with the
 203 non-overridden program name
 204
 205 =head1 CHANGE LOG
 206
 207 1.05 carpout() added and minor corrections by Marc Hedlund
 208      <hedlund@best.com> on 11/26/95.
 209
 210 1.06 fatalsToBrowser() no longer aborts for fatal errors within
 211      eval() statements.
 212
 213 1.08 set_message() added and carpout() expanded to allow for FileHandle
 214      objects.
 215
 216 1.09 set_message() now allows users to pass a code REFERENCE for
 217      really custom error messages.  croak and carp are now
 218      exported by default.  Thanks to Gunther Birznieks for the
 219      patches.
 220
 221 1.10 Patch from Chris Dean (ctdean@cogit.com) to allow
 222      module to run correctly under mod_perl.
 223
 224 1.11 Changed order of &gt; and &lt; escapes.
 225
 226 1.12 Changed die() on line 217 to CORE::die to avoid B<-w> warning.
 227
 228 1.13 Added cluck() to make the module orthogonal with Carp.
 229      More mod_perl related fixes.
 230
 231 1.20 Patch from Ilmari Karonen (perl@itz.pp.sci.fi):  Added
 232      warningsToBrowser().  Replaced <CODE> tags with <PRE> in
 233      fatalsToBrowser() output.
 234
 235 1.23 ineval() now checks both $^S and inspects the message for the "eval" pattern
 236      (hack alert!) in order to accomodate various combinations of Perl and
 237      mod_perl.
 238
 239 1.24 Patch from Scott Gifford (sgifford@suspectclass.com): Add support
 240      for overriding program name.
 241
 242 =head1 AUTHORS
 243
 244 Copyright 1995-2002, Lincoln D. Stein.  All rights reserved.
 245
 246 This library is free software; you can redistribute it and/or modify
 247 it under the same terms as Perl itself.
 248
 249 Address bug reports and comments to: lstein@cshl.org
 250
 251 =head1 SEE ALSO
 252
 253 Carp, CGI::Base, CGI::BasePlus, CGI::Request, CGI::MiniSvr, CGI::Form,
 254 CGI::Response
 255     if (defined($CGI::Carp::PROGNAME))
 256     {
 257       $file = $CGI::Carp::PROGNAME;
 258     }
 259
 260 =cut
 261
 262 require 5.000;
 263 use Exporter;
 264 #use Carp;
 265 BEGIN { require Carp; }
 266 use File::Spec;
 267
 268 @ISA = qw(Exporter);
 269 @EXPORT = qw(confess croak carp);
 270 @EXPORT_OK = qw(carpout fatalsToBrowser warningsToBrowser wrap set_message set_progname cluck ^name=);
 271
 272 $main::SIG{__WARN__}=\&CGI::Carp::warn;
 273 *CORE::GLOBAL::die = \&CGI::Carp::die;
 274 $CGI::Carp::VERSION = '1.25';
 275 $CGI::Carp::CUSTOM_MSG = undef;
 276
 277 # fancy import routine detects and handles 'errorWrap' specially.
 278 sub import {
 279     my $pkg = shift;
 280     my(%routines);
 281     my(@name);
 282
 283     if (@name=grep(/^name=/,@_))
 284       {
 285         my($n) = (split(/=/,$name[0]))[1];
 286         set_progname($n);
 287         @_=grep(!/^name=/,@_);
 288       }
 289
 290     grep($routines{$_}++,@_,@EXPORT);
 291     $WRAP++ if $routines{'fatalsToBrowser'} || $routines{'wrap'};
 292     $WARN++ if $routines{'warningsToBrowser'};
 293     my($oldlevel) = $Exporter::ExportLevel;
 294     $Exporter::ExportLevel = 1;
 295     Exporter::import($pkg,keys %routines);
 296     $Exporter::ExportLevel = $oldlevel;
 297 }
 298
 299 # These are the originals
 300 sub realwarn { CORE::warn(@_); }
 301 sub realdie { CORE::die(@_); }
 302
 303 sub id {
 304     my $level = shift;
 305     my($pack,$file,$line,$sub) = caller($level);
 306     my($dev,$dirs,$id) = File::Spec->splitpath($file);
 307     return ($file,$line,$id);
 308 }
 309
 310 sub stamp {
 311     my $time = scalar(localtime);
 312     my $frame = 0;
 313     my ($id,$pack,$file,$dev,$dirs);
 314     if (defined($CGI::Carp::PROGNAME)) {
 315         $id = $CGI::Carp::PROGNAME;
 316     } else {
 317         do {
 318           $id = $file;
 319           ($pack,$file) = caller($frame++);
 320         } until !$file;
 321     }
 322     ($dev,$dirs,$id) = File::Spec->splitpath($id);
 323     return "[$time] $id: ";
 324 }
 325
 326 sub set_progname {
 327     $CGI::Carp::PROGNAME = shift;
 328     return $CGI::Carp::PROGNAME;
 329 }
 330
 331
 332 sub warn {
 333     my $message = shift;
 334     my($file,$line,$id) = id(1);
 335     $message .= " at $file line $line.\n" unless $message=~/\n$/;
 336     _warn($message) if $WARN;
 337     my $stamp = stamp;
 338     $message=~s/^/$stamp/gm;
 339     realwarn $message;
 340 }
 341
 342 sub _warn {
 343     my $msg = shift;
 344     if ($EMIT_WARNINGS) {
 345         # We need to mangle the message a bit to make it a valid HTML
 346         # comment.  This is done by substituting similar-looking ISO
 347         # 8859-1 characters for <, > and -.  This is a hack.
 348         $msg =~ tr/<>-/\253\273\255/;
 349         chomp $msg;
 350         print STDOUT "<!-- warning: $msg -->\n";
 351     } else {
 352         push @WARNINGS, $msg;
 353     }
 354 }
 355
 356
 357 # The mod_perl package Apache::Registry loads CGI programs by calling
 358 # eval.  These evals don't count when looking at the stack backtrace.
 359 sub _longmess {
 360     my $message = Carp::longmess();
 361     $message =~ s,eval[^\n]+(ModPerl|Apache)/Registry\w*\.pm.*,,s
 362         if exists $ENV{MOD_PERL};
 363     return $message;
 364 }
 365
 366 sub ineval {
 367   (exists $ENV{MOD_PERL} ? 0 : $^S) || _longmess() =~ /eval [\{\']/m
 368 }
 369
 370 sub die {
 371   my ($arg) = @_;
 372   realdie @_ if ineval;
 373   if (!ref($arg)) {
 374     $arg = join("", @_);
 375     my($file,$line,$id) = id(1);
 376     $arg .= " at $file line $line." unless $arg=~/\n$/;
 377     &fatalsToBrowser($arg) if $WRAP;
 378     if (($arg =~ /\n$/) || !exists($ENV{MOD_PERL})) {
 379       my $stamp = stamp;
 380       $arg=~s/^/$stamp/gm;
 381     }
 382     if ($arg !~ /\n$/) {
 383       $arg .= "\n";
 384     }
 385   }
 386   realdie $arg;
 387 }
 388
 389 sub set_message {
 390     $CGI::Carp::CUSTOM_MSG = shift;
 391     return $CGI::Carp::CUSTOM_MSG;
 392 }
 393
 394 sub confess { CGI::Carp::die Carp::longmess @_; }
 395 sub croak   { CGI::Carp::die Carp::shortmess @_; }
 396 sub carp    { CGI::Carp::warn Carp::shortmess @_; }
 397 sub cluck   { CGI::Carp::warn Carp::longmess @_; }
 398
 399 # We have to be ready to accept a filehandle as a reference
 400 # or a string.
 401 sub carpout {
 402     my($in) = @_;
 403     my($no) = fileno(to_filehandle($in));
 404     realdie("Invalid filehandle $in\n") unless defined $no;
 405
 406     open(SAVEERR, ">&STDERR");
 407     open(STDERR, ">&$no") or
 408         ( print SAVEERR "Unable to redirect STDERR: $!\n" and exit(1) );
 409 }
 410
 411 sub warningsToBrowser {
 412     $EMIT_WARNINGS = @_ ? shift : 1;
 413     _warn(shift @WARNINGS) while $EMIT_WARNINGS and @WARNINGS;
 414 }
 415
 416 # headers
 417 sub fatalsToBrowser {
 418   my($msg) = @_;
 419   $msg=~s/&/&amp;/g;
 420   $msg=~s/>/&gt;/g;
 421   $msg=~s/</&lt;/g;
 422   $msg=~s/\"/&quot;/g;
 423   my($wm) = $ENV{SERVER_ADMIN} ?
 424     qq[the webmaster (<a href="mailto:$ENV{SERVER_ADMIN}">$ENV{SERVER_ADMIN}</a>)] :
 425       "this site's webmaster";
 426   my ($outer_message) = <<END;
 427 For help, please send mail to $wm, giving this error message
 428 and the time and date of the error.
 429 END
 430   ;
 431   my $mod_perl = exists $ENV{MOD_PERL};
 432   print STDOUT "Content-type: text/html\n\n"
 433     unless $mod_perl;
 434
 435   warningsToBrowser(1);    # emit warnings before dying
 436
 437   if ($CUSTOM_MSG) {
 438     if (ref($CUSTOM_MSG) eq 'CODE') {
 439       &$CUSTOM_MSG($msg); # nicer to perl 5.003 users
 440       return;
 441     } else {
 442       $outer_message = $CUSTOM_MSG;
 443     }
 444   }
 445
 446   my $mess = <<END;
 447 <h1>Software error:</h1>
 448 <pre>$msg</pre>
 449 <p>
 450 $outer_message
 451 </p>
 452 END
 453   ;
 454
 455   if ($mod_perl) {
 456     require mod_perl;
 457     if ($mod_perl::VERSION >= 1.99) {
 458       $mod_perl = 2;
 459       require Apache::RequestRec;
 460       require Apache::RequestIO;
 461       require Apache::RequestUtil;
 462       require APR::Pool;
 463       require ModPerl::Util;
 464       require Apache::Response;
 465     }
 466     my $r = Apache->request;
 467     # If bytes have already been sent, then
 468     # we print the message out directly.
 469     # Otherwise we make a custom error
 470     # handler to produce the doc for us.
 471     if ($r->bytes_sent) {
 472       $r->print($mess);
 473       $mod_perl == 2 ? ModPerl::Util::exit(0) : $r->exit;
 474     } else {
 475       # MSIE browsers don't show the $mess when sent
 476       # a custom 500 response.
 477       if ($ENV{HTTP_USER_AGENT} =~ /MSIE/) {
 478         $r->send_http_header('text/html');
 479         $r->print($mess);
 480         $mod_perl == 2 ? ModPerl::Util::exit(0) : $r->exit;
 481       } else {
 482         $r->custom_response(500,$mess);
 483       }
 484     }
 485   } else {
 486     print STDOUT $mess;
 487   }
 488 }
 489
 490 # Cut and paste from CGI.pm so that we don't have the overhead of
 491 # always loading the entire CGI module.
 492 sub to_filehandle {
 493     my $thingy = shift;
 494     return undef unless $thingy;
 495     return $thingy if UNIVERSAL::isa($thingy,'GLOB');
 496     return $thingy if UNIVERSAL::isa($thingy,'FileHandle');
 497     if (!ref($thingy)) {
 498         my $caller = 1;
 499         while (my $package = caller($caller++)) {
 500             my($tmp) = $thingy=~/[\':]/ ? $thingy : "$package\:\:$thingy";
 501             return $tmp if defined(fileno($tmp));
 502         }
 503     }
 504     return undef;
 505 }
 506
 507 1;