[Bio] / FigKernelPackages / Tracer.pm Repository:
ViewVC logotype

Diff of /FigKernelPackages/Tracer.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.95, Fri Apr 18 18:06:12 2008 UTC revision 1.99, Wed May 7 23:00:16 2008 UTC
# Line 20  Line 20 
20    
21      require Exporter;      require Exporter;
22      @ISA = ('Exporter');      @ISA = ('Exporter');
23      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency Warn);
24      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
25      use strict;      use strict;
26      use Carp qw(longmess croak);      use Carp qw(longmess croak carp);
27      use CGI;      use CGI;
28      use Cwd;      use Cwd;
29      use FIG_Config;      use FIG_Config;
# Line 36  Line 36 
36      use Time::HiRes 'gettimeofday';      use Time::HiRes 'gettimeofday';
37      use URI::Escape;      use URI::Escape;
38      use Time::Local;      use Time::Local;
39        use POSIX qw(strftime);
40        use Time::Zone;
41    
42    
43  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
44    
# Line 160  Line 163 
163    
164  Sometimes, you need a way for tracing to happen automatically without putting parameters  Sometimes, you need a way for tracing to happen automatically without putting parameters
165  in a form or on the command line. Emergency tracing does this. You invoke emergency tracing  in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
166  from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.  from the debug form, which is accessed from the [[DebugConsole]]. Emergency tracing requires
167  Emergency tracing requires you specify a tracing key. For command-line tools, the key is  that you specify a tracing key. For command-line tools, the key is
168  taken from the C<TRACING> environment variable. For web services, the key is taken from  taken from the C<TRACING> environment variable. For web services, the key is taken from
169  a cookie. Either way, the key tells the tracing facility who you are, so that you control  a cookie. Either way, the key tells the tracing facility who you are, so that you control
170  the tracing in your environment without stepping on other users.  the tracing in your environment without stepping on other users.
# Line 184  Line 187 
187    
188  The web script will look for the tracing key in the cookies, and the command-line  The web script will look for the tracing key in the cookies, and the command-line
189  script will look for it in the C<TRACING> environment variable. If you are  script will look for it in the C<TRACING> environment variable. If you are
190  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing  using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
191  will be configured automatically.  will be configured automatically.
192    
 NOTE: to configure emergency tracing from the command line instead of the Debugging  
 Control Panel (see below), use the C<trace.pl> script.  
   
 =head3 Debugging Control Panel  
   
 The debugging control panel provides several tools to assist in development of  
 SEED and Sprout software. You access the debugging control panel from the URL  
 C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,  
 for example, the panel access point for the development NMPDR system is  
 C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to  
 find out what the password is. From this page, you can also specify a tracing  
 key. If you don't specify a key, one will be generated for you.  
   
 =head4 Emergency Tracing Form  
   
 At the bottom of the debugging control panel is a form that allows you to  
 specify a trace level and tracing categories. Special and common categories  
 are listed with check boxes. You can hold your mouse over a check box to see  
 what its category does. In general, however, a category name is the same as  
 the name of the package in which the trace message occurs.  
   
 Additional categories can be entered in an input box, delimited by spaces or commas.  
   
 The B<Activate> button turns on Emergency tracing at the level you specify with the  
 specified categories active. The B<Terminate> button turns tracing off. The  
 B<Show File> button displays the current contents of the trace file. The tracing  
 form at the bottom of the control panel is designed for emergency tracing, so it  
 will only affect programs that call L</ETracing>, L</StandardScript>,  
 or L</StandardSetup>.  
   
 =head4 Script Form  
   
 The top form of the debugging control panel allows you to enter a tiny script and  
 have the output generated in a formatted table. Certain object variables are  
 predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),  
 and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.  
   
 The last line of the script must be a scalar, but it can be a reference to a hash,  
 a list, a list of lists, and various other combinations. If you select the appropriate  
 data type in the dropdown box, the output will be formatted accordingly. The form  
 also has controls for specifying tracing. These controls override any emergency  
 tracing in effect.  
   
 =head4 Database Query Forms  
   
 The forms between the script form and the emergency tracing form allow you to  
 make queries against the database. The FIG query form allows simple queries against  
 a single FIG table. The Sprout query form uses the B<GetAll> method to do a  
 multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>  
 package, and it takes five parameters.  
   
     GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);  
   
 Each of the five parameters corresponds to a text box on the query form:  
   
 =over 4  
   
 =item Objects  
   
 Comma-separated list containing the names of the entity and relationship objects to be retrieved.  
   
 =item Filter  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a  
 field, I<objectName> is the name of the entity or relationship object containing the field, and  
 I<number> is the 1-based position of the object in the object list. Any parameters  
 specified in the filter clause should be specified in the B<Params> field.  
 The fields in a filter clause can come from primary entity relations,  
 relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item Params  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause. This  
 is a comma-separated list without any quoting or escaping.  
   
 =item fields  
   
 Comma-separated list of the fields to be returned in each element of the list returned. Fields  
 are specified in the same manner as in the filter clause.  
   
 =item count  
   
 Maximum number of records to return. If omitted or 0, all available records will be returned.  
   
 =back  
   
 B<GetAll> automatically joins together the entities and relationships listed in the object  
 names. This simplifies the coding of the filter clause, but it means that some queries are  
 not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation  
 that has yet to be addressed.  
   
193  =cut  =cut
194    
195  # Declare the configuration variables.  # Declare the configuration variables.
# Line 290  Line 199 
199                              # standard output                              # standard output
200  my %Categories = ( main => 1 );  my %Categories = ( main => 1 );
201                              # hash of active category names                              # hash of active category names
202    my @LevelNames = qw(error warn notice info detail);
203  my $TraceLevel = 0;         # trace level; a higher trace level produces more  my $TraceLevel = 0;         # trace level; a higher trace level produces more
204                              # messages                              # messages
205  my @Queue = ();             # queued list of trace messages.  my @Queue = ();             # queued list of trace messages.
206  my $LastCategory = "main";  # name of the last category interrogated  my $LastCategory = "main";  # name of the last category interrogated
207    my $LastLevel = 0;          # level of the last test call
208  my $SetupCount = 0;         # number of times TSetup called  my $SetupCount = 0;         # number of times TSetup called
209  my $AllTrace = 0;           # TRUE if we are tracing all categories.  my $AllTrace = 0;           # TRUE if we are tracing all categories.
210    my $SavedCGI;               # CGI object passed to ETracing
211    umask 2;                    # Fix the damn umask so everything is group-writable.
212    
213  =head2 Tracing Methods  =head2 Tracing Methods
214    
# Line 366  Line 279 
279          }          }
280      }      }
281      # Now we need to process the destination information. The most important special      # Now we need to process the destination information. The most important special
282      # cases are the single ">", which requires we clear the file first, and the      # case is when we're writing to a file. This is indicated by ">" (overwrite) and
283      # "+" prefix which indicates a double echo.      # ">>" (append). A leading "+" for either indicates that we are also writing to
284        # the standard output (tee mode).
285      if ($target =~ m/^\+?>>?/) {      if ($target =~ m/^\+?>>?/) {
286          if ($target =~ m/^\+/) {          if ($target =~ m/^\+/) {
287              $TeeFlag = 1;              $TeeFlag = 1;
288              $target = substr($target, 1);              $target = substr($target, 1);
289          }          }
290          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
291                # We need to initialize the file (which clears it).
292              open TRACEFILE, $target;              open TRACEFILE, $target;
293              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] [notice] [Tracer] Tracing initialized.\n";
294              close TRACEFILE;              close TRACEFILE;
295                # Set to append mode now that the file has been cleared.
296              $Destination = ">$target";              $Destination = ">$target";
297          } else {          } else {
298              $Destination = $target;              $Destination = $target;
# Line 408  Line 324 
324      $TraceLevel = $_[0];      $TraceLevel = $_[0];
325  }  }
326    
327  =head3 ParseTraceDate  =head3 ParseDate
328    
329        my $time = Tracer::ParseDate($dateString);
330    
331      my $time = Tracer::ParseTraceDate($dateString);  Convert a date into a PERL time number. This method expects a date-like string
332    and parses it into a number. The string must be vaguely date-like or it will
333    return an undefined value. Our requirement is that a month and day be
334    present and that three pieces of the date string (time of day, month and day,
335    year) be separated by likely delimiters, such as spaces, commas, and such-like.
336    
337  Convert a date from the trace file into a PERL timestamp.  If a time of day is present, it must be in military time with two digits for
338    everything but the hour.
339    
340    The year must be exactly four digits.
341    
342    Additional stuff can be in the string. We presume it's time zones or weekdays or something
343    equally innocuous. This means, however, that a sufficiently long sentence with date-like
344    parts in it may be interpreted as a date. Hopefully this will not be a problem.
345    
346    It should be guaranteed that this method will parse the output of the L</Now> function.
347    
348    The parameters are as follows.
349    
350  =over 4  =over 4
351    
352  =item dateString  =item dateString
353    
354  The date string from the trace file. The format of the string is determined by the  The date string to convert.
 L</Now> method.  
355    
356  =item RETURN  =item RETURN
357    
358  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
359  the time string is invalid.  the date string is invalid. A valid date string must contain a month and day.
360    
361  =back  =back
362    
363  =cut  =cut
364    
365  sub ParseTraceDate {  # Universal month conversion table.
366    use constant MONTHS => {    Jan =>  0, January   =>  0, '01' =>  0,  '1' =>  0,
367                                Feb =>  1, February  =>  1, '02' =>  1,  '2' =>  1,
368                                Mar =>  2, March     =>  2, '03' =>  2,  '3' =>  2,
369                                Apr =>  3, April     =>  3, '04' =>  3,  '4' =>  3,
370                                May =>  4, May       =>  4, '05' =>  4,  '5' =>  4,
371                                Jun =>  5, June      =>  5, '06' =>  5,  '6' =>  5,
372                                Jul =>  6, July      =>  6, '07' =>  6,  '7' =>  6,
373                                Aug =>  7, August    =>  7, '08' =>  7,  '8' =>  7,
374                                Sep =>  8, September =>  8, '09' =>  8,  '9' =>  8,
375                                Oct =>  9, October  =>   9, '10' =>  9,
376                                Nov => 10, November =>  10, '11' => 10,
377                                Dec => 11, December =>  11, '12' => 11
378                            };
379    
380    sub ParseDate {
381      # Get the parameters.      # Get the parameters.
382      my ($dateString) = @_;      my ($dateString) = @_;
383      # Declare the return variable.      # Declare the return variable.
384      my $retVal;      my $retVal;
385      # Parse the date.      # Find the month and day of month. There are two ways that can happen. We check for the
386      if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {      # numeric style first. That way, if the user's done something like "Sun 12/22", then we
387          # Create a time object. Note we need to convert the day, month,      # won't be fooled into thinking the month is Sunday.
388          # and year to a different base. Years count from 1900, and      if ($dateString =~ m#\b(\d{1,2})/(\d{1,2})\b# || $dateString =~ m#\b(\w+)\s(\d{1,2})\b#) {
389          # the internal month value is relocated to January = 0.          my ($mon, $mday) = (MONTHS->{$1}, $2);
390          $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);          # Insist that the month and day are valid.
391            if (defined($mon) && $2 >= 1 && $2 <= 31) {
392                # Find the time.
393                my ($hour, $min, $sec) = (0, 0, 0);
394                if ($dateString =~ /\b(\d{1,2}):(\d{2}):(\d{2})\b/) {
395                    ($hour, $min, $sec) = ($1, $2, $3);
396                }
397                # Find the year.
398                my $year;
399                if ($dateString =~ /\b(\d{4})\b/) {
400                    $year = $1;
401                } else {
402                    # Get the default year, which is this one. Note we must convert it to
403                    # the four-digit value expected by "timelocal".
404                    (undef, undef, undef, undef, undef, $year) = localtime();
405                    $year += 1900;
406                }
407                $retVal = timelocal($sec, $min, $hour, $mday, $mon, $year);
408            }
409      }      }
410      # Return the result.      # Return the result.
411      return $retVal;      return $retVal;
# Line 489  Line 454 
454  sub Trace {  sub Trace {
455      # Get the parameters.      # Get the parameters.
456      my ($message) = @_;      my ($message) = @_;
457        # Strip off any line terminators at the end of the message. We will add
458        # new-line stuff ourselves.
459        my $stripped = Strip($message);
460        # Compute the caller information.
461        my ($callPackage, $callFile, $callLine) = caller();
462        my $callFileTitle = basename($callFile);
463        # Check the caller.
464        my $callerInfo = ($callFileTitle ne "Tracer.pm" ? " [$callFileTitle $callLine]" : "");
465      # Get the timestamp.      # Get the timestamp.
466      my $timeStamp = Now();      my $timeStamp = Now();
467      # Format the message. Note we strip off any line terminators at the end.      # Build the prefix.
468      my $prefix = "[$timeStamp] <$LastCategory>: ";      my $level = $LevelNames[$LastLevel] || "($LastLevel)";
469      my $formatted = $prefix . Strip($message);      my $prefix = "[$timeStamp] [$level] [$LastCategory]$callerInfo";
470        # Format the message.
471        my $formatted = "$prefix $stripped";
472      # Process according to the destination.      # Process according to the destination.
473      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
474          # Write the message to the standard output.          # Write the message to the standard output.
475          print "$formatted\n";          print "$formatted\n";
476      } elsif ($Destination eq "ERROR") {      } elsif ($Destination eq "ERROR") {
477          # Write the message to the error output.          # Write the message to the error output. Here, we want our prefix fields.
478          print STDERR "$formatted\n";          print STDERR "$formatted\n";
479        } elsif ($Destination eq "WARN") {
480            # Emit the message to the standard error output. It is presumed that the
481            # error logger will add its own prefix fields, the notable exception being
482            # the caller info.
483            print STDERR "$callerInfo$stripped\n";
484      } elsif ($Destination eq "QUEUE") {      } elsif ($Destination eq "QUEUE") {
485          # Push the message into the queue.          # Push the message into the queue.
486          push @Queue, "$formatted";          push @Queue, "$formatted";
487      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
488          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML and write it to the standard output.
489          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($stripped);
490          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";          print "<p>$timeStamp $LastCategory $LastLevel: $escapedMessage</p>\n";
     } elsif ($Destination eq "WARN") {  
        # Emit the message as a warning.  
        carp $message;  
491      } elsif ($Destination =~ m/^>>/) {      } elsif ($Destination =~ m/^>>/) {
492          # Write the trace message to an output file.          # Write the trace message to an output file.
493          (open TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";          open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
494          print TRACING "$formatted\n";          print TRACING "$formatted\n";
495          close TRACING;          close TRACING;
496          # If the Tee flag is on, echo it to the standard output.          # If the Tee flag is on, echo it to the standard output.
# Line 576  Line 553 
553                  $category = $cats[$#cats];                  $category = $cats[$#cats];
554              }              }
555          }          }
556          # Save the category name.          # Save the category name and level.
557          $LastCategory = $category;          $LastCategory = $category;
558            $LastLevel = $traceLevel;
559          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
560          $category = lc $category;          $category = lc $category;
561          # Use the category and tracelevel to compute the result.          # Use the category and tracelevel to compute the result.
# Line 660  Line 638 
638  sub Confess {  sub Confess {
639      # Get the parameters.      # Get the parameters.
640      my ($message) = @_;      my ($message) = @_;
641        # Set up the category and level.
642        $LastCategory = "(confess)";
643        $LastLevel = 0;
644      if (! defined($FIG_Config::no_tool_hdr)) {      if (! defined($FIG_Config::no_tool_hdr)) {
645          # Here we have a tool header. Display its length so that the user can adjust the line numbers.          # Here we have a tool header. Display its length so that the user can adjust the line numbers.
646          my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";          my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
647          # Only proceed if the tool header file is actually present.          # Only proceed if the tool header file is actually present.
648          if (-f $toolHeaderFile) {          if (-f $toolHeaderFile) {
649              my @lines = GetFile($toolHeaderFile);              my $fh;
650                if (open $fh, "<$toolHeaderFile") {
651                    my @lines = <$fh>;
652              Trace("Tool header has " . scalar(@lines) . " lines.");              Trace("Tool header has " . scalar(@lines) . " lines.");
653          }          }
654      }      }
655        }
656      # Trace the call stack.      # Trace the call stack.
657      Cluck($message);      Cluck($message);
658      # Abort the program.      # Abort the program.
659      croak(">>> $message");      croak(">>> $message");
660  }  }
661    
662    =head3 Warn
663    
664        Warn($message);
665    
666    This method traces an important message. If an RSS feed is configured
667    (via I<FIG_Config::error_feed>) and the tracing destination is C<WARN>,
668    then the message will be echoed to the feed. In general, a tracing
669    destination of C<WARN> indicates that the caller is running as a web
670    service in a production environment; however, this is not a requirement.
671    
672    The L</Cluck> method calls this one for its final message. Since
673    L</Confess> calls L</Cluck>, this means that any error which is caught
674    and confessed will put something in the feed. This insures that someone
675    will be alerted relatively quickly when a failure occurs.
676    
677    =over 4
678    
679    =item message
680    
681    Message to be traced.
682    
683    =back
684    
685    =cut
686    
687    sub Warn {
688        # Get the parameters.
689        my ($message) = @_;
690        # Trace the message.
691        Trace($message);
692        # An error here would be disastrous. Note, however, that we aren't too worried
693        # about losing events. The error log is always available for the occasions where
694        # we mess up.
695        eval {
696            # Do we need to put this in the RSS feed?
697            if ($FIG_Config::error_feed && $Destination eq 'WARN') {
698                # Yes. We now need to compute the date, the link, and the title.
699                # First, the date, in a very specific format.
700                my $date = strftime("%a, %02e %b %H:%M:%S %Y ", localtime) .
701                    (tz_local_offset() / 30);
702                # We'll put the link and title in here.
703                my ($link, $title);
704                # Environment data goes in here.
705                my $environment;
706                # HTML-escape the message.
707                my $escaped = CGI::escapeHTML($message);
708                # If we have a CGI object, then this is a web error. Otherwise, it's
709                # command-line.
710                if (defined $SavedCGI) {
711                    # We're in a web service. The title is the user's IP, and the link
712                    # is the URL that got us here.
713                    my $key = $ENV{HTTP_X_FORWARDED_FOR} || $ENV{REMOTE_ADDR};
714                    $title = "Event Reported at IP address $key: $escaped";
715                    $link = $SavedCGI->url(-full => 1, -query => 1);
716                    # We need the user agent string.
717                    $environment = "User Agent $ENV{HTTP_USER_AGENT}."
718                } else {
719                    # No CGI object, so we're a command-line tool. Use the tracing
720                    # key and the PID as the user identifier.
721                    my $key = EmergencyKey();
722                    $title = "Event Reported by $key Process $$: $escaped";
723                    # Set the link to the development NMPDR. There is really no good
724                    # choice here.
725                    $link = "http://$FIG_Config::dev_server";
726                    # We need the command
727                    $environment = "Command $ENV{_}.";
728                }
729                # Build a GUID. We use the current time, the title, and the process ID,
730                # then digest the result.
731                my $guid = Digest::MD5::md5_base64(gettimeofday(), $title, $$);
732                # Finally, the description. This is a stack trace plus various environmental stuff.
733                my @trace = LongMess();
734                my $trace = join "; ", @trace;
735                my $description = CGI::escapeHTML("$environment Stack trace: $trace");
736                # Okay, we have all the pieces. Create a hash of the new event.
737                my $newItem = { title => $title,
738                                description => $description,
739                                link => $link,
740                                category => $LastCategory,
741                                pubDate => $date,
742                                guid => $guid,
743                               };
744                # We need XML capability for this.
745                require XML::Simple;
746                # The RSS document goes in here.
747                my $rss;
748                # Get the name of the RSS file. It's in the FIG temporary directory.
749                my $fileName = "$FIG_Config::temp/$FIG_Config::error_feed";
750                # Does it exist?
751                if (-s $fileName) {
752                    # Slurp it in.
753                    $rss = XML::Simple::XMLin($fileName, ForceArray => ['item']);
754                } else {
755                    my $size = -s $fileName;
756                    # Create an empty channel.
757                    $rss = {
758                        channel => {
759                            title => 'NMPDR Warning Feed',
760                            link => "$FIG_Config::temp_url/$FIG_Config::error_feed",
761                            description => "Important messages regarding the status of the NMPDR.",
762                            generator => "NMPDR Trace Facility",
763                            docs => "http://blogs.law.harvard.edu/tech/rss",
764                            item => []
765                        },
766                    };
767                }
768                # Get the channel object.
769                my $channel = $rss->{channel};
770                # Update the last-build date.
771                $channel->{lastBuildDate} = $date;
772                # Get the item array.
773                my $items = $channel->{item};
774                # Insure it has only 100 entries.
775                while (scalar @{$items} > 100) {
776                    pop @{$items};
777                }
778                # Add our new item at the front.
779                unshift @{$items}, $newItem;
780                # Replace the file.
781                my $xml = XML::Simple::XMLout($rss, NoAttr => 1, RootName => 'rss', XmlDecl => '<?xml version="1.0" encoding="utf-8"?>',
782                                              NoEscape => 1);
783                # We don't use Open here because we can't afford an error.
784                if (open XMLOUT, ">$fileName") {
785                    print XMLOUT $xml;
786                    close XMLOUT;
787                }
788            }
789        };
790        # There's no "if ($@)" here, because putting an error message in the log
791        # saying that we missed putting an error message in the feed of messages
792        # in the log is not going to help anybody.
793    }
794    
795  =head3 Assert  =head3 Assert
796    
797      Assert($condition1, $condition2, ... $conditionN);      Assert($condition1, $condition2, ... $conditionN);
# Line 725  Line 842 
842      my ($message) = @_;      my ($message) = @_;
843      # Trace what's happening.      # Trace what's happening.
844      Trace("Stack trace for event: $message");      Trace("Stack trace for event: $message");
845      my $confession = longmess($message);      # Get the stack trace.
846      # Convert the confession to a series of trace messages. Note we skip any      my @trace = LongMess();
847      # messages relating to calls into Tracer.      # Convert the trace to a series of messages.
848        for my $line (@trace) {
849            # Replace the tab at the beginning with spaces.
850            $line =~ s/^\t/    /;
851            # Trace the line.
852            Trace($line);
853        }
854        # Issue a warning. This displays the event message and inserts it into the RSS error feed.
855        Warn($message);
856    }
857    
858    =head3 LongMess
859    
860        my @lines = Tracer::LongMess();
861    
862    Return a stack trace with all tracing methods removed. The return will be in the form of a list
863    of message strings.
864    
865    =cut
866    
867    sub LongMess {
868        # Declare the return variable.
869        my @retVal = ();
870        my $confession = longmess("");
871      for my $line (split /\s*\n/, $confession) {      for my $line (split /\s*\n/, $confession) {
872          Trace($line) if ($line !~ /Tracer\.pm/);          unless ($line =~ /Tracer\.pm/) {
873                # Here we have a line worth keeping. Push it onto the result list.
874                push @retVal, $line;
875            }
876      }      }
877        # Return the result.
878        return @retVal;
879  }  }
880    
881  =head3 ScriptSetup  =head3 ScriptSetup (deprecated)
882    
883      my ($cgi, $varHash) = ScriptSetup($noTrace);      my ($cgi, $varHash) = ScriptSetup($noTrace);
884    
# Line 806  Line 951 
951      # Get the parameter.      # Get the parameter.
952      my ($parameter) = @_;      my ($parameter) = @_;
953      # Check for CGI mode.      # Check for CGI mode.
954      my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);      if (defined $parameter && ref $parameter eq 'CGI') {
955            $SavedCGI = $parameter;
956        } else {
957            $SavedCGI = undef;
958        }
959      # Default to no tracing except errors.      # Default to no tracing except errors.
960      my ($tracing, $dest) = ("0", "WARN");      my ($tracing, $dest) = ("0", "WARN");
961      # Check for emergency tracing.      # Check for emergency tracing.
# Line 839  Line 988 
988              # Set the trace parameter.              # Set the trace parameter.
989              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
990          }          }
991      } elsif (defined $cgi) {      } elsif (defined $SavedCGI) {
992          # There's no emergency tracing, but we have a CGI object, so check          # There's no emergency tracing, but we have a CGI object, so check
993          # for tracing from the form parameters.          # for tracing from the form parameters.
994          if ($cgi->param('Trace')) {          if ($SavedCGI->param('Trace')) {
995              # Here the user has requested tracing via a form.              # Here the user has requested tracing via a form.
996              $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");              $dest = ($SavedCGI->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
997              $tracing = $cgi->param('Trace') . " Tracer";              $tracing = $SavedCGI->param('Trace') . " Tracer";
998          }          }
999      }      }
1000      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
1001      TSetup($tracing, $dest);      TSetup($tracing, $dest);
1002      # Check to see if we're a web script.      # Check to see if we're a web script.
1003      if (defined $cgi) {      if (defined $SavedCGI) {
1004          # Yes we are. Trace the form and environment data.          # Yes we are. Trace the form and environment data.
1005          TraceParms($cgi);          TraceParms($SavedCGI);
1006          # Check for RAW mode. In raw mode, we print a fake header so that we see everything          # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1007          # emitted by the script in its raw form.          # emitted by the script in its raw form.
1008          if (T(Raw => 3)) {          if (T(Raw => 3)) {
# Line 958  Line 1107 
1107          $retVal = ">>" . EmergencyFileTarget($tkey);          $retVal = ">>" . EmergencyFileTarget($tkey);
1108      } elsif ($myDest eq 'DUAL') {      } elsif ($myDest eq 'DUAL') {
1109          $retVal = "+>" . EmergencyFileTarget($tkey);          $retVal = "+>" . EmergencyFileTarget($tkey);
1110        } elsif ($myDest eq 'WARN') {
1111            $retVal = "WARN";
1112      }      }
1113      # Return the result.      # Return the result.
1114      return $retVal;      return $retVal;
# Line 1043  Line 1194 
1194      my $retVal;      my $retVal;
1195      # Determine the parameter type.      # Determine the parameter type.
1196      if (! defined $parameter) {      if (! defined $parameter) {
1197          # Here we're supposed to check the environment.          # Here we're supposed to check the environment. If that fails, we
1198          $retVal = $ENV{TRACING};          # get the effective login ID.
1199            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1200      } else {      } else {
1201          my $ptype = ref $parameter;          my $ptype = ref $parameter;
1202          if ($ptype eq 'CGI') {          if ($ptype eq 'CGI') {
# Line 1086  Line 1238 
1238      my ($cgi) = @_;      my ($cgi) = @_;
1239      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1240          # Here we trace the GET-style URL for the script.          # Here we trace the GET-style URL for the script.
1241          Trace("URL: " . $cgi->url(-relative => 1, -query => 1));          Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));
1242      }      }
1243      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1244          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1095  Line 1247 
1247              # Note we skip the Trace parameters, which are for our use only.              # Note we skip the Trace parameters, which are for our use only.
1248              if ($parmName ne 'Trace' && $parmName ne 'TF') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
1249                  my @values = $cgi->param($parmName);                  my @values = $cgi->param($parmName);
1250                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("[CGI] $parmName = " . join(", ", @values));
1251              }              }
1252          }          }
1253          # Display the request method.          # Display the request method.
# Line 1105  Line 1257 
1257      if (T(CGI => 4)) {      if (T(CGI => 4)) {
1258          # Here we want the environment data too.          # Here we want the environment data too.
1259          for my $envName (sort keys %ENV) {          for my $envName (sort keys %ENV) {
1260              Trace("ENV: $envName = $ENV{$envName}");              Trace("[ENV] $envName = $ENV{$envName}");
1261          }          }
1262      }      }
1263  }  }
# Line 1162  Line 1314 
1314  }  }
1315    
1316    
1317  =head3 ScriptFinish  =head3 ScriptFinish (deprecated)
1318    
1319      ScriptFinish($webData, $varHash);      ScriptFinish($webData, $varHash);
1320    
# Line 1620  Line 1772 
1772              # Close the test file.              # Close the test file.
1773              close TESTTRACE;              close TESTTRACE;
1774          } else {          } else {
1775              # Here we can't trace to a file. We trace to the standard output if it's              # Here we can't trace to a file. Complain about this.
1776                warn "Could not open trace file $traceFileName: $!\n";
1777                # We trace to the standard output if it's
1778              # okay, and the error log otherwise.              # okay, and the error log otherwise.
1779              if ($textOKFlag) {              if ($textOKFlag) {
1780                  $traceMode = "TEXT";                  $traceMode = "TEXT";
# Line 2584  Line 2738 
2738  }  }
2739    
2740    
2741    =head3 PrintLine
2742    
2743        Tracer::PrintLine($line);
2744    
2745    Print a line of text with a trailing new-line.
2746    
2747    =over 4
2748    
2749    =item line
2750    
2751    Line of text to print.
2752    
2753    =back
2754    
2755    =cut
2756    
2757    sub PrintLine {
2758        # Get the parameters.
2759        my ($line) = @_;
2760        # Print the line.
2761        print "$line\n";
2762    }
2763    
2764    
2765  =head2 Other Useful Methods  =head2 Other Useful Methods
2766    
# Line 2624  Line 2801 
2801      return $retVal;      return $retVal;
2802  }  }
2803    
   
   
   
2804  =head3 Now  =head3 Now
2805    
2806      my $string = Tracer::Now();      my $string = Tracer::Now();
2807    
2808  Return a displayable time stamp containing the local time.  Return a displayable time stamp containing the local time. Whatever format this
2809    method produces must be parseable by L</ParseDate>.
2810    
2811  =cut  =cut
2812    
2813  sub Now {  sub Now {
2814      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      return DisplayTime(time);
2815      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .  }
2816    
2817    =head3 DisplayTime
2818    
2819        my $string = Tracer::DisplayTime($time);
2820    
2821    Convert a time value to a displayable time stamp. Whatever format this
2822    method produces must be parseable by L</ParseDate>.
2823    
2824    =over 4
2825    
2826    =item time
2827    
2828    Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
2829    
2830    =item RETURN
2831    
2832    Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
2833    
2834    =back
2835    
2836    =cut
2837    
2838    sub DisplayTime {
2839        my ($time) = @_;
2840        my $retVal = "(n/a)";
2841        if (defined $time) {
2842            my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
2843            $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
2844                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
2845        }
2846      return $retVal;      return $retVal;
2847  }  }
2848    
# Line 2802  Line 3006 
3006      return $retVal;      return $retVal;
3007  }  }
3008    
3009    =head3 Constrain
3010    
3011        my $constrained = Constrain($value, $min, $max);
3012    
3013    Modify a numeric value to bring it to a point in between a maximum and a minimum.
3014    
3015    =over 4
3016    
3017    =item value
3018    
3019    Value to constrain.
3020    
3021    =item min (optional)
3022    
3023    Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3024    
3025    =item max (optional)
3026    
3027    Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3028    
3029    =item RETURN
3030    
3031    Returns the incoming value, constrained according to the other parameters.
3032    
3033    =back
3034    
3035    =cut
3036    
3037    sub Constrain {
3038        # Get the parameters.
3039        my ($value, $min, $max) = @_;
3040        # Declare the return variable.
3041        my $retVal = $value;
3042        # Apply the minimum constraint.
3043        if (defined $min && $retVal < $min) {
3044            $retVal = $min;
3045        }
3046        # Apply the maximum constraint.
3047        if (defined $max && $retVal > $max) {
3048            $retVal = $max;
3049        }
3050        # Return the result.
3051        return $retVal;
3052    }
3053    
3054  =head3 Min  =head3 Min
3055    
3056      my $min = Min($value1, $value2, ... $valueN);      my $min = Min($value1, $value2, ... $valueN);
# Line 2868  Line 3117 
3117      return $retVal;      return $retVal;
3118  }  }
3119    
 =head3 DebugMode  
   
     if (Tracer::DebugMode) { ...code... }  
   
 Return TRUE if debug mode has been turned on, else abort.  
   
 Certain CGI scripts are too dangerous to exist in the production  
 environment. This method provides a simple way to prevent them  
 from working unless they are explicitly turned on by creating a password  
 cookie via the B<SetPassword> script.  If debugging mode  
 is not turned on, an error will occur.  
   
 =cut  
   
 sub DebugMode {  
     # Declare the return variable.  
     my $retVal = 0;  
     # Check the debug configuration.  
     my $password = CGI::cookie("DebugMode");  
     my $encrypted = Digest::MD5::md5_hex($password);  
     if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {  
         $retVal = 1;  
     } else {  
         # Here debug mode is off, so we generate an error.  
         Confess("Cannot use this facility without logging in.");  
     }  
     # Return the determination indicator.  
     return $retVal;  
 }  
3120    
3121  =head3 Strip  =head3 Strip
3122    
# Line 3340  Line 3560 
3560  }  }
3561    
3562    
3563    =head3 TrackingCode
3564    
3565        my $html = Tracer::TrackingCode();
3566    
3567    Returns the HTML code for doing web page traffic monitoring. If the
3568    current environment is a test system, then it returns a null string;
3569    otherwise, it returns a bunch of javascript containing code for turning
3570    on SiteMeter and Google Analytics.
3571    
3572    =cut
3573    
3574    sub TrackingCode {
3575        # Declare the return variable.
3576        my $retVal = "<!-- tracking off -->";
3577        # Determine if we're in production.
3578        if ($FIG_Config::site_meter) {
3579            $retVal = <<END_HTML
3580            <!-- Site Meter -->
3581            <script type="text/javascript" src="http://s20.sitemeter.com/js/counter.js?site=s20nmpdr">
3582            </script>
3583            <noscript>
3584            <a href="http://s20.sitemeter.com/stats.asp?site=s20nmpdr" target="_top">
3585            <img src="http://s20.sitemeter.com/meter.asp?site=s20nmpdr" alt="Site Meter" border="0"/></a>
3586            </noscript>
3587            <!-- Copyright (c)2006 Site Meter -->
3588    END_HTML
3589        }
3590        return $retVal;
3591    }
3592    
3593    
3594  1;  1;

Legend:
Removed from v.1.95  
changed lines
  Added in v.1.99

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3