[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.120, Thu Jun 4 18:27:33 2009 UTC
# Line 18  Line 18 
18    
19  package Tracer;  package Tracer;
20    
     require Exporter;  
     @ISA = ('Exporter');  
     @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);  
     @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);  
21      use strict;      use strict;
22      use Carp qw(longmess croak);      use base qw(Exporter);
23        use vars qw(@EXPORT @EXPORT_OK);
24        @EXPORT = qw(Trace T TSetup QTrace Confess MemTrace Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency Warn TraceDump IDHASH);
25        @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
26        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        use Fcntl qw(:DEFAULT :flock);
42        use Data::Dumper;
43    
44    
45  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
46    
# Line 160  Line 165 
165    
166  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
167  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
168  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
169  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
170  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
171  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
172  the tracing in your environment without stepping on other users.  the tracing in your environment without stepping on other users.
# Line 184  Line 189 
189    
190  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
191  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
192  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing  using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
193  will be configured automatically.  will be configured automatically.
194    
 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.  
   
195  =cut  =cut
196    
197  # Declare the configuration variables.  # Declare the configuration variables.
# Line 290  Line 201 
201                              # standard output                              # standard output
202  my %Categories = ( main => 1 );  my %Categories = ( main => 1 );
203                              # hash of active category names                              # hash of active category names
204    my @LevelNames = qw(error warn notice info detail);
205  my $TraceLevel = 0;         # trace level; a higher trace level produces more  my $TraceLevel = 0;         # trace level; a higher trace level produces more
206                              # messages                              # messages
207  my @Queue = ();             # queued list of trace messages.  my @Queue = ();             # queued list of trace messages.
208  my $LastCategory = "main";  # name of the last category interrogated  my $LastCategory = "main";  # name of the last category interrogated
209    my $LastLevel = 0;          # level of the last test call
210  my $SetupCount = 0;         # number of times TSetup called  my $SetupCount = 0;         # number of times TSetup called
211  my $AllTrace = 0;           # TRUE if we are tracing all categories.  my $AllTrace = 0;           # TRUE if we are tracing all categories.
212    my $SavedCGI;               # CGI object passed to ETracing
213    my $CommandLine;            # Command line passed to StandardSetup
214    my $Confessions = 0;        # confession count
215    umask 2;                    # Fix the damn umask so everything is group-writable.
216    
217  =head2 Tracing Methods  =head2 Tracing Methods
218    
# Line 366  Line 283 
283          }          }
284      }      }
285      # Now we need to process the destination information. The most important special      # Now we need to process the destination information. The most important special
286      # 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
287      # "+" prefix which indicates a double echo.      # ">>" (append). A leading "+" for either indicates that we are also writing to
288        # the standard output (tee mode).
289      if ($target =~ m/^\+?>>?/) {      if ($target =~ m/^\+?>>?/) {
290          if ($target =~ m/^\+/) {          if ($target =~ m/^\+/) {
291              $TeeFlag = 1;              $TeeFlag = 1;
292              $target = substr($target, 1);              $target = substr($target, 1);
293          }          }
294          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
295                # We need to initialize the file (which clears it).
296              open TRACEFILE, $target;              open TRACEFILE, $target;
297              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] [notice] [Tracer] Tracing initialized.\n";
298              close TRACEFILE;              close TRACEFILE;
299                # Set to append mode now that the file has been cleared.
300              $Destination = ">$target";              $Destination = ">$target";
301          } else {          } else {
302              $Destination = $target;              $Destination = $target;
# Line 408  Line 328 
328      $TraceLevel = $_[0];      $TraceLevel = $_[0];
329  }  }
330    
331  =head3 ParseTraceDate  =head3 ParseDate
332    
333        my $time = Tracer::ParseDate($dateString);
334    
335      my $time = Tracer::ParseTraceDate($dateString);  Convert a date into a PERL time number. This method expects a date-like string
336    and parses it into a number. The string must be vaguely date-like or it will
337    return an undefined value. Our requirement is that a month and day be
338    present and that three pieces of the date string (time of day, month and day,
339    year) be separated by likely delimiters, such as spaces, commas, and such-like.
340    
341  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
342    everything but the hour.
343    
344    The year must be exactly four digits.
345    
346    Additional stuff can be in the string. We presume it's time zones or weekdays or something
347    equally innocuous. This means, however, that a sufficiently long sentence with date-like
348    parts in it may be interpreted as a date. Hopefully this will not be a problem.
349    
350    It should be guaranteed that this method will parse the output of the L</Now> function.
351    
352    The parameters are as follows.
353    
354  =over 4  =over 4
355    
356  =item dateString  =item dateString
357    
358  The date string from the trace file. The format of the string is determined by the  The date string to convert.
 L</Now> method.  
359    
360  =item RETURN  =item RETURN
361    
362  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
363  the time string is invalid.  the date string is invalid. A valid date string must contain a month and day.
364    
365  =back  =back
366    
367  =cut  =cut
368    
369  sub ParseTraceDate {  # Universal month conversion table.
370    use constant MONTHS => {    Jan =>  0, January   =>  0, '01' =>  0,  '1' =>  0,
371                                Feb =>  1, February  =>  1, '02' =>  1,  '2' =>  1,
372                                Mar =>  2, March     =>  2, '03' =>  2,  '3' =>  2,
373                                Apr =>  3, April     =>  3, '04' =>  3,  '4' =>  3,
374                                May =>  4, May       =>  4, '05' =>  4,  '5' =>  4,
375                                Jun =>  5, June      =>  5, '06' =>  5,  '6' =>  5,
376                                Jul =>  6, July      =>  6, '07' =>  6,  '7' =>  6,
377                                Aug =>  7, August    =>  7, '08' =>  7,  '8' =>  7,
378                                Sep =>  8, September =>  8, '09' =>  8,  '9' =>  8,
379                                Oct =>  9, October  =>   9, '10' =>  9,
380                                Nov => 10, November =>  10, '11' => 10,
381                                Dec => 11, December =>  11, '12' => 11
382                            };
383    
384    sub ParseDate {
385      # Get the parameters.      # Get the parameters.
386      my ($dateString) = @_;      my ($dateString) = @_;
387      # Declare the return variable.      # Declare the return variable.
388      my $retVal;      my $retVal;
389      # Parse the date.      # Find the month and day of month. There are two ways that can happen. We check for the
390      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
391          # Create a time object. Note we need to convert the day, month,      # won't be fooled into thinking the month is Sunday.
392          # 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#) {
393          # the internal month value is relocated to January = 0.          my ($mon, $mday) = (MONTHS->{$1}, $2);
394          $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);          # Insist that the month and day are valid.
395            if (defined($mon) && $2 >= 1 && $2 <= 31) {
396                # Find the time.
397                my ($hour, $min, $sec) = (0, 0, 0);
398                if ($dateString =~ /\b(\d{1,2}):(\d{2}):(\d{2})\b/) {
399                    ($hour, $min, $sec) = ($1, $2, $3);
400                }
401                # Find the year.
402                my $year;
403                if ($dateString =~ /\b(\d{4})\b/) {
404                    $year = $1;
405                } else {
406                    # Get the default year, which is this one. Note we must convert it to
407                    # the four-digit value expected by "timelocal".
408                    (undef, undef, undef, undef, undef, $year) = localtime();
409                    $year += 1900;
410                }
411                $retVal = timelocal($sec, $min, $hour, $mday, $mon, $year);
412            }
413      }      }
414      # Return the result.      # Return the result.
415      return $retVal;      return $retVal;
# Line 489  Line 458 
458  sub Trace {  sub Trace {
459      # Get the parameters.      # Get the parameters.
460      my ($message) = @_;      my ($message) = @_;
461        # Strip off any line terminators at the end of the message. We will add
462        # new-line stuff ourselves.
463        my $stripped = Strip($message);
464        # Compute the caller information.
465        my ($callPackage, $callFile, $callLine) = caller();
466        my $callFileTitle = basename($callFile);
467        # Check the caller.
468        my $callerInfo = ($callFileTitle ne "Tracer.pm" ? " [$callFileTitle $callLine]" : "");
469      # Get the timestamp.      # Get the timestamp.
470      my $timeStamp = Now();      my $timeStamp = Now();
471      # Format the message. Note we strip off any line terminators at the end.      # Build the prefix.
472      my $prefix = "[$timeStamp] <$LastCategory>: ";      my $level = $LevelNames[$LastLevel] || "($LastLevel)";
473      my $formatted = $prefix . Strip($message);      my $prefix = "[$timeStamp] [$level] [$LastCategory]$callerInfo";
474        # Format the message.
475        my $formatted = "$prefix $stripped";
476      # Process according to the destination.      # Process according to the destination.
477      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
478          # Write the message to the standard output.          # Write the message to the standard output.
479          print "$formatted\n";          print "$formatted\n";
480      } elsif ($Destination eq "ERROR") {      } elsif ($Destination eq "ERROR") {
481          # Write the message to the error output.          # Write the message to the error output. Here, we want our prefix fields.
482          print STDERR "$formatted\n";          print STDERR "$formatted\n";
483        } elsif ($Destination eq "WARN") {
484            # Emit the message to the standard error output. It is presumed that the
485            # error logger will add its own prefix fields, the notable exception being
486            # the caller info.
487            print STDERR "$callerInfo$stripped\n";
488      } elsif ($Destination eq "QUEUE") {      } elsif ($Destination eq "QUEUE") {
489          # Push the message into the queue.          # Push the message into the queue.
490          push @Queue, "$formatted";          push @Queue, "$formatted";
491      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
492          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML.
493          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($stripped);
494          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";          # The stuff after the first line feed should be pre-formatted.
495      } elsif ($Destination eq "WARN") {          my @lines = split /\s*\n/, $escapedMessage;
496         # Emit the message as a warning.          # Get the normal portion.
497         carp $message;          my $line1 = shift @lines;
498            print "<p>$timeStamp $LastCategory $LastLevel: $line1</p>\n";
499            if (@lines) {
500                print "<pre>" . join("\n", @lines, "</pre>");
501            }
502      } elsif ($Destination =~ m/^>>/) {      } elsif ($Destination =~ m/^>>/) {
503          # Write the trace message to an output file.          # Write the trace message to an output file.
504          (open TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";          open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
505            # Lock the file.
506            flock TRACING, LOCK_EX;
507          print TRACING "$formatted\n";          print TRACING "$formatted\n";
508          close TRACING;          close TRACING;
509          # 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 523  Line 513 
513      }      }
514  }  }
515    
516    =head3 MemTrace
517    
518        MemTrace($message);
519    
520    Output a trace message that includes memory size information.
521    
522    =over 4
523    
524    =item message
525    
526    Message to display. The message will be followed by a sentence about the memory size.
527    
528    =back
529    
530    =cut
531    
532    sub MemTrace {
533        # Get the parameters.
534        my ($message) = @_;
535        my $memory = GetMemorySize();
536        Trace("$message $memory in use.");
537    }
538    
539    
540    =head3 TraceDump
541    
542        TraceDump($title, $object);
543    
544    Dump an object to the trace log. This method simply calls the C<Dumper>
545    function, but routes the output to the trace log instead of returning it
546    as a string. The output is arranged so that it comes out monospaced when
547    it appears in an HTML trace dump.
548    
549    =over 4
550    
551    =item title
552    
553    Title to give to the object being dumped.
554    
555    =item object
556    
557    Reference to a list, hash, or object to dump.
558    
559    =back
560    
561    =cut
562    
563    sub TraceDump {
564        # Get the parameters.
565        my ($title, $object) = @_;
566        # Trace the object.
567        Trace("Object dump for $title:\n" . Dumper($object));
568    }
569    
570  =head3 T  =head3 T
571    
572      my $switch = T($category, $traceLevel);      my $switch = T($category, $traceLevel);
# Line 576  Line 620 
620                  $category = $cats[$#cats];                  $category = $cats[$#cats];
621              }              }
622          }          }
623          # Save the category name.          # Save the category name and level.
624          $LastCategory = $category;          $LastCategory = $category;
625            $LastLevel = $traceLevel;
626          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
627          $category = lc $category;          $category = lc $category;
628          # Use the category and tracelevel to compute the result.          # Validate the trace level.
629          if (ref $traceLevel) {          if (ref $traceLevel) {
630              Confess("Bad trace level.");              Confess("Bad trace level.");
631          } elsif (ref $TraceLevel) {          } elsif (ref $TraceLevel) {
632              Confess("Bad trace config.");              Confess("Bad trace config.");
633          }          }
634          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));          # Make the check. Note that level 0 shows even if the category is turned off.
635            $retVal = ($traceLevel <= $TraceLevel && ($traceLevel == 0 || $AllTrace || exists $Categories{$category}));
636      }      }
637      # Return the computed result.      # Return the computed result.
638      return $retVal;      return $retVal;
# Line 660  Line 706 
706  sub Confess {  sub Confess {
707      # Get the parameters.      # Get the parameters.
708      my ($message) = @_;      my ($message) = @_;
709      if (! defined($FIG_Config::no_tool_hdr)) {      # Set up the category and level.
710          # Here we have a tool header. Display its length so that the user can adjust the line numbers.      $LastCategory = "(confess)";
711          my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";      $LastLevel = 0;
         # Only proceed if the tool header file is actually present.  
         if (-f $toolHeaderFile) {  
             my @lines = GetFile($toolHeaderFile);  
             Trace("Tool header has " . scalar(@lines) . " lines.");  
         }  
     }  
712      # Trace the call stack.      # Trace the call stack.
713      Cluck($message);      Cluck($message);
714        # Increment the confession count.
715        $Confessions++;
716      # Abort the program.      # Abort the program.
717      croak(">>> $message");      croak(">>> $message");
718  }  }
719    
720    =head3 Confessions
721    
722        my $count = Tracer::Confessions();
723    
724    Return the number of calls to L</Confess> by the current task.
725    
726    =cut
727    
728    sub Confessions {
729        return $Confessions;
730    }
731    
732    
733    =head3 SaveCGI
734    
735        Tracer::SaveCGI($cgi);
736    
737    This method saves the CGI object but does not activate emergency tracing.
738    It is used to allow L</Warn> to work in situations where emergency
739    tracing is contra-indicated (e.g. the wiki).
740    
741    =over 4
742    
743    =item cgi
744    
745    Active CGI query object.
746    
747    =back
748    
749    =cut
750    
751    sub SaveCGI {
752        $SavedCGI = $_[0];
753    }
754    
755    =head3 Warn
756    
757        Warn($message, @options);
758    
759    This method traces an important message. If an RSS feed is configured
760    (via I<FIG_Config::error_feed>) and the tracing destination is C<WARN>,
761    then the message will be echoed to the feed. In general, a tracing
762    destination of C<WARN> indicates that the caller is running as a web
763    service in a production environment; however, this is not a requirement.
764    
765    To force warnings into the RSS feed even when the tracing destination
766    is not C<WARN>, simply specify the C<Feed> tracing module. This can be
767    configured automatically when L</StandardSetup> is used.
768    
769    The L</Cluck> method calls this one for its final message. Since
770    L</Confess> calls L</Cluck>, this means that any error which is caught
771    and confessed will put something in the feed. This insures that someone
772    will be alerted relatively quickly when a failure occurs.
773    
774    =over 4
775    
776    =item message
777    
778    Message to be traced.
779    
780    =item options
781    
782    A list containing zero or more options.
783    
784    =back
785    
786    The permissible options are as follows.
787    
788    =over 4
789    
790    =item noStack
791    
792    If specified, then the stack trace is not included in the output.
793    
794    =back
795    
796    =cut
797    
798    sub Warn {
799        # Get the parameters.
800        my $message = shift @_;
801        my %options = map { $_ => 1 } @_;
802        # Save $@;
803        my $savedError = $@;
804        # Trace the message.
805        Trace($message);
806        # This will contain the lock handle. If it's defined, it means we need to unlock.
807        my $lock;
808        # Check for feed forcing.
809        my $forceFeed = exists $Categories{feed};
810        # An error here would be disastrous. Note that if debug mode is specified,
811        # we do this stuff even in a test environment.
812        eval {
813            # Do we need to put this in the RSS feed?
814            if ($FIG_Config::error_feed && ($Destination eq 'WARN' || $forceFeed)) {
815                # Probably. We need to check first, however, to see if it's from an
816                # ignored IP. For non-CGI situations, we default the IP to the self-referent.
817                my $key = "127.0.0.1";
818                if (defined $SavedCGI) {
819                    # Get the IP address.
820                    $key = $ENV{HTTP_X_FORWARDED_FOR} || $ENV{REMOTE_ADDR};
821                }
822                # Is the IP address in the ignore list?
823                my $found = scalar(grep { $_ eq $key } @FIG_Config::error_ignore_ips);
824                if (! $found) {
825                    # No. We're good. We now need to compute the date, the link, and the title.
826                    # First, the date, in a very specific format.
827                    my $date = strftime("%a, %02e %b %H:%M:%S %Y ", localtime) .
828                        (tz_local_offset() / 30);
829                    # Environment data goes in here. We start with the date.
830                    my $environment = "$date.  ";
831                    # If we need to recap the message (because it's too long to be a title), we'll
832                    # put it in here.
833                    my $recap;
834                    # Copy the message and remove excess space.
835                    my $title = $message;
836                    $title =~ s/\s+/ /gs;
837                    # If it's too long, we have to split it up.
838                    if (length $title > 60) {
839                        # Put the full message in the environment string.
840                        $recap = $title;
841                        # Excerpt it as the title.
842                        $title = substr($title, 0, 50) . "...";
843                    }
844                    # If we have a CGI object, then this is a web error. Otherwise, it's
845                    # command-line.
846                    if (defined $SavedCGI) {
847                        # We're in a web service. The environment is the user's IP, and the link
848                        # is the URL that got us here.
849                        $environment .= "Event Reported at IP address $key process $$.";
850                        my $url = $SavedCGI->self_url();
851                        # We need the user agent string and (if available) the referrer.
852                        # The referrer will be the link.
853                        $environment .= " User Agent $ENV{HTTP_USER_AGENT}";
854                        if ($ENV{HTTP_REFERER}) {
855                            my $link = $ENV{HTTP_REFERER};
856                            $environment .= " referred from <a href=\"$link\">$link</a>.";
857                        } else {
858                            $environment .= " referrer unknown.";
859                        }
860                        # Close off the sentence with the original link.
861                        $environment .= " URL of event is <a href=\"$url\">$url</a>.";
862                    } else {
863                        # No CGI object, so we're a command-line tool. Use the tracing
864                        # key and the PID as the user identifier, and add the command.
865                        my $key = EmergencyKey();
866                        $environment .= "Event Reported by $key process $$.";
867                        if ($CommandLine) {
868                            # We're in a StandardSetup script, so we have the real command line.
869                            $environment .= "\n<pre>" . CGI::escapeHTML($CommandLine) . "</pre>\n";
870                        } elsif ($ENV{_}) {
871                            # We're in a BASH script, so the command has been stored in the _ variable.
872                            $environment .= "  Command = " . CGI::escapeHTML($ENV{_}) . "\n";
873                        }
874                    }
875                    # Build a GUID. We use the current time, the title, and the process ID,
876                    # then digest the result.
877                    my $guid = Digest::MD5::md5_base64(gettimeofday(), $title, $$);
878                    # Finally, the description. This is a stack trace plus various environmental stuff.
879                    # The trace is optional.
880                    my $stackTrace;
881                    if ($options{noStack}) {
882                        $stackTrace = "";
883                    } else {
884                        my @trace = LongMess();
885                        # Only proceed if we got something back.
886                        if (scalar(@trace) > 0) {
887                            $trace[0] =~ s/Tracer::Warn.+?called/Event occurred/;
888                            $stackTrace = "Stack trace:<pre>" . join("\n", @trace, "</pre>");
889                        }
890                    }
891                    # We got the stack trace. Now it's time to put it all together.
892                    # We have a goofy thing here in that we need to HTML-escape some sections of the description
893                    # twice. They will be escaped once here, and then once when written by XML::Simple. They are
894                    # unescaped once when processed by the RSS reader, and stuff in the description is treated as
895                    # HTML. So, anything escaped here is treated as a literal when viewed in the RSS reader, but
896                    # our <br>s and <pre>s are used to format the description.
897                    $recap = (defined $recap ? "<em>" . CGI::escapeHTML($recap) . "</em><br /><br />" : "");
898                    my $description = "$recap$environment  $stackTrace";
899                    # Okay, we have all the pieces. Create a hash of the new event.
900                    my $newItem = { title => $title,
901                                    description => $description,
902                                    category => $LastCategory,
903                                    pubDate => $date,
904                                    guid => $guid,
905                                  };
906                    # We need XML capability for this.
907                    require XML::Simple;
908                    # The RSS document goes in here.
909                    my $rss;
910                    # Get the name of the RSS file. It's in the FIG temporary directory.
911                    my $fileName = "$FIG_Config::temp/$FIG_Config::error_feed";
912                    # Open the config file and lock it.
913                    $lock = Open(undef, "<$FIG_Config::fig_disk/config/FIG_Config.pm");
914                    flock $lock, LOCK_EX;
915                    # Does it exist?
916                    if (-s $fileName) {
917                        # Slurp it in.
918                        $rss = XML::Simple::XMLin($fileName, ForceArray => ['item']);
919                    } else {
920                        my $size = -s $fileName;
921                        # Create an empty channel.
922                        $rss = {
923                            channel => {
924                                title => 'NMPDR Warning Feed',
925                                link => "$FIG_Config::temp_url/$FIG_Config::error_feed",
926                                description => "Important messages regarding the status of the NMPDR.",
927                                generator => "NMPDR Trace Facility",
928                                docs => "http://blogs.law.harvard.edu/tech/rss",
929                                item => []
930                            },
931                        };
932                    }
933                    # Get the channel object.
934                    my $channel = $rss->{channel};
935                    # Update the last-build date.
936                    $channel->{lastBuildDate} = $date;
937                    # Get the item array.
938                    my $items = $channel->{item};
939                    # Insure it has only 100 entries.
940                    while (scalar @{$items} > 100) {
941                        pop @{$items};
942                    }
943                    # Add our new item at the front.
944                    unshift @{$items}, $newItem;
945                    # Create the XML. Note we do not include the root or the declaration. XML Simple can't handle
946                    # the requirements for those.
947                    my $xml = XML::Simple::XMLout($channel, NoAttr => 1, RootName => 'channel', XmlDecl => '');
948                    # Here we put in the root and declaration. The problem is that the root has to have the version attribute
949                    # in it. So, we suppress the root and do it by hand, and that requires suppressing the declaration, too.
950                    $xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<rss version=\"2.0\">$xml\n</rss>";
951                    # We don't use Open here because we can't afford an error.
952                    if (open XMLOUT, ">$fileName") {
953                        print XMLOUT $xml;
954                        close XMLOUT;
955                    }
956                }
957            }
958        };
959        if ($@) {
960            # If the feed failed, we need to know why. The error will be traced, but this method will not be involved
961            # (which is a good thing).
962            my $error = $@;
963            Trace("Feed Error: $error") if T(Feed => 0);
964        }
965        # Be sure to unlock.
966        if ($lock) {
967            flock $lock, LOCK_UN;
968            undef $lock;
969        }
970        # Restore the error message.
971        $@ = $savedError;
972    }
973    
974    
975    
976    
977  =head3 Assert  =head3 Assert
978    
979      Assert($condition1, $condition2, ... $conditionN);      Assert($condition1, $condition2, ... $conditionN);
# Line 725  Line 1024 
1024      my ($message) = @_;      my ($message) = @_;
1025      # Trace what's happening.      # Trace what's happening.
1026      Trace("Stack trace for event: $message");      Trace("Stack trace for event: $message");
1027      my $confession = longmess($message);      # Get the stack trace.
1028      # Convert the confession to a series of trace messages. Note we skip any      my @trace = LongMess();
1029      # messages relating to calls into Tracer.      # Convert the trace to a series of messages.
1030      for my $line (split /\s*\n/, $confession) {      for my $line (@trace) {
1031          Trace($line) if ($line !~ /Tracer\.pm/);          # Replace the tab at the beginning with spaces.
1032            $line =~ s/^\t/    /;
1033            # Trace the line.
1034            Trace($line);
1035      }      }
1036        # Issue a warning. This displays the event message and inserts it into the RSS error feed.
1037        Warn($message);
1038  }  }
1039    
1040  =head3 ScriptSetup  =head3 LongMess
   
     my ($cgi, $varHash) = ScriptSetup($noTrace);  
   
 Perform standard tracing and debugging setup for scripts. The value returned is  
 the CGI object followed by a pre-built variable hash. At the end of the script,  
 the client should call L</ScriptFinish> to output the web page.  
   
 This method calls L</ETracing> to configure tracing, which allows the tracing  
 to be configured via the emergency tracing form on the debugging control panel.  
 Tracing will then be turned on automatically for all programs that use the L</ETracing>  
 method, which includes every program that uses this method or L</StandardSetup>.  
   
 =over 4  
   
 =item noTrace (optional)  
   
 If specified, tracing will be suppressed. This is useful if the script wants to set up  
 tracing manually.  
   
 =item RETURN  
1041    
1042  Returns a two-element list consisting of a CGI query object and a variable hash for      my @lines = Tracer::LongMess();
 the output page.  
1043    
1044  =back  Return a stack trace with all tracing methods removed. The return will be in the form of a list
1045    of message strings.
1046    
1047  =cut  =cut
1048    
1049  sub ScriptSetup {  sub LongMess {
1050      # Get the parameters.      # Declare the return variable.
1051      my ($noTrace) = @_;      my @retVal = ();
1052      # Get the CGI query object.      my $confession = longmess("");
1053      my $cgi = CGI->new();      for my $line (split /\s*\n/, $confession) {
1054      # Set up tracing if it's not suppressed.          unless ($line =~ /Tracer\.pm/) {
1055      ETracing($cgi) unless $noTrace;              # Here we have a line worth keeping. Push it onto the result list.
1056      # Create the variable hash.              push @retVal, $line;
1057      my $varHash = { results => '' };          }
1058      # Return the query object and variable hash.      }
1059      return ($cgi, $varHash);      # Return the result.
1060        return @retVal;
1061  }  }
1062    
1063  =head3 ETracing  =head3 ETracing
# Line 806  Line 1091 
1091      # Get the parameter.      # Get the parameter.
1092      my ($parameter) = @_;      my ($parameter) = @_;
1093      # Check for CGI mode.      # Check for CGI mode.
1094      my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);      if (defined $parameter && ref $parameter eq 'CGI') {
1095            $SavedCGI = $parameter;
1096        } else {
1097            $SavedCGI = undef;
1098        }
1099      # Default to no tracing except errors.      # Default to no tracing except errors.
1100      my ($tracing, $dest) = ("0", "WARN");      my ($tracing, $dest) = ("0", "WARN");
1101      # Check for emergency tracing.      # Check for emergency tracing.
# Line 839  Line 1128 
1128              # Set the trace parameter.              # Set the trace parameter.
1129              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
1130          }          }
1131      } elsif (defined $cgi) {      } elsif (defined $SavedCGI) {
1132          # 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
1133          # for tracing from the form parameters.          # for tracing from the form parameters.
1134          if ($cgi->param('Trace')) {          if ($SavedCGI->param('Trace')) {
1135              # Here the user has requested tracing via a form.              # Here the user has requested tracing via a form.
1136              $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");              $dest = ($SavedCGI->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
1137              $tracing = $cgi->param('Trace') . " Tracer";              $tracing = $SavedCGI->param('Trace') . " Tracer";
1138          }          }
1139      }      }
1140      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
1141      TSetup($tracing, $dest);      TSetup($tracing, $dest);
1142      # Check to see if we're a web script.      # Check to see if we're a web script.
1143      if (defined $cgi) {      if (defined $SavedCGI) {
1144          # Yes we are. Trace the form and environment data.          # Yes we are. Trace the form and environment data.
1145          TraceParms($cgi);          TraceParms($SavedCGI);
1146          # 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
1147          # emitted by the script in its raw form.          # emitted by the script in its raw form.
1148          if (T(Raw => 3)) {          if (T(Raw => 3)) {
# Line 958  Line 1247 
1247          $retVal = ">>" . EmergencyFileTarget($tkey);          $retVal = ">>" . EmergencyFileTarget($tkey);
1248      } elsif ($myDest eq 'DUAL') {      } elsif ($myDest eq 'DUAL') {
1249          $retVal = "+>" . EmergencyFileTarget($tkey);          $retVal = "+>" . EmergencyFileTarget($tkey);
1250        } elsif ($myDest eq 'WARN') {
1251            $retVal = "WARN";
1252      }      }
1253      # Return the result.      # Return the result.
1254      return $retVal;      return $retVal;
# Line 1042  Line 1333 
1333      # Declare the return variable.      # Declare the return variable.
1334      my $retVal;      my $retVal;
1335      # Determine the parameter type.      # Determine the parameter type.
1336      if (! defined $parameter) {      if (! defined $parameter || defined($ENV{TRACING})) {
1337          # Here we're supposed to check the environment.          # Here we're supposed to check the environment. If that fails, we
1338          $retVal = $ENV{TRACING};          # get the effective login ID.
1339            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1340      } else {      } else {
1341          my $ptype = ref $parameter;          my $ptype = ref $parameter;
1342          if ($ptype eq 'CGI') {          if ($ptype eq 'CGI') {
# Line 1085  Line 1377 
1377      # Get the parameters.      # Get the parameters.
1378      my ($cgi) = @_;      my ($cgi) = @_;
1379      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1380          # Here we trace the GET-style URL for the script.          # Here we trace the GET-style URL for the script, but only if it's
1381          Trace("URL: " . $cgi->url(-relative => 1, -query => 1));          # relatively small.
1382            my $url = $cgi->url(-relative => 1, -query => 1);
1383            my $len = length($url);
1384            if ($len < 500) {
1385                Trace("[URL] $url");
1386            } elsif ($len > 2048) {
1387                Trace("[URL] URL is too long to use with GET ($len characters).");
1388            } else {
1389                Trace("[URL] URL length is $len characters.");
1390            }
1391      }      }
1392      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1393          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1095  Line 1396 
1396              # Note we skip the Trace parameters, which are for our use only.              # Note we skip the Trace parameters, which are for our use only.
1397              if ($parmName ne 'Trace' && $parmName ne 'TF') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
1398                  my @values = $cgi->param($parmName);                  my @values = $cgi->param($parmName);
1399                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("[CGI] $parmName = " . join(", ", @values));
1400              }              }
1401          }          }
1402          # Display the request method.          # Display the request method.
# Line 1105  Line 1406 
1406      if (T(CGI => 4)) {      if (T(CGI => 4)) {
1407          # Here we want the environment data too.          # Here we want the environment data too.
1408          for my $envName (sort keys %ENV) {          for my $envName (sort keys %ENV) {
1409              Trace("ENV: $envName = $ENV{$envName}");              Trace("[ENV] $envName = $ENV{$envName}");
1410          }          }
1411      }      }
1412  }  }
# Line 1161  Line 1462 
1462      }      }
1463  }  }
1464    
1465    =head2 Command-Line Utility Methods
1466    
1467  =head3 ScriptFinish  =head3 SendSMS
   
     ScriptFinish($webData, $varHash);  
1468    
1469  Output a web page at the end of a script. Either the string to be output or the      my $msgID = Tracer::SendSMS($phoneNumber, $msg);
 name of a template file can be specified. If the second parameter is omitted,  
 it is assumed we have a string to be output; otherwise, it is assumed we have the  
 name of a template file. The template should have the variable C<DebugData>  
 specified in any form that invokes a standard script. If debugging mode is turned  
 on, a form field will be put in that allows the user to enter tracing data.  
 Trace messages will be placed immediately before the terminal C<BODY> tag in  
 the output, formatted as a list.  
1470    
1471  A typical standard script would loook like the following.  Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1472    user name, password, and API ID for the relevant account in the hash reference variable
1473    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1474    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1475    is C<2561022>, then the FIG_Config file must contain
1476    
1477      BEGIN {      $phone =  { user => 'BruceTheHumanPet',
1478          # Print the HTML header.                  password => 'silly',
1479          print "CONTENT-TYPE: text/html\n\n";                  api_id => '2561022' };
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
1480    
1481      my ($cgi, $varHash) = ScriptSetup();  The original purpose of this method was to insure Bruce would be notified immediately when the
1482      eval {  Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1483          # ... get data from $cgi, put it in $varHash ...  when you call this method.
     };  
     if ($@) {  
         Trace("Script Error: $@") if T(0);  
     }  
     ScriptFinish("Html/MyTemplate.html", $varHash);  
1484    
1485  The idea here is that even if the script fails, you'll see trace messages and  The message ID will be returned if successful, and C<undef> if an error occurs.
 useful output.  
1486    
1487  =over 4  =over 4
1488    
1489  =item webData  =item phoneNumber
1490    
1491  A string containing either the full web page to be written to the output or the  Phone number to receive the message, in international format. A United States phone number
1492  name of a template file from which the page is to be constructed. If the name  would be prefixed by "1". A British phone number would be prefixed by "44".
 of a template file is specified, then the second parameter must be present;  
 otherwise, it must be absent.  
1493    
1494  =item varHash (optional)  =item msg
1495    
1496  If specified, then a reference to a hash mapping variable names for a template  Message to send to the specified phone.
1497  to their values. The template file will be read into memory, and variable markers  
1498  will be replaced by data in this hash reference.  =item RETURN
1499    
1500  =back  Returns the message ID if successful, and C<undef> if the message could not be sent.
   
 =cut  
   
 sub ScriptFinish {  
     # Get the parameters.  
     my ($webData, $varHash) = @_;  
     # Check for a template file situation.  
     my $outputString;  
     if (defined $varHash) {  
         # Here we have a template file. We need to determine the template type.  
         my $template;  
         if ($FIG_Config::template_url && $webData =~ /\.php$/) {  
             $template = "$FIG_Config::template_url/$webData";  
         } else {  
             $template = "<<$webData";  
         }  
         $outputString = PageBuilder::Build($template, $varHash, "Html");  
     } else {  
         # Here the user gave us a raw string.  
         $outputString = $webData;  
     }  
     # Check for trace messages.  
     if ($Destination ne "NONE" && $TraceLevel > 0) {  
         # We have trace messages, so we want to put them at the end of the body. This  
         # is either at the end of the whole string or at the beginning of the BODY  
         # end-tag.  
         my $pos = length $outputString;  
         if ($outputString =~ m#</body>#gi) {  
             $pos = (pos $outputString) - 7;  
         }  
         # If the trace messages were queued, we unroll them. Otherwise, we display the  
         # destination.  
         my $traceHtml;  
         if ($Destination eq "QUEUE") {  
             $traceHtml = QTrace('Html');  
         } elsif ($Destination =~ /^>>(.+)$/) {  
             # Here the tracing output it to a file. We code it as a hyperlink so the user  
             # can copy the file name into the clipboard easily.  
             my $actualDest = $1;  
             $traceHtml = "<p>Tracing output to $actualDest.</p>\n";  
         } else {  
             # Here we have one of the special destinations.  
             $traceHtml = "<P>Tracing output type is $Destination.</p>\n";  
         }  
         substr $outputString, $pos, 0, $traceHtml;  
     }  
     # Write the output string.  
     print $outputString;  
 }  
   
 =head2 Command-Line Utility Methods  
   
 =head3 SendSMS  
   
     my $msgID = Tracer::SendSMS($phoneNumber, $msg);  
   
 Send a text message to a phone number using Clickatell. The FIG_Config file must contain the  
 user name, password, and API ID for the relevant account in the hash reference variable  
 I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For  
 example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID  
 is C<2561022>, then the FIG_Config file must contain  
   
     $phone =  { user => 'BruceTheHumanPet',  
                 password => 'silly',  
                 api_id => '2561022' };  
   
 The original purpose of this method was to insure Bruce would be notified immediately when the  
 Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately  
 when you call this method.  
   
 The message ID will be returned if successful, and C<undef> if an error occurs.  
   
 =over 4  
   
 =item phoneNumber  
   
 Phone number to receive the message, in international format. A United States phone number  
 would be prefixed by "1". A British phone number would be prefixed by "44".  
   
 =item msg  
   
 Message to send to the specified phone.  
   
 =item RETURN  
   
 Returns the message ID if successful, and C<undef> if the message could not be sent.  
1501    
1502  =back  =back
1503    
# Line 1468  Line 1666 
1666  Specifying a value of C<E> for the trace level causes emergency tracing to  Specifying a value of C<E> for the trace level causes emergency tracing to
1667  be used instead of custom tracing. If the user name is not specified,  be used instead of custom tracing. If the user name is not specified,
1668  the tracing key is taken from the C<Tracing> environment variable. If there  the tracing key is taken from the C<Tracing> environment variable. If there
1669  is no value for that variable, the tracing key will be computed from the PID.  is no value for that variable, the tracing key will be computed from the active
1670    login ID.
1671    
1672    Since the default situation in StandardSetup is to trace to the standard
1673    output, errors that occur in command-line scripts will not generate
1674    RSS events. To force the events, use the C<warn> option.
1675    
1676        TransactFeatures -background -warn register ../xacts IDs.tbl
1677    
1678  Finally, if the special option C<-help> is specified, the option  Finally, if the special option C<-help> is specified, the option
1679  names will be traced at level 0 and the program will exit without processing.  names will be traced at level 0 and the program will exit without processing.
# Line 1485  Line 1690 
1690          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
1691          -start    start with this genome          -start    start with this genome
1692          -tblFiles output TBL files containing the corrected IDs          -tblFiles output TBL files containing the corrected IDs
1693            -forked   do not erase the trace file before tracing
1694    
1695  The caller has the option of modifying the tracing scheme by placing a value  The caller has the option of modifying the tracing scheme by placing a value
1696  for C<trace> in the incoming options hash. The default value can be overridden,  for C<trace> in the incoming options hash. The default value can be overridden,
# Line 1548  Line 1754 
1754      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
1755      # Get the default tracing key.      # Get the default tracing key.
1756      my $tkey = EmergencyKey();      my $tkey = EmergencyKey();
1757        # Save the command line.
1758        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1759      # Add the tracing options.      # Add the tracing options.
1760      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
1761          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1762      }      }
1763        if (! exists $options->{forked}) {
1764            $options->{forked} = [0, "keep old trace file"];
1765        }
1766      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
1767      $options->{help} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
1768      $options->{user} = [$tkey, "tracing key"];      $options->{user} = [$tkey, "tracing key"];
1769      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
1770        $options->{warn} = [0, "send errors to RSS feed"];
1771        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1772      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
1773      # contains the default values rather than the default value      # contains the default values rather than the default value
1774      # and the description. While we're at it, we'll memorize the      # and the description. While we're at it, we'll memorize the
# Line 1572  Line 1785 
1785      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1786      # Get the logfile suffix.      # Get the logfile suffix.
1787      my $suffix = $retOptions->{user};      my $suffix = $retOptions->{user};
1788      # Check for background mode.      # We'll put the trace file name in here. We need it later if background
1789      if ($retOptions->{background}) {      # mode is on.
1790          my $outFileName = "$FIG_Config::temp/out$suffix.log";      my $traceFileName;
         my $errFileName = "$FIG_Config::temp/err$suffix.log";  
         open STDOUT, ">$outFileName";  
         open STDERR, ">$errFileName";  
         # Check for phone support. If we have phone support and a phone number,  
         # we want to turn it on.  
         if ($ENV{PHONE} && defined($FIG_Config::phone)) {  
             $retOptions->{phone} = $ENV{PHONE};  
         }  
     }  
1791      # Now we want to set up tracing. First, we need to know if the user      # Now we want to set up tracing. First, we need to know if the user
1792      # wants emergency tracing.      # wants emergency tracing.
1793      if ($retOptions->{trace} eq 'E') {      if ($retOptions->{trace} eq 'E') {
# Line 1594  Line 1798 
1798          if ($retOptions->{sql}) {          if ($retOptions->{sql}) {
1799              push @cats, "SQL";              push @cats, "SQL";
1800          }          }
1801            if ($retOptions->{warn}) {
1802                push @cats, "Feed";
1803            }
1804          # Add the default categories.          # Add the default categories.
1805          push @cats, "Tracer";          push @cats, "Tracer";
1806            # Check for more tracing groups.
1807            if ($retOptions->{moreTracing}) {
1808                push @cats, split /,/, $retOptions->{moreTracing};
1809            }
1810          # Next, we create the category string by joining the categories.          # Next, we create the category string by joining the categories.
1811          my $cats = join(" ", @cats);          my $cats = join(" ", @cats);
1812          # Check to determine whether or not the caller wants to turn off tracing          # Check to determine whether or not the caller wants to turn off tracing
# Line 1610  Line 1821 
1821          my $traceMode;          my $traceMode;
1822          # Verify that we can open a file in the FIG temporary directory.          # Verify that we can open a file in the FIG temporary directory.
1823          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1824          if (open TESTTRACE, ">$traceFileName") {          my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1825            if (open TESTTRACE, "$traceFileSpec") {
1826              # Here we can trace to a file.              # Here we can trace to a file.
1827              $traceMode = ">$traceFileName";              $traceMode = ">>$traceFileName";
1828              if ($textOKFlag) {              if ($textOKFlag) {
1829                  # Echo to standard output if the text-OK flag is set.                  # Echo to standard output if the text-OK flag is set.
1830                  $traceMode = "+$traceMode";                  $traceMode = "+$traceMode";
# Line 1620  Line 1832 
1832              # Close the test file.              # Close the test file.
1833              close TESTTRACE;              close TESTTRACE;
1834          } else {          } else {
1835              # 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.
1836                warn "Could not open trace file $traceFileName: $!\n";
1837                # We trace to the standard output if it's
1838              # okay, and the error log otherwise.              # okay, and the error log otherwise.
1839              if ($textOKFlag) {              if ($textOKFlag) {
1840                  $traceMode = "TEXT";                  $traceMode = "TEXT";
# Line 1631  Line 1845 
1845          # Now set up the tracing.          # Now set up the tracing.
1846          TSetup("$traceLevel $cats", $traceMode);          TSetup("$traceLevel $cats", $traceMode);
1847      }      }
1848        # Check for background mode.
1849        if ($retOptions->{background}) {
1850            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1851            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1852            # Spool the output.
1853            open STDOUT, ">$outFileName";
1854            # If we have a trace file, trace the errors to the log. Otherwise,
1855            # spool the errors.
1856            if (defined $traceFileName) {
1857                open STDERR, "| Tracer $traceFileName";
1858            } else {
1859                open STDERR, ">$errFileName";
1860            }
1861            # Check for phone support. If we have phone support and a phone number,
1862            # we want to turn it on.
1863            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1864                $retOptions->{phone} = $ENV{PHONE};
1865            }
1866        }
1867      # Check for the "help" option. If it is specified, dump the command-line      # Check for the "help" option. If it is specified, dump the command-line
1868      # options and exit the program.      # options and exit the program.
1869      if ($retOptions->{help}) {      if ($retOptions->{help}) {
# Line 1811  Line 2044 
2044      }      }
2045  }  }
2046    
2047    =head3 UnparseOptions
2048    
2049        my $optionString = Tracer::UnparseOptions(\%options);
2050    
2051    Convert an option hash into a command-line string. This will not
2052    necessarily be the same text that came in, but it will nonetheless
2053    produce the same ultimate result when parsed by L</StandardSetup>.
2054    
2055    =over 4
2056    
2057    =item options
2058    
2059    Reference to a hash of options to convert into an option string.
2060    
2061    =item RETURN
2062    
2063    Returns a string that will parse to the same set of options when
2064    parsed by L</StandardSetup>.
2065    
2066    =back
2067    
2068    =cut
2069    
2070    sub UnparseOptions {
2071        # Get the parameters.
2072        my ($options) = @_;
2073        # The option segments will be put in here.
2074        my @retVal = ();
2075        # Loop through the options.
2076        for my $key (keys %$options) {
2077            # Get the option value.
2078            my $value = $options->{$key};
2079            # Only use it if it's nonempty.
2080            if (defined $value && $value ne "") {
2081                my $segment = "--$key=$value";
2082                # Quote it if necessary.
2083                if ($segment =~ /[ |<>*]/) {
2084                    $segment = '"' . $segment . '"';
2085                }
2086                # Add it to the return list.
2087                push @retVal, $segment;
2088            }
2089        }
2090        # Return the result.
2091        return join(" ", @retVal);
2092    }
2093    
2094  =head3 ParseCommand  =head3 ParseCommand
2095    
2096      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
# Line 2283  Line 2563 
2563          } else {          } else {
2564              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2565          }          }
2566            closedir $dirHandle;
2567      } elsif (! $flag) {      } elsif (! $flag) {
2568          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2569          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 2389  Line 2670 
2670  Map of search patterns to permission masks. If a directory name matches  Map of search patterns to permission masks. If a directory name matches
2671  one of the patterns, that directory and all its members and subdirectories  one of the patterns, that directory and all its members and subdirectories
2672  will be assigned the new pattern. For example, the following would  will be assigned the new pattern. For example, the following would
2673  assign 01664 to most files, but would use 01777 for directories named C<tmp>.  assign 0664 to most files, but would use 0777 for directories named C<tmp>.
2674    
2675      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2676    
# Line 2442  Line 2723 
2723                      $match = 1;                      $match = 1;
2724                  }                  }
2725              }              }
2726              # Check for a match. Note we use $i-1 because the loop added 2              # Find out if we have a match. Note we use $i-1 because the loop added 2
2727              # before terminating due to the match.              # before terminating due to the match.
2728              if ($match && $otherMasks[$i-1] != $mask) {              if ($match && $otherMasks[$i-1] != $mask) {
2729                  # This directory matches one of the incoming patterns, and it's                  # This directory matches one of the incoming patterns, and it's
# Line 2584  Line 2865 
2865  }  }
2866    
2867    
2868    =head3 PrintLine
2869    
2870        Tracer::PrintLine($line);
2871    
2872    Print a line of text with a trailing new-line.
2873    
2874    =over 4
2875    
2876    =item line
2877    
2878    Line of text to print.
2879    
2880    =back
2881    
2882    =cut
2883    
2884    sub PrintLine {
2885        # Get the parameters.
2886        my ($line) = @_;
2887        # Print the line.
2888        print "$line\n";
2889    }
2890    
2891    
2892  =head2 Other Useful Methods  =head2 Other Useful Methods
2893    
2894    =head3 IDHASH
2895    
2896        my $hash = SHTargetSearch::IDHASH(@keys);
2897    
2898    This is a dinky little method that converts a list of values to a reference
2899    to hash of values to labels. The values and labels are the same.
2900    
2901    =cut
2902    
2903    sub IDHASH {
2904        my %retVal = map { $_ => $_ } @_;
2905        return \%retVal;
2906    }
2907    
2908    =head3 Pluralize
2909    
2910        my $plural = Tracer::Pluralize($word);
2911    
2912    This is a very simple pluralization utility. It adds an C<s> at the end
2913    of the input word unless it already ends in an C<s>, in which case it
2914    adds C<es>.
2915    
2916    =over 4
2917    
2918    =item word
2919    
2920    Singular word to pluralize.
2921    
2922    =item RETURN
2923    
2924    Returns the probable plural form of the word.
2925    
2926    =back
2927    
2928    =cut
2929    
2930    sub Pluralize {
2931        # Get the parameters.
2932        my ($word) = @_;
2933        # Declare the return variable.
2934        my $retVal;
2935        if ($word =~ /s$/) {
2936            $retVal = $word . 'es';
2937        } else {
2938            $retVal = $word . 's';
2939        }
2940        # Return the result.
2941        return $retVal;
2942    }
2943    
2944    =head3 Numeric
2945    
2946        my $okFlag = Tracer::Numeric($string);
2947    
2948    Return the value of the specified string if it is numeric, or an undefined value
2949    if it is not numeric.
2950    
2951    =over 4
2952    
2953    =item string
2954    
2955    String to check.
2956    
2957    =item RETURN
2958    
2959    Returns the numeric value of the string if successful, or C<undef> if the string
2960    is not numeric.
2961    
2962    =back
2963    
2964    =cut
2965    
2966    sub Numeric {
2967        # Get the parameters.
2968        my ($string) = @_;
2969        # We'll put the value in here if we succeed.
2970        my $retVal;
2971        # Get a working copy of the string.
2972        my $copy = $string;
2973        # Trim leading and trailing spaces.
2974        $copy =~ s/^\s+//;
2975        $copy =~ s/\s+$//;
2976        # Check the result.
2977        if ($copy =~ /^[+-]?\d+$/) {
2978            $retVal = $copy;
2979        } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2980            $retVal = $copy;
2981        } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
2982            $retVal = $copy;
2983        }
2984        # Return the result.
2985        return $retVal;
2986    }
2987    
2988    
2989  =head3 ParseParm  =head3 ParseParm
2990    
2991      my $listValue = Tracer::ParseParm($string);      my $listValue = Tracer::ParseParm($string);
# Line 2624  Line 3023 
3023      return $retVal;      return $retVal;
3024  }  }
3025    
   
   
   
3026  =head3 Now  =head3 Now
3027    
3028      my $string = Tracer::Now();      my $string = Tracer::Now();
3029    
3030  Return a displayable time stamp containing the local time.  Return a displayable time stamp containing the local time. Whatever format this
3031    method produces must be parseable by L</ParseDate>.
3032    
3033  =cut  =cut
3034    
3035  sub Now {  sub Now {
3036      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      return DisplayTime(time);
3037      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .  }
3038    
3039    =head3 DisplayTime
3040    
3041        my $string = Tracer::DisplayTime($time);
3042    
3043    Convert a time value to a displayable time stamp. Whatever format this
3044    method produces must be parseable by L</ParseDate>.
3045    
3046    =over 4
3047    
3048    =item time
3049    
3050    Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
3051    
3052    =item RETURN
3053    
3054    Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
3055    
3056    =back
3057    
3058    =cut
3059    
3060    sub DisplayTime {
3061        my ($time) = @_;
3062        my $retVal = "(n/a)";
3063        if (defined $time) {
3064            my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
3065            $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
3066                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
3067        }
3068      return $retVal;      return $retVal;
3069  }  }
3070    
# Line 2802  Line 3228 
3228      return $retVal;      return $retVal;
3229  }  }
3230    
3231  =head3 Min  =head3 In
3232    
3233      my $min = Min($value1, $value2, ... $valueN);      my $flag = Tracer::In($value, $min, $max);
3234    
3235    Return TRUE if the value is between the minimum and the maximum, else FALSE.
3236    
3237    =cut
3238    
3239    sub In {
3240        return ($_[0] <= $_[2] && $_[0] >= $_[1]);
3241    }
3242    
3243  Return the minimum argument. The arguments are treated as numbers.  
3244    =head3 Constrain
3245    
3246        my $constrained = Constrain($value, $min, $max);
3247    
3248    Modify a numeric value to bring it to a point in between a maximum and a minimum.
3249    
3250  =over 4  =over 4
3251    
3252  =item $value1, $value2, ... $valueN  =item value
3253    
3254  List of numbers to compare.  Value to constrain.
3255    
3256    =item min (optional)
3257    
3258    Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3259    
3260    =item max (optional)
3261    
3262    Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3263    
3264  =item RETURN  =item RETURN
3265    
3266  Returns the lowest number in the list.  Returns the incoming value, constrained according to the other parameters.
3267    
3268  =back  =back
3269    
3270  =cut  =cut
3271    
3272  sub Min {  sub Constrain {
3273      # Get the parameters. Note that we prime the return value with the first parameter.      # Get the parameters.
3274      my ($retVal, @values) = @_;      my ($value, $min, $max) = @_;
3275      # Loop through the remaining parameters, looking for the lowest.      # Declare the return variable.
3276      for my $value (@values) {      my $retVal = $value;
3277          if ($value < $retVal) {      # Apply the minimum constraint.
3278              $retVal = $value;      if (defined $min && $retVal < $min) {
3279          }          $retVal = $min;
3280        }
3281        # Apply the maximum constraint.
3282        if (defined $max && $retVal > $max) {
3283            $retVal = $max;
3284      }      }
3285      # Return the minimum found.      # Return the result.
3286      return $retVal;      return $retVal;
3287  }  }
3288    
3289  =head3 Max  =head3 Min
3290    
3291      my $max = Max($value1, $value2, ... $valueN);      my $min = Min($value1, $value2, ... $valueN);
3292    
3293  Return the maximum argument. The arguments are treated as numbers.  Return the minimum argument. The arguments are treated as numbers.
3294    
3295  =over 4  =over 4
3296    
# Line 2849  Line 3300 
3300    
3301  =item RETURN  =item RETURN
3302    
3303  Returns the highest number in the list.  Returns the lowest number in the list.
3304    
3305  =back  =back
3306    
3307  =cut  =cut
3308    
3309  sub Max {  sub Min {
3310      # Get the parameters. Note that we prime the return value with the first parameter.      # Get the parameters. Note that we prime the return value with the first parameter.
3311      my ($retVal, @values) = @_;      my ($retVal, @values) = @_;
3312      # Loop through the remaining parameters, looking for the highest.      # Loop through the remaining parameters, looking for the lowest.
3313      for my $value (@values) {      for my $value (@values) {
3314          if ($value > $retVal) {          if ($value < $retVal) {
3315              $retVal = $value;              $retVal = $value;
3316          }          }
3317      }      }
3318      # Return the maximum found.      # Return the minimum found.
3319      return $retVal;      return $retVal;
3320  }  }
3321    
3322  =head3 DebugMode  =head3 Max
3323    
3324        my $max = Max($value1, $value2, ... $valueN);
3325    
3326    Return the maximum argument. The arguments are treated as numbers.
3327    
3328    =over 4
3329    
3330    =item $value1, $value2, ... $valueN
3331    
3332      if (Tracer::DebugMode) { ...code... }  List of numbers to compare.
3333    
3334  Return TRUE if debug mode has been turned on, else abort.  =item RETURN
3335    
3336  Certain CGI scripts are too dangerous to exist in the production  Returns the highest number in the list.
3337  environment. This method provides a simple way to prevent them  
3338  from working unless they are explicitly turned on by creating a password  =back
 cookie via the B<SetPassword> script.  If debugging mode  
 is not turned on, an error will occur.  
3339    
3340  =cut  =cut
3341    
3342  sub DebugMode {  sub Max {
3343      # Declare the return variable.      # Get the parameters. Note that we prime the return value with the first parameter.
3344      my $retVal = 0;      my ($retVal, @values) = @_;
3345      # Check the debug configuration.      # Loop through the remaining parameters, looking for the highest.
3346      my $password = CGI::cookie("DebugMode");      for my $value (@values) {
3347      my $encrypted = Digest::MD5::md5_hex($password);          if ($value > $retVal) {
3348      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {              $retVal = $value;
         $retVal = 1;  
     } else {  
         # Here debug mode is off, so we generate an error.  
         Confess("Cannot use this facility without logging in.");  
3349      }      }
3350      # Return the determination indicator.      }
3351        # Return the maximum found.
3352      return $retVal;      return $retVal;
3353  }  }
3354    
# Line 2930  Line 3384 
3384      return $retVal;      return $retVal;
3385  }  }
3386    
3387    =head3 Trim
3388    
3389        my $string = Tracer::Trim($line);
3390    
3391    Trim all spaces from the beginning and ending of a string.
3392    
3393    =over 4
3394    
3395    =item line
3396    
3397    Line of text to be trimmed.
3398    
3399    =item RETURN
3400    
3401    The same line of text with all whitespace chopped off either end.
3402    
3403    =back
3404    
3405    =cut
3406    
3407    sub Trim {
3408        # Get a copy of the parameter string.
3409        my ($string) = @_;
3410        my $retVal = (defined $string ? $string : "");
3411        # Strip the front spaces.
3412        $retVal =~ s/^\s+//;
3413        # Strip the back spaces.
3414        $retVal =~ s/\s+$//;
3415        # Return the result.
3416        return $retVal;
3417    }
3418    
3419  =head3 Pad  =head3 Pad
3420    
3421      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
# Line 2991  Line 3477 
3477      return $retVal;      return $retVal;
3478  }  }
3479    
3480    =head3 Quoted
3481    
3482        my $string = Tracer::Quoted($var);
3483    
3484    Convert the specified value to a string and enclose it in single quotes.
3485    If it's undefined, the string C<undef> in angle brackets will be used
3486    instead.
3487    
3488    =over 4
3489    
3490    =item var
3491    
3492    Value to quote.
3493    
3494    =item RETURN
3495    
3496    Returns a string enclosed in quotes, or an indication the value is undefined.
3497    
3498    =back
3499    
3500    =cut
3501    
3502    sub Quoted {
3503        # Get the parameters.
3504        my ($var) = @_;
3505        # Declare the return variable.
3506        my $retVal;
3507        # Are we undefined?
3508        if (! defined $var) {
3509            $retVal = "<undef>";
3510        } else {
3511            # No, so convert to a string and enclose in quotes.
3512            $retVal = $var;
3513            $retVal =~ s/'/\\'/;
3514            $retVal = "'$retVal'";
3515        }
3516        # Return the result.
3517        return $retVal;
3518    }
3519    
3520  =head3 EOF  =head3 EOF
3521    
3522  This is a constant that is lexically greater than any useful string.  This is a constant that is lexically greater than any useful string.
# Line 3080  Line 3606 
3606  }  }
3607    
3608    
3609    =head3 GetMemorySize
3610    
3611        my $string = Tracer::GetMemorySize();
3612    
3613    Return a memory size string for the current process. The string will be
3614    in comma format, with a size indicator (K, M, G) at the end.
3615    
3616    =cut
3617    
3618    sub GetMemorySize {
3619        # Get the memory size from Unix.
3620        my ($retVal) = `ps h -o vsz $$`;
3621        # Remove the ending new-line.
3622        chomp $retVal;
3623        # Format and return the result.
3624        return CommaFormat($retVal) . "K";
3625    }
3626    
3627  =head3 CompareLists  =head3 CompareLists
3628    
3629      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
# Line 3147  Line 3691 
3691      return ($inserted, $deleted);      return ($inserted, $deleted);
3692  }  }
3693    
3694    =head3 Cmp
3695    
3696        my $cmp = Tracer::Cmp($a, $b);
3697    
3698    This method performs a universal sort comparison. Each value coming in is
3699    separated into a leading text part and a trailing number part. The text
3700    part is string compared, and if both parts are equal, then the number
3701    parts are compared numerically. A stream of just numbers or a stream of
3702    just strings will sort correctly, and a mixed stream will sort with the
3703    numbers first. Strings with a label and a number will sort in the
3704    expected manner instead of lexically.
3705    
3706    =over 4
3707    
3708    =item a
3709    
3710    First item to compare.
3711    
3712    =item b
3713    
3714    Second item to compare.
3715    
3716    =item RETURN
3717    
3718    Returns a negative number if the first item should sort first (is less), a positive
3719    number if the first item should sort second (is greater), and a zero if the items are
3720    equal.
3721    
3722    =back
3723    
3724    =cut
3725    
3726    sub Cmp {
3727        # Get the parameters.
3728        my ($a, $b) = @_;
3729        # Declare the return value.
3730        my $retVal;
3731        # Check for nulls.
3732        if (! defined($a)) {
3733            $retVal = (! defined($b) ? 0 : -1);
3734        } elsif (! defined($b)) {
3735            $retVal = 1;
3736        } else {
3737            # Here we have two real values. Parse the two strings.
3738            my $aParsed = _Parse($a);
3739            my $bParsed = _Parse($b);
3740            # Compare the string parts insensitively.
3741            $retVal = (lc $aParsed->[0] cmp lc $bParsed->[0]);
3742            # If they're equal, compare them sensitively.
3743            if (! $retVal) {
3744                $retVal = ($aParsed->[0] cmp $bParsed->[0]);
3745            }
3746            # If they're STILL equal, compare the number parts.
3747            if (! $retVal) {
3748                $retVal = $aParsed->[1] <=> $bParsed->[1];
3749            }
3750        }
3751        # Return the result.
3752        return $retVal;
3753    }
3754    
3755    # This method parses an input string into a string part and a number part.
3756    sub _Parse {
3757        my ($string) = @_;
3758        my ($alpha, $num);
3759        if ($string =~ /^(.*?)(\d+(?:\.\d+)?)$/) {
3760            $alpha = $1;
3761            $num = $2;
3762        } else {
3763            $alpha = $string;
3764            $num = 0;
3765        }
3766        return [$alpha, $num];
3767    }
3768    
3769    =head3 ListEQ
3770    
3771        my $flag = Tracer::ListEQ(\@a, \@b);
3772    
3773    Return TRUE if the specified lists contain the same strings in the same
3774    order, else FALSE.
3775    
3776    =over 4
3777    
3778    =item a
3779    
3780    Reference to the first list.
3781    
3782    =item b
3783    
3784    Reference to the second list.
3785    
3786    =item RETURN
3787    
3788    Returns TRUE if the two parameters are identical string lists, else FALSE.
3789    
3790    =back
3791    
3792    =cut
3793    
3794    sub ListEQ {
3795        # Get the parameters.
3796        my ($a, $b) = @_;
3797        # Declare the return variable. Start by checking the lengths.
3798        my $n = scalar(@$a);
3799        my $retVal = ($n == scalar(@$b));
3800        # Now compare the list elements.
3801        for (my $i = 0; $retVal && $i < $n; $i++) {
3802            $retVal = ($a->[$i] eq $b->[$i]);
3803        }
3804        # Return the result.
3805        return $retVal;
3806    }
3807    
3808    =head2 CGI Script Utilities
3809    
3810    =head3 ScriptSetup (deprecated)
3811    
3812        my ($cgi, $varHash) = ScriptSetup($noTrace);
3813    
3814    Perform standard tracing and debugging setup for scripts. The value returned is
3815    the CGI object followed by a pre-built variable hash. At the end of the script,
3816    the client should call L</ScriptFinish> to output the web page.
3817    
3818    This method calls L</ETracing> to configure tracing, which allows the tracing
3819    to be configured via the emergency tracing form on the debugging control panel.
3820    Tracing will then be turned on automatically for all programs that use the L</ETracing>
3821    method, which includes every program that uses this method or L</StandardSetup>.
3822    
3823    =over 4
3824    
3825    =item noTrace (optional)
3826    
3827    If specified, tracing will be suppressed. This is useful if the script wants to set up
3828    tracing manually.
3829    
3830    =item RETURN
3831    
3832    Returns a two-element list consisting of a CGI query object and a variable hash for
3833    the output page.
3834    
3835    =back
3836    
3837    =cut
3838    
3839    sub ScriptSetup {
3840        # Get the parameters.
3841        my ($noTrace) = @_;
3842        # Get the CGI query object.
3843        my $cgi = CGI->new();
3844        # Set up tracing if it's not suppressed.
3845        ETracing($cgi) unless $noTrace;
3846        # Create the variable hash.
3847        my $varHash = { results => '' };
3848        # Return the query object and variable hash.
3849        return ($cgi, $varHash);
3850    }
3851    
3852    =head3 ScriptFinish (deprecated)
3853    
3854        ScriptFinish($webData, $varHash);
3855    
3856    Output a web page at the end of a script. Either the string to be output or the
3857    name of a template file can be specified. If the second parameter is omitted,
3858    it is assumed we have a string to be output; otherwise, it is assumed we have the
3859    name of a template file. The template should have the variable C<DebugData>
3860    specified in any form that invokes a standard script. If debugging mode is turned
3861    on, a form field will be put in that allows the user to enter tracing data.
3862    Trace messages will be placed immediately before the terminal C<BODY> tag in
3863    the output, formatted as a list.
3864    
3865    A typical standard script would loook like the following.
3866    
3867        BEGIN {
3868            # Print the HTML header.
3869            print "CONTENT-TYPE: text/html\n\n";
3870        }
3871        use Tracer;
3872        use CGI;
3873        use FIG;
3874        # ... more uses ...
3875    
3876        my ($cgi, $varHash) = ScriptSetup();
3877        eval {
3878            # ... get data from $cgi, put it in $varHash ...
3879        };
3880        if ($@) {
3881            Trace("Script Error: $@") if T(0);
3882        }
3883        ScriptFinish("Html/MyTemplate.html", $varHash);
3884    
3885    The idea here is that even if the script fails, you'll see trace messages and
3886    useful output.
3887    
3888    =over 4
3889    
3890    =item webData
3891    
3892    A string containing either the full web page to be written to the output or the
3893    name of a template file from which the page is to be constructed. If the name
3894    of a template file is specified, then the second parameter must be present;
3895    otherwise, it must be absent.
3896    
3897    =item varHash (optional)
3898    
3899    If specified, then a reference to a hash mapping variable names for a template
3900    to their values. The template file will be read into memory, and variable markers
3901    will be replaced by data in this hash reference.
3902    
3903    =back
3904    
3905    =cut
3906    
3907    sub ScriptFinish {
3908        # Get the parameters.
3909        my ($webData, $varHash) = @_;
3910        # Check for a template file situation.
3911        my $outputString;
3912        if (defined $varHash) {
3913            # Here we have a template file. We need to determine the template type.
3914            my $template;
3915            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
3916                $template = "$FIG_Config::template_url/$webData";
3917            } else {
3918                $template = "<<$webData";
3919            }
3920            $outputString = PageBuilder::Build($template, $varHash, "Html");
3921        } else {
3922            # Here the user gave us a raw string.
3923            $outputString = $webData;
3924        }
3925        # Check for trace messages.
3926        if ($Destination ne "NONE" && $TraceLevel > 0) {
3927            # We have trace messages, so we want to put them at the end of the body. This
3928            # is either at the end of the whole string or at the beginning of the BODY
3929            # end-tag.
3930            my $pos = length $outputString;
3931            if ($outputString =~ m#</body>#gi) {
3932                $pos = (pos $outputString) - 7;
3933            }
3934            # If the trace messages were queued, we unroll them. Otherwise, we display the
3935            # destination.
3936            my $traceHtml;
3937            if ($Destination eq "QUEUE") {
3938                $traceHtml = QTrace('Html');
3939            } elsif ($Destination =~ /^>>(.+)$/) {
3940                # Here the tracing output it to a file. We code it as a hyperlink so the user
3941                # can copy the file name into the clipboard easily.
3942                my $actualDest = $1;
3943                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
3944            } else {
3945                # Here we have one of the special destinations.
3946                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
3947            }
3948            substr $outputString, $pos, 0, $traceHtml;
3949        }
3950        # Write the output string.
3951        print $outputString;
3952    }
3953    
3954  =head3 GenerateURL  =head3 GenerateURL
3955    
3956      my $queryUrl = Tracer::GenerateURL($page, %parameters);      my $queryUrl = Tracer::GenerateURL($page, %parameters);
# Line 3281  Line 4085 
4085      return $retVal;      return $retVal;
4086  }  }
4087    
4088  =head3 Cmp  =head3 TrackingCode
4089    
4090      my $cmp = Tracer::Cmp($a, $b);      my $html = Tracer::TrackingCode();
4091    
4092  This method performs a universal sort comparison. Each value coming in is  Returns the HTML code for doing web page traffic monitoring. If the
4093  separated into a leading text part and a trailing number part. The text  current environment is a test system, then it returns a null string;
4094  part is string compared, and if both parts are equal, then the number  otherwise, it returns a bunch of javascript containing code for turning
4095  parts are compared numerically. A stream of just numbers or a stream of  on SiteMeter and Google Analytics.
 just strings will sort correctly, and a mixed stream will sort with the  
 numbers first. Strings with a label and a number will sort in the  
 expected manner instead of lexically.  
4096    
4097  =over 4  =cut
4098    
4099  =item a  sub TrackingCode {
4100        # Declare the return variable.
4101        my $retVal = "<!-- tracking off -->";
4102        # Determine if we're in production.
4103        if ($FIG_Config::site_meter) {
4104            $retVal = <<END_HTML
4105            <!-- Site Meter -->
4106            <script type="text/javascript" src="http://s20.sitemeter.com/js/counter.js?site=s20nmpdr">
4107            </script>
4108            <noscript>
4109            <a href="http://s20.sitemeter.com/stats.asp?site=s20nmpdr" target="_top">
4110            <img src="http://s20.sitemeter.com/meter.asp?site=s20nmpdr" alt="Site Meter" border="0"/></a>
4111            </noscript>
4112            <!-- Copyright (c)2006 Site Meter -->
4113    END_HTML
4114        }
4115        return $retVal;
4116    }
4117    
4118  First item to compare.  =head3 Clean
4119    
4120  =item b      my $cleaned = Tracer::Clean($string);
4121    
4122  Second item to compare.  Clean up a string for HTML display. This not only converts special
4123    characters to HTML entity names, it also removes control characters.
4124    
4125    =over 4
4126    
4127    =item string
4128    
4129    String to convert.
4130    
4131  =item RETURN  =item RETURN
4132    
4133  Returns a negative number if the first item should sort first (is less), a positive  Returns the input string with anything that might disrupt an HTML literal removed. An
4134  number if the first item should sort second (is greater), and a zero if the items are  undefined value will be converted to an empty string.
 equal.  
4135    
4136  =back  =back
4137    
4138  =cut  =cut
4139    
4140  sub Cmp {  sub Clean {
4141      # Get the parameters.      # Get the parameters.
4142      my ($a, $b) = @_;      my ($string) = @_;
4143      # Declare the return value.      # Declare the return variable.
4144      my $retVal;      my $retVal = "";
4145      # Check for nulls.      # Only proceed if the value exists.
4146      if (! defined($a)) {      if (defined $string) {
4147          $retVal = (! defined($b) ? 0 : -1);          # Get the string.
4148      } elsif (! defined($b)) {          $retVal = $string;
4149          $retVal = 1;          # Clean the control characters.
4150      } else {          $retVal =~ tr/\x00-\x1F/?/;
4151          # Here we have two real values. Parse the two strings.          # Escape the rest.
4152          $a =~ /^(\D*)(\d*)$/;          $retVal = CGI::escapeHTML($retVal);
         my $aParsed = [$1, $2];  
         $b =~ /^(\D*)(\d*)$/;  
         my $bParsed = [$1, $2];  
         # Compare the string parts.  
         $retVal = $aParsed->[0] cmp $bParsed->[0];  
         if (! $retVal) {  
             $retVal = $aParsed->[1] <=> $bParsed->[1];  
         }  
4153      }      }
4154      # Return the result.      # Return the result.
4155      return $retVal;      return $retVal;
4156  }  }
4157    
4158    =head3 SortByValue
4159    
4160        my @keys = Tracer::SortByValue(\%hash);
4161    
4162    Get a list of hash table keys sorted by hash table values.
4163    
4164    =over 4
4165    
4166    =item hash
4167    
4168    Hash reference whose keys are to be extracted.
4169    
4170    =item RETURN
4171    
4172    Returns a list of the hash keys, ordered so that the corresponding hash values
4173    are in alphabetical sequence.
4174    
4175    =back
4176    
4177    =cut
4178    
4179    sub SortByValue {
4180        # Get the parameters.
4181        my ($hash) = @_;
4182        # Sort the hash's keys using the values.
4183        my @retVal = sort { Cmp($hash->{$a}, $hash->{$b}) } keys %$hash;
4184        # Return the result.
4185        return @retVal;
4186    }
4187    
4188    =head3 GetSet
4189    
4190        my $value = Tracer::GetSet($object, $name => $newValue);
4191    
4192    Get or set the value of an object field. The object is treated as an
4193    ordinary hash reference. If a new value is specified, it is stored in the
4194    hash under the specified name and then returned. If no new value is
4195    specified, the current value is returned.
4196    
4197    =over 4
4198    
4199    =item object
4200    
4201    Reference to the hash that is to be interrogated or updated.
4202    
4203    =item name
4204    
4205    Name of the field. This is the hash key.
4206    
4207    =item newValue (optional)
4208    
4209    New value to be stored in the field. If no new value is specified, the current
4210    value of the field is returned.
4211    
4212    =item RETURN
4213    
4214    Returns the value of the named field in the specified hash.
4215    
4216    =back
4217    
4218    =cut
4219    
4220    sub GetSet {
4221        # Get the parameters.
4222        my ($object, $name, $newValue) = @_;
4223        # Is a new value specified?
4224        if (defined $newValue) {
4225            # Yes, so store it.
4226            $object->{$name} = $newValue;
4227        }
4228        # Return the result.
4229        return $object->{$name};
4230    }
4231    
4232  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3