home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _24a3cae1074b7020146fc2771fdc3449 < prev    next >
Text File  |  2000-03-23  |  9KB  |  213 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>B<CGI::Carp> - CGI routines for writing to the HTTPD error log</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> B<CGI::Carp> - CGI routines for writing to the HTTPD error log</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#redirecting error messages">REDIRECTING ERROR MESSAGES</A></LI>
  26.     <LI><A HREF="#making perl errors appear in the browser window">MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW</A></LI>
  27.     <UL>
  28.  
  29.         <LI><A HREF="#changing the default message">Changing the default message</A></LI>
  30.     </UL>
  31.  
  32.     <LI><A HREF="#change log">CHANGE LOG</A></LI>
  33.     <LI><A HREF="#authors">AUTHORS</A></LI>
  34.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  35. </UL>
  36. <!-- INDEX END -->
  37.  
  38. <HR>
  39. <P>
  40. <H1><A NAME="name">NAME</A></H1>
  41. <P><STRONG>CGI::Carp</STRONG> - CGI routines for writing to the HTTPD (or other) error log</P>
  42. <P>
  43. <HR>
  44. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  45. <UL>
  46. <LI>Linux</LI>
  47. <LI>Solaris</LI>
  48. <LI>Windows</LI>
  49. </UL>
  50. <HR>
  51. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  52. <PRE>
  53.     use CGI::Carp;</PRE>
  54. <PRE>
  55.     croak "We're outta here!";
  56.     confess "It was my fault: $!";
  57.     carp "It was your fault!";   
  58.     warn "I'm confused";
  59.     die  "I'm dying.\n";</PRE>
  60. <PRE>
  61.     use CGI::Carp qw(cluck);
  62.     cluck "I wouldn't do that if I were you";</PRE>
  63. <PRE>
  64.     use CGI::Carp qw(fatalsToBrowser);
  65.     die "Fatal error messages are now sent to browser";</PRE>
  66. <P>
  67. <HR>
  68. <H1><A NAME="description">DESCRIPTION</A></H1>
  69. <P>CGI scripts have a nasty habit of leaving warning messages in the error
  70. logs that are neither time stamped nor fully identified.  Tracking down
  71. the script that caused the error is a pain.  This fixes that.  Replace
  72. the usual</P>
  73. <PRE>
  74.     use Carp;</PRE>
  75. <P>with</P>
  76. <PRE>
  77.     use CGI::Carp</PRE>
  78. <P>And the standard warn(), die (), croak(), <CODE>confess()</CODE> and <CODE>carp()</CODE> calls
  79. will automagically be replaced with functions that write out nicely
  80. time-stamped messages to the HTTP server error log.</P>
  81. <P>For example:</P>
  82. <PRE>
  83.    [Fri Nov 17 21:40:43 1995] test.pl: I'm confused at test.pl line 3.
  84.    [Fri Nov 17 21:40:43 1995] test.pl: Got an error message: Permission denied.
  85.    [Fri Nov 17 21:40:43 1995] test.pl: I'm dying.</PRE>
  86. <P>
  87. <HR>
  88. <H1><A NAME="redirecting error messages">REDIRECTING ERROR MESSAGES</A></H1>
  89. <P>By default, error messages are sent to STDERR.  Most HTTPD servers
  90. direct STDERR to the server's error log.  Some applications may wish
  91. to keep private error logs, distinct from the server's error log, or
  92. they may wish to direct error messages to STDOUT so that the browser
  93. will receive them.</P>
  94. <P>The <CODE>carpout()</CODE> function is provided for this purpose.  Since
  95. <CODE>carpout()</CODE> is not exported by default, you must import it explicitly by
  96. saying</P>
  97. <PRE>
  98.    use CGI::Carp qw(carpout);</PRE>
  99. <P>The <CODE>carpout()</CODE> function requires one argument, which should be a
  100. reference to an open filehandle for writing errors.  It should be
  101. called in a <CODE>BEGIN</CODE> block at the top of the CGI application so that
  102. compiler errors will be caught.  Example:</P>
  103. <PRE>
  104.    BEGIN {
  105.      use CGI::Carp qw(carpout);
  106.      open(LOG, ">>/usr/local/cgi-logs/mycgi-log") or
  107.        die("Unable to open mycgi-log: $!\n");
  108.      carpout(LOG);
  109.    }</PRE>
  110. <P><CODE>carpout()</CODE> does not handle file locking on the log for you at this point.</P>
  111. <P>The real STDERR is not closed -- it is moved to SAVEERR.  Some
  112. servers, when dealing with CGI scripts, close their connection to the
  113. browser when the script closes STDOUT and STDERR.  SAVEERR is used to
  114. prevent this from happening prematurely.</P>
  115. <P>You can pass filehandles to <CODE>carpout()</CODE> in a variety of ways.  The ``correct''
  116. way according to Tom Christiansen is to pass a reference to a filehandle 
  117. GLOB:</P>
  118. <PRE>
  119.     carpout(\*LOG);</PRE>
  120. <P>This looks weird to mere mortals however, so the following syntaxes are
  121. accepted as well:</P>
  122. <PRE>
  123.     carpout(LOG);
  124.     carpout(main::LOG);
  125.     carpout(main'LOG);
  126.     carpout(\LOG);
  127.     carpout(\'main::LOG');</PRE>
  128. <PRE>
  129.     ... and so on</PRE>
  130. <P>FileHandle and other objects work as well.</P>
  131. <P>Use of <CODE>carpout()</CODE> is not great for performance, so it is recommended
  132. for debugging purposes or for moderate-use applications.  A future
  133. version of this module may delay redirecting STDERR until one of the
  134. CGI::Carp methods is called to prevent the performance hit.</P>
  135. <P>
  136. <HR>
  137. <H1><A NAME="making perl errors appear in the browser window">MAKING PERL ERRORS APPEAR IN THE BROWSER WINDOW</A></H1>
  138. <P>If you want to send fatal (die, confess) errors to the browser, ask to 
  139. import the special ``fatalsToBrowser'' subroutine:</P>
  140. <PRE>
  141.     use CGI::Carp qw(fatalsToBrowser);
  142.     die "Bad error here";</PRE>
  143. <P>Fatal errors will now be echoed to the browser as well as to the log.  CGI::Carp
  144. arranges to send a minimal HTTP header to the browser so that even errors that
  145. occur in the early compile phase will be seen.
  146. Nonfatal errors will still be directed to the log file only (unless redirected
  147. with carpout).</P>
  148. <P>
  149. <H2><A NAME="changing the default message">Changing the default message</A></H2>
  150. <P>By default, the software error message is followed by a note to
  151. contact the Webmaster by e-mail with the time and date of the error.
  152. If this message is not to your liking, you can change it using the
  153. <CODE>set_message()</CODE> routine.  This is not imported by default; you should
  154. import it on the <A HREF="../../lib/Pod/perlfunc.html#item_use"><CODE>use()</CODE></A> line:</P>
  155. <PRE>
  156.     use CGI::Carp qw(fatalsToBrowser set_message);
  157.     set_message("It's not a bug, it's a feature!");</PRE>
  158. <P>You may also pass in a code reference in order to create a custom
  159. error message.  At run time, your code will be called with the text
  160. of the error message that caused the script to die.  Example:</P>
  161. <PRE>
  162.     use CGI::Carp qw(fatalsToBrowser set_message);
  163.     BEGIN {
  164.        sub handle_errors {
  165.           my $msg = shift;
  166.           print "<h1>Oh gosh</h1>";
  167.           print "Got an error: $msg";
  168.       }
  169.       set_message(\&handle_errors);
  170.     }</PRE>
  171. <P>In order to correctly intercept compile-time errors, you should call
  172. <CODE>set_message()</CODE> from within a BEGIN{} block.</P>
  173. <P>
  174. <HR>
  175. <H1><A NAME="change log">CHANGE LOG</A></H1>
  176. <P>1.05 <CODE>carpout()</CODE> added and minor corrections by Marc Hedlund
  177.      <<A HREF="mailto:hedlund@best.com">hedlund@best.com</A>> on 11/26/95.</P>
  178. <P>1.06 <CODE>fatalsToBrowser()</CODE> no longer aborts for fatal errors within
  179.      <A HREF="../../lib/Pod/perlfunc.html#item_eval"><CODE>eval()</CODE></A> statements.</P>
  180. <P>1.08 <CODE>set_message()</CODE> added and <CODE>carpout()</CODE> expanded to allow for FileHandle
  181.      objects.</P>
  182. <P>1.09 <CODE>set_message()</CODE> now allows users to pass a code REFERENCE for 
  183.      really custom error messages.  croak and carp are now
  184.      exported by default.  Thanks to Gunther Birznieks for the
  185.      patches.</P>
  186. <P>1.10 Patch from Chris Dean (<A HREF="mailto:ctdean@cogit.com">ctdean@cogit.com</A>) to allow 
  187.      module to run correctly under mod_perl.</P>
  188. <P>1.11 Changed order of &gt; and &lt; escapes.</P>
  189. <P>1.12 Changed <A HREF="../../lib/Pod/perlfunc.html#item_die"><CODE>die()</CODE></A> on line 217 to CORE::die to avoid <STRONG>-w</STRONG> warning.</P>
  190. <P>1.13 Added <CODE>cluck()</CODE> to make the module orthogonal with Carp.
  191.     More mod_perl related fixes.</P>
  192. <P>
  193. <HR>
  194. <H1><A NAME="authors">AUTHORS</A></H1>
  195. <P>Copyright 1995-1998, Lincoln D. Stein.  All rights reserved.</P>
  196. <P>This library is free software; you can redistribute it and/or modify
  197. it under the same terms as Perl itself.</P>
  198. <P>Address bug reports and comments to: <A HREF="mailto:lstein@cshl.org">lstein@cshl.org</A></P>
  199. <P>
  200. <HR>
  201. <H1><A NAME="see also">SEE ALSO</A></H1>
  202. <P>Carp, CGI::Base, CGI::BasePlus, CGI::Request, CGI::MiniSvr, CGI::Form,
  203. CGI::Response</P>
  204. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  205. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  206. <STRONG><P CLASS=block> B<CGI::Carp> - CGI routines for writing to the HTTPD error log</P></STRONG>
  207. </TD></TR>
  208. </TABLE>
  209.  
  210. </BODY>
  211.  
  212. </HTML>
  213.