[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.94, Tue Mar 11 21:04:56 2008 UTC revision 1.128, Wed Dec 16 20:57:35 2009 UTC
# Line 1  Line 1 
1  #  # -*- perl -*-
2    ########################################################################
3  # Copyright (c) 2003-2006 University of Chicago and Fellowship  # Copyright (c) 2003-2006 University of Chicago and Fellowship
4  # for Interpretations of Genomes. All Rights Reserved.  # for Interpretations of Genomes. All Rights Reserved.
5  #  #
# Line 13  Line 14 
14  # at info@ci.uchicago.edu or the Fellowship for Interpretation of  # at info@ci.uchicago.edu or the Fellowship for Interpretation of
15  # Genomes at veronika@thefig.info or download a copy from  # Genomes at veronika@thefig.info or download a copy from
16  # http://www.theseed.org/LICENSE.TXT.  # http://www.theseed.org/LICENSE.TXT.
17  #  ########################################################################
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 35  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 159  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 183  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 289  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 365  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 407  Line 328 
328      $TraceLevel = $_[0];      $TraceLevel = $_[0];
329  }  }
330    
331  =head3 ParseTraceDate  =head3 ParseDate
332    
333        my $time = Tracer::ParseDate($dateString);
334    
335    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    If a time of day is present, it must be in military time with two digits for
342    everything but the hour.
343    
344      my $time = Tracer::ParseTraceDate($dateString);  The year must be exactly four digits.
345    
346  Convert a date from the trace file into a PERL timestamp.  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 488  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         warn $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 522  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 575  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 659  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 724  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
1064    
1065      ETracing($parameter);      ETracing($parameter, %options);
1066    
1067  Set up emergency tracing. Emergency tracing is tracing that is turned  Set up emergency tracing. Emergency tracing is tracing that is turned
1068  on automatically for any program that calls this method. The emergency  on automatically for any program that calls this method. The emergency
# Line 797  Line 1083 
1083  is a CGI object and emergency tracing is not on, the C<Trace> and  is a CGI object and emergency tracing is not on, the C<Trace> and
1084  C<TF> parameters will be used to determine the type of tracing.  C<TF> parameters will be used to determine the type of tracing.
1085    
1086    =item options
1087    
1088    Hash of options. The permissible options are given below.
1089    
1090    =over 8
1091    
1092    =item destType
1093    
1094    Emergency tracing destination type to use if no tracing file is found. The
1095    default is C<WARN>.
1096    
1097    =item noParms
1098    
1099    If TRUE, then display of the saved CGI parms is suppressed. The default is FALSE.
1100    
1101    =item level
1102    
1103    The trace level to use if no tracing file is found. The default is C<0>.
1104    
1105  =back  =back
1106    
1107  =cut  =cut
1108    
1109  sub ETracing {  sub ETracing {
1110      # Get the parameter.      # Get the parameter.
1111      my ($parameter) = @_;      my ($parameter, %options) = @_;
1112      # Check for CGI mode.      # Check for CGI mode.
1113      my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);      if (defined $parameter && ref $parameter eq 'CGI') {
1114      # Default to no tracing except errors.          $SavedCGI = $parameter;
1115      my ($tracing, $dest) = ("0", "WARN");      } else {
1116            $SavedCGI = undef;
1117        }
1118        # Check for the noParms option.
1119        my $noParms = $options{noParms} || 0;
1120        # Get the default tracing information.
1121        my $tracing = $options{level} || 0;
1122        my $dest = $options{destType} || "WARN";
1123      # Check for emergency tracing.      # Check for emergency tracing.
1124      my $tkey = EmergencyKey($parameter);      my $tkey = EmergencyKey($parameter);
1125      my $emergencyFile = EmergencyFileName($tkey);      my $emergencyFile = EmergencyFileName($tkey);
# Line 829  Line 1141 
1141              # the trace level;              # the trace level;
1142              $dest = shift @tracing;              $dest = shift @tracing;
1143              my $level = shift @tracing;              my $level = shift @tracing;
             # Convert the destination to a real tracing destination.  
             # temp directory.  
             $dest = EmergencyTracingDest($tkey, $dest);  
1144              # Insure Tracer is specified.              # Insure Tracer is specified.
1145              my %moduleHash = map { $_ => 1 } @tracing;              my %moduleHash = map { $_ => 1 } @tracing;
1146              $moduleHash{Tracer} = 1;              $moduleHash{Tracer} = 1;
1147              # Set the trace parameter.              # Set the trace parameter.
1148              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
1149          }          }
     } elsif (defined $cgi) {  
         # There's no emergency tracing, but we have a CGI object, so check  
         # for tracing from the form parameters.  
         if ($cgi->param('Trace')) {  
             # Here the user has requested tracing via a form.  
             $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");  
             $tracing = $cgi->param('Trace') . " Tracer";  
         }  
1150      }      }
1151        # Convert the destination to a real tracing destination.
1152        $dest = EmergencyTracingDest($tkey, $dest);
1153      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
1154      TSetup($tracing, $dest);      TSetup($tracing, $dest);
1155      # Check to see if we're a web script.      # Check to see if we're a web script.
1156      if (defined $cgi) {      if (defined $SavedCGI) {
1157          # Yes we are. Trace the form and environment data.          # Yes we are. Trace the form and environment data if it's not suppressed.
1158          TraceParms($cgi);          if (! $noParms) {
1159                TraceParms($SavedCGI);
1160            }
1161          # 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
1162          # emitted by the script in its raw form.          # emitted by the script in its raw form.
1163          if (T(Raw => 3)) {          if (T(Raw => 3)) {
# Line 957  Line 1262 
1262          $retVal = ">>" . EmergencyFileTarget($tkey);          $retVal = ">>" . EmergencyFileTarget($tkey);
1263      } elsif ($myDest eq 'DUAL') {      } elsif ($myDest eq 'DUAL') {
1264          $retVal = "+>" . EmergencyFileTarget($tkey);          $retVal = "+>" . EmergencyFileTarget($tkey);
1265        } elsif ($myDest eq 'WARN') {
1266            $retVal = "WARN";
1267      }      }
1268      # Return the result.      # Return the result.
1269      return $retVal;      return $retVal;
# Line 1042  Line 1349 
1349      my $retVal;      my $retVal;
1350      # Determine the parameter type.      # Determine the parameter type.
1351      if (! defined $parameter) {      if (! defined $parameter) {
1352          # Here we're supposed to check the environment.          # Here we're supposed to check the environment. If that fails, we
1353          $retVal = $ENV{TRACING};          # get the effective login ID.
1354            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1355      } else {      } else {
1356          my $ptype = ref $parameter;          my $ptype = ref $parameter;
1357          if ($ptype eq 'CGI') {          if ($ptype eq 'CGI') {
# Line 1084  Line 1392 
1392      # Get the parameters.      # Get the parameters.
1393      my ($cgi) = @_;      my ($cgi) = @_;
1394      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1395          # 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
1396          Trace("URL: " . $cgi->url(-relative => 1, -query => 1));          # relatively small.
1397            my $url = $cgi->url(-relative => 1, -query => 1);
1398            my $len = length($url);
1399            if ($len < 500) {
1400                Trace("[URL] $url");
1401            } elsif ($len > 2048) {
1402                Trace("[URL] URL is too long to use with GET ($len characters).");
1403            } else {
1404                Trace("[URL] URL length is $len characters.");
1405            }
1406      }      }
1407      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1408          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1094  Line 1411 
1411              # Note we skip the Trace parameters, which are for our use only.              # Note we skip the Trace parameters, which are for our use only.
1412              if ($parmName ne 'Trace' && $parmName ne 'TF') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
1413                  my @values = $cgi->param($parmName);                  my @values = $cgi->param($parmName);
1414                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("[CGI] $parmName = " . join(", ", @values));
1415              }              }
1416          }          }
1417          # Display the request method.          # Display the request method.
# Line 1104  Line 1421 
1421      if (T(CGI => 4)) {      if (T(CGI => 4)) {
1422          # Here we want the environment data too.          # Here we want the environment data too.
1423          for my $envName (sort keys %ENV) {          for my $envName (sort keys %ENV) {
1424              Trace("ENV: $envName = $ENV{$envName}");              Trace("[ENV] $envName = $ENV{$envName}");
1425          }          }
1426      }      }
1427  }  }
# Line 1160  Line 1477 
1477      }      }
1478  }  }
1479    
1480    =head2 Command-Line Utility Methods
1481    
1482  =head3 ScriptFinish  =head3 SendSMS
1483    
1484      ScriptFinish($webData, $varHash);      my $msgID = Tracer::SendSMS($phoneNumber, $msg);
1485    
1486  Output a web page at the end of a script. Either the string to be output or the  Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1487  name of a template file can be specified. If the second parameter is omitted,  user name, password, and API ID for the relevant account in the hash reference variable
1488  it is assumed we have a string to be output; otherwise, it is assumed we have the  I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1489  name of a template file. The template should have the variable C<DebugData>  example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1490  specified in any form that invokes a standard script. If debugging mode is turned  is C<2561022>, then the FIG_Config file must contain
 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.  
1491    
1492  A typical standard script would loook like the following.      $phone =  { user => 'BruceTheHumanPet',
1493                    password => 'silly',
1494                    api_id => '2561022' };
1495    
1496      BEGIN {  The original purpose of this method was to insure Bruce would be notified immediately when the
1497          # Print the HTML header.  Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1498          print "CONTENT-TYPE: text/html\n\n";  when you call this method.
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
1499    
1500      my ($cgi, $varHash) = ScriptSetup();  The message ID will be returned if successful, and C<undef> if an error occurs.
     eval {  
         # ... get data from $cgi, put it in $varHash ...  
     };  
     if ($@) {  
         Trace("Script Error: $@") if T(0);  
     }  
     ScriptFinish("Html/MyTemplate.html", $varHash);  
   
 The idea here is that even if the script fails, you'll see trace messages and  
 useful output.  
   
 =over 4  
   
 =item webData  
   
 A string containing either the full web page to be written to the output or the  
 name of a template file from which the page is to be constructed. If the name  
 of a template file is specified, then the second parameter must be present;  
 otherwise, it must be absent.  
   
 =item varHash (optional)  
   
 If specified, then a reference to a hash mapping variable names for a template  
 to their values. The template file will be read into memory, and variable markers  
 will be replaced by data in this hash reference.  
   
 =back  
   
 =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.  
1501    
1502  =over 4  =over 4
1503    
# Line 1467  Line 1681 
1681  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
1682  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,
1683  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
1684  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
1685    login ID.
1686    
1687    Since the default situation in StandardSetup is to trace to the standard
1688    output, errors that occur in command-line scripts will not generate
1689    RSS events. To force the events, use the C<warn> option.
1690    
1691        TransactFeatures -background -warn register ../xacts IDs.tbl
1692    
1693  Finally, if the special option C<-help> is specified, the option  Finally, if the special option C<-help> is specified, the option
1694  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 1484  Line 1705 
1705          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
1706          -start    start with this genome          -start    start with this genome
1707          -tblFiles output TBL files containing the corrected IDs          -tblFiles output TBL files containing the corrected IDs
1708            -forked   do not erase the trace file before tracing
1709    
1710  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
1711  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 1547  Line 1769 
1769      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
1770      # Get the default tracing key.      # Get the default tracing key.
1771      my $tkey = EmergencyKey();      my $tkey = EmergencyKey();
1772        # Save the command line.
1773        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1774      # Add the tracing options.      # Add the tracing options.
1775      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
1776          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1777      }      }
1778        if (! exists $options->{forked}) {
1779            $options->{forked} = [0, "keep old trace file"];
1780        }
1781      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
1782      $options->{help} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
1783      $options->{user} = [$tkey, "tracing key"];      $options->{user} = [$tkey, "tracing key"];
1784      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
1785        $options->{warn} = [0, "send errors to RSS feed"];
1786        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1787      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
1788      # contains the default values rather than the default value      # contains the default values rather than the default value
1789      # 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 1571  Line 1800 
1800      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1801      # Get the logfile suffix.      # Get the logfile suffix.
1802      my $suffix = $retOptions->{user};      my $suffix = $retOptions->{user};
1803      # Check for background mode.      # We'll put the trace file name in here. We need it later if background
1804      if ($retOptions->{background}) {      # mode is on.
1805          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};  
         }  
     }  
1806      # 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
1807      # wants emergency tracing.      # wants emergency tracing.
1808      if ($retOptions->{trace} eq 'E') {      if ($retOptions->{trace} eq 'E') {
# Line 1593  Line 1813 
1813          if ($retOptions->{sql}) {          if ($retOptions->{sql}) {
1814              push @cats, "SQL";              push @cats, "SQL";
1815          }          }
1816            if ($retOptions->{warn}) {
1817                push @cats, "Feed";
1818            }
1819          # Add the default categories.          # Add the default categories.
1820          push @cats, "Tracer";          push @cats, "Tracer";
1821            # Check for more tracing groups.
1822            if ($retOptions->{moreTracing}) {
1823                push @cats, split /,/, $retOptions->{moreTracing};
1824            }
1825          # Next, we create the category string by joining the categories.          # Next, we create the category string by joining the categories.
1826          my $cats = join(" ", @cats);          my $cats = join(" ", @cats);
1827          # 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 1609  Line 1836 
1836          my $traceMode;          my $traceMode;
1837          # Verify that we can open a file in the FIG temporary directory.          # Verify that we can open a file in the FIG temporary directory.
1838          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1839          if (open TESTTRACE, ">$traceFileName") {          my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1840            if (open TESTTRACE, "$traceFileSpec") {
1841              # Here we can trace to a file.              # Here we can trace to a file.
1842              $traceMode = ">$traceFileName";              $traceMode = ">>$traceFileName";
1843              if ($textOKFlag) {              if ($textOKFlag) {
1844                  # Echo to standard output if the text-OK flag is set.                  # Echo to standard output if the text-OK flag is set.
1845                  $traceMode = "+$traceMode";                  $traceMode = "+$traceMode";
# Line 1619  Line 1847 
1847              # Close the test file.              # Close the test file.
1848              close TESTTRACE;              close TESTTRACE;
1849          } else {          } else {
1850              # 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.
1851                warn "Could not open trace file $traceFileName: $!\n";
1852                # We trace to the standard output if it's
1853              # okay, and the error log otherwise.              # okay, and the error log otherwise.
1854              if ($textOKFlag) {              if ($textOKFlag) {
1855                  $traceMode = "TEXT";                  $traceMode = "TEXT";
# Line 1630  Line 1860 
1860          # Now set up the tracing.          # Now set up the tracing.
1861          TSetup("$traceLevel $cats", $traceMode);          TSetup("$traceLevel $cats", $traceMode);
1862      }      }
1863        # Check for background mode.
1864        if ($retOptions->{background}) {
1865            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1866            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1867            # Spool the output.
1868            open STDOUT, ">$outFileName";
1869            # If we have a trace file, trace the errors to the log. Otherwise,
1870            # spool the errors.
1871            if (defined $traceFileName) {
1872                open STDERR, "| Tracer $traceFileName";
1873            } else {
1874                open STDERR, ">$errFileName";
1875            }
1876            # Check for phone support. If we have phone support and a phone number,
1877            # we want to turn it on.
1878            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1879                $retOptions->{phone} = $ENV{PHONE};
1880            }
1881        }
1882      # 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
1883      # options and exit the program.      # options and exit the program.
1884      if ($retOptions->{help}) {      if ($retOptions->{help}) {
# Line 1810  Line 2059 
2059      }      }
2060  }  }
2061    
2062    =head3 UnparseOptions
2063    
2064        my $optionString = Tracer::UnparseOptions(\%options);
2065    
2066    Convert an option hash into a command-line string. This will not
2067    necessarily be the same text that came in, but it will nonetheless
2068    produce the same ultimate result when parsed by L</StandardSetup>.
2069    
2070    =over 4
2071    
2072    =item options
2073    
2074    Reference to a hash of options to convert into an option string.
2075    
2076    =item RETURN
2077    
2078    Returns a string that will parse to the same set of options when
2079    parsed by L</StandardSetup>.
2080    
2081    =back
2082    
2083    =cut
2084    
2085    sub UnparseOptions {
2086        # Get the parameters.
2087        my ($options) = @_;
2088        # The option segments will be put in here.
2089        my @retVal = ();
2090        # Loop through the options.
2091        for my $key (keys %$options) {
2092            # Get the option value.
2093            my $value = $options->{$key};
2094            # Only use it if it's nonempty.
2095            if (defined $value && $value ne "") {
2096                my $segment = "--$key=$value";
2097                # Quote it if necessary.
2098                if ($segment =~ /[ |<>*]/) {
2099                    $segment = '"' . $segment . '"';
2100                }
2101                # Add it to the return list.
2102                push @retVal, $segment;
2103            }
2104        }
2105        # Return the result.
2106        return join(" ", @retVal);
2107    }
2108    
2109  =head3 ParseCommand  =head3 ParseCommand
2110    
2111      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
# Line 2282  Line 2578 
2578          } else {          } else {
2579              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2580          }          }
2581            closedir $dirHandle;
2582      } elsif (! $flag) {      } elsif (! $flag) {
2583          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2584          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 2388  Line 2685 
2685  Map of search patterns to permission masks. If a directory name matches  Map of search patterns to permission masks. If a directory name matches
2686  one of the patterns, that directory and all its members and subdirectories  one of the patterns, that directory and all its members and subdirectories
2687  will be assigned the new pattern. For example, the following would  will be assigned the new pattern. For example, the following would
2688  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>.
2689    
2690      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2691    
# Line 2441  Line 2738 
2738                      $match = 1;                      $match = 1;
2739                  }                  }
2740              }              }
2741              # 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
2742              # before terminating due to the match.              # before terminating due to the match.
2743              if ($match && $otherMasks[$i-1] != $mask) {              if ($match && $otherMasks[$i-1] != $mask) {
2744                  # This directory matches one of the incoming patterns, and it's                  # This directory matches one of the incoming patterns, and it's
# Line 2583  Line 2880 
2880  }  }
2881    
2882    
2883    =head3 PrintLine
2884    
2885        Tracer::PrintLine($line);
2886    
2887    Print a line of text with a trailing new-line.
2888    
2889    =over 4
2890    
2891    =item line
2892    
2893    Line of text to print.
2894    
2895    =back
2896    
2897    =cut
2898    
2899    sub PrintLine {
2900        # Get the parameters.
2901        my ($line) = @_;
2902        # Print the line.
2903        print "$line\n";
2904    }
2905    
2906    
2907  =head2 Other Useful Methods  =head2 Other Useful Methods
2908    
2909    =head3 IDHASH
2910    
2911        my $hash = SHTargetSearch::IDHASH(@keys);
2912    
2913    This is a dinky little method that converts a list of values to a reference
2914    to hash of values to labels. The values and labels are the same.
2915    
2916    =cut
2917    
2918    sub IDHASH {
2919        my %retVal = map { $_ => $_ } @_;
2920        return \%retVal;
2921    }
2922    
2923    =head3 Pluralize
2924    
2925        my $plural = Tracer::Pluralize($word);
2926    
2927    This is a very simple pluralization utility. It adds an C<s> at the end
2928    of the input word unless it already ends in an C<s>, in which case it
2929    adds C<es>.
2930    
2931    =over 4
2932    
2933    =item word
2934    
2935    Singular word to pluralize.
2936    
2937    =item RETURN
2938    
2939    Returns the probable plural form of the word.
2940    
2941    =back
2942    
2943    =cut
2944    
2945    sub Pluralize {
2946        # Get the parameters.
2947        my ($word) = @_;
2948        # Declare the return variable.
2949        my $retVal;
2950        if ($word =~ /s$/) {
2951            $retVal = $word . 'es';
2952        } else {
2953            $retVal = $word . 's';
2954        }
2955        # Return the result.
2956        return $retVal;
2957    }
2958    
2959    =head3 Numeric
2960    
2961        my $okFlag = Tracer::Numeric($string);
2962    
2963    Return the value of the specified string if it is numeric, or an undefined value
2964    if it is not numeric.
2965    
2966    =over 4
2967    
2968    =item string
2969    
2970    String to check.
2971    
2972    =item RETURN
2973    
2974    Returns the numeric value of the string if successful, or C<undef> if the string
2975    is not numeric.
2976    
2977    =back
2978    
2979    =cut
2980    
2981    sub Numeric {
2982        # Get the parameters.
2983        my ($string) = @_;
2984        # We'll put the value in here if we succeed.
2985        my $retVal;
2986        # Get a working copy of the string.
2987        my $copy = $string;
2988        # Trim leading and trailing spaces.
2989        $copy =~ s/^\s+//;
2990        $copy =~ s/\s+$//;
2991        # Check the result.
2992        if ($copy =~ /^[+-]?\d+$/) {
2993            $retVal = $copy;
2994        } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2995            $retVal = $copy;
2996        } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
2997            $retVal = $copy;
2998        }
2999        # Return the result.
3000        return $retVal;
3001    }
3002    
3003    
3004  =head3 ParseParm  =head3 ParseParm
3005    
3006      my $listValue = Tracer::ParseParm($string);      my $listValue = Tracer::ParseParm($string);
# Line 2623  Line 3038 
3038      return $retVal;      return $retVal;
3039  }  }
3040    
   
   
   
3041  =head3 Now  =head3 Now
3042    
3043      my $string = Tracer::Now();      my $string = Tracer::Now();
3044    
3045  Return a displayable time stamp containing the local time.  Return a displayable time stamp containing the local time. Whatever format this
3046    method produces must be parseable by L</ParseDate>.
3047    
3048  =cut  =cut
3049    
3050  sub Now {  sub Now {
3051      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      return DisplayTime(time);
3052      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .  }
3053    
3054    =head3 DisplayTime
3055    
3056        my $string = Tracer::DisplayTime($time);
3057    
3058    Convert a time value to a displayable time stamp. Whatever format this
3059    method produces must be parseable by L</ParseDate>.
3060    
3061    =over 4
3062    
3063    =item time
3064    
3065    Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
3066    
3067    =item RETURN
3068    
3069    Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
3070    
3071    =back
3072    
3073    =cut
3074    
3075    sub DisplayTime {
3076        my ($time) = @_;
3077        my $retVal = "(n/a)";
3078        if (defined $time) {
3079            my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
3080            $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
3081                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
3082        }
3083      return $retVal;      return $retVal;
3084  }  }
3085    
# Line 2801  Line 3243 
3243      return $retVal;      return $retVal;
3244  }  }
3245    
3246  =head3 Min  =head3 In
3247    
3248      my $min = Min($value1, $value2, ... $valueN);      my $flag = Tracer::In($value, $min, $max);
3249    
3250  Return the minimum argument. The arguments are treated as numbers.  Return TRUE if the value is between the minimum and the maximum, else FALSE.
3251    
3252    =cut
3253    
3254    sub In {
3255        return ($_[0] <= $_[2] && $_[0] >= $_[1]);
3256    }
3257    
3258    
3259    =head3 Constrain
3260    
3261        my $constrained = Constrain($value, $min, $max);
3262    
3263    Modify a numeric value to bring it to a point in between a maximum and a minimum.
3264    
3265  =over 4  =over 4
3266    
3267  =item $value1, $value2, ... $valueN  =item value
3268    
3269  List of numbers to compare.  Value to constrain.
3270    
3271    =item min (optional)
3272    
3273    Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3274    
3275    =item max (optional)
3276    
3277    Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3278    
3279  =item RETURN  =item RETURN
3280    
3281  Returns the lowest number in the list.  Returns the incoming value, constrained according to the other parameters.
3282    
3283  =back  =back
3284    
3285  =cut  =cut
3286    
3287  sub Min {  sub Constrain {
3288      # Get the parameters. Note that we prime the return value with the first parameter.      # Get the parameters.
3289      my ($retVal, @values) = @_;      my ($value, $min, $max) = @_;
3290      # Loop through the remaining parameters, looking for the lowest.      # Declare the return variable.
3291      for my $value (@values) {      my $retVal = $value;
3292          if ($value < $retVal) {      # Apply the minimum constraint.
3293              $retVal = $value;      if (defined $min && $retVal < $min) {
3294          }          $retVal = $min;
3295        }
3296        # Apply the maximum constraint.
3297        if (defined $max && $retVal > $max) {
3298            $retVal = $max;
3299      }      }
3300      # Return the minimum found.      # Return the result.
3301      return $retVal;      return $retVal;
3302  }  }
3303    
3304  =head3 Max  =head3 Min
3305    
3306      my $max = Max($value1, $value2, ... $valueN);      my $min = Min($value1, $value2, ... $valueN);
3307    
3308  Return the maximum argument. The arguments are treated as numbers.  Return the minimum argument. The arguments are treated as numbers.
3309    
3310  =over 4  =over 4
3311    
# Line 2848  Line 3315 
3315    
3316  =item RETURN  =item RETURN
3317    
3318  Returns the highest number in the list.  Returns the lowest number in the list.
3319    
3320  =back  =back
3321    
3322  =cut  =cut
3323    
3324  sub Max {  sub Min {
3325      # 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.
3326      my ($retVal, @values) = @_;      my ($retVal, @values) = @_;
3327      # Loop through the remaining parameters, looking for the highest.      # Loop through the remaining parameters, looking for the lowest.
3328      for my $value (@values) {      for my $value (@values) {
3329          if ($value > $retVal) {          if ($value < $retVal) {
3330              $retVal = $value;              $retVal = $value;
3331          }          }
3332      }      }
3333      # Return the maximum found.      # Return the minimum found.
3334      return $retVal;      return $retVal;
3335  }  }
3336    
3337  =head3 DebugMode  =head3 Max
3338    
3339        my $max = Max($value1, $value2, ... $valueN);
3340    
3341      if (Tracer::DebugMode) { ...code... }  Return the maximum argument. The arguments are treated as numbers.
3342    
3343  Return TRUE if debug mode has been turned on, else abort.  =over 4
3344    
3345  Certain CGI scripts are too dangerous to exist in the production  =item $value1, $value2, ... $valueN
3346  environment. This method provides a simple way to prevent them  
3347  from working unless they are explicitly turned on by creating a password  List of numbers to compare.
3348  cookie via the B<SetPassword> script.  If debugging mode  
3349  is not turned on, an error will occur.  =item RETURN
3350    
3351    Returns the highest number in the list.
3352    
3353    =back
3354    
3355  =cut  =cut
3356    
3357  sub DebugMode {  sub Max {
3358      # Declare the return variable.      # Get the parameters. Note that we prime the return value with the first parameter.
3359      my $retVal = 0;      my ($retVal, @values) = @_;
3360      # Check the debug configuration.      # Loop through the remaining parameters, looking for the highest.
3361      my $password = CGI::cookie("DebugMode");      for my $value (@values) {
3362      my $encrypted = Digest::MD5::md5_hex($password);          if ($value > $retVal) {
3363      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.");  
3364      }      }
3365      # Return the determination indicator.      }
3366        # Return the maximum found.
3367      return $retVal;      return $retVal;
3368  }  }
3369    
# Line 2929  Line 3399 
3399      return $retVal;      return $retVal;
3400  }  }
3401    
3402    =head3 Trim
3403    
3404        my $string = Tracer::Trim($line);
3405    
3406    Trim all spaces from the beginning and ending of a string.
3407    
3408    =over 4
3409    
3410    =item line
3411    
3412    Line of text to be trimmed.
3413    
3414    =item RETURN
3415    
3416    The same line of text with all whitespace chopped off either end.
3417    
3418    =back
3419    
3420    =cut
3421    
3422    sub Trim {
3423        # Get a copy of the parameter string.
3424        my ($string) = @_;
3425        my $retVal = (defined $string ? $string : "");
3426        # Strip the front spaces.
3427        $retVal =~ s/^\s+//;
3428        # Strip the back spaces.
3429        $retVal =~ s/\s+$//;
3430        # Return the result.
3431        return $retVal;
3432    }
3433    
3434  =head3 Pad  =head3 Pad
3435    
3436      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
# Line 2990  Line 3492 
3492      return $retVal;      return $retVal;
3493  }  }
3494    
3495    =head3 Quoted
3496    
3497        my $string = Tracer::Quoted($var);
3498    
3499    Convert the specified value to a string and enclose it in single quotes.
3500    If it's undefined, the string C<undef> in angle brackets will be used
3501    instead.
3502    
3503    =over 4
3504    
3505    =item var
3506    
3507    Value to quote.
3508    
3509    =item RETURN
3510    
3511    Returns a string enclosed in quotes, or an indication the value is undefined.
3512    
3513    =back
3514    
3515    =cut
3516    
3517    sub Quoted {
3518        # Get the parameters.
3519        my ($var) = @_;
3520        # Declare the return variable.
3521        my $retVal;
3522        # Are we undefined?
3523        if (! defined $var) {
3524            $retVal = "<undef>";
3525        } else {
3526            # No, so convert to a string and enclose in quotes.
3527            $retVal = $var;
3528            $retVal =~ s/'/\\'/;
3529            $retVal = "'$retVal'";
3530        }
3531        # Return the result.
3532        return $retVal;
3533    }
3534    
3535  =head3 EOF  =head3 EOF
3536    
3537  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 3079  Line 3621 
3621  }  }
3622    
3623    
3624    =head3 GetMemorySize
3625    
3626        my $string = Tracer::GetMemorySize();
3627    
3628    Return a memory size string for the current process. The string will be
3629    in comma format, with a size indicator (K, M, G) at the end.
3630    
3631    =cut
3632    
3633    sub GetMemorySize {
3634        # Get the memory size from Unix.
3635        my ($retVal) = `ps h -o vsz $$`;
3636        # Remove the ending new-line.
3637        chomp $retVal;
3638        # Format and return the result.
3639        return CommaFormat($retVal) . "K";
3640    }
3641    
3642  =head3 CompareLists  =head3 CompareLists
3643    
3644      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
# Line 3146  Line 3706 
3706      return ($inserted, $deleted);      return ($inserted, $deleted);
3707  }  }
3708    
3709    =head3 Cmp
3710    
3711        my $cmp = Tracer::Cmp($a, $b);
3712    
3713    This method performs a universal sort comparison. Each value coming in is
3714    separated into a text parts and number parts. The text
3715    part is string compared, and if both parts are equal, then the number
3716    parts are compared numerically. A stream of just numbers or a stream of
3717    just strings will sort correctly, and a mixed stream will sort with the
3718    numbers first. Strings with a label and a number will sort in the
3719    expected manner instead of lexically. Undefined values sort last.
3720    
3721    =over 4
3722    
3723    =item a
3724    
3725    First item to compare.
3726    
3727    =item b
3728    
3729    Second item to compare.
3730    
3731    =item RETURN
3732    
3733    Returns a negative number if the first item should sort first (is less), a positive
3734    number if the first item should sort second (is greater), and a zero if the items are
3735    equal.
3736    
3737    =back
3738    
3739    =cut
3740    
3741    sub Cmp {
3742        # Get the parameters.
3743        my ($a, $b) = @_;
3744        # Declare the return value.
3745        my $retVal;
3746        # Check for nulls.
3747        if (! defined($a)) {
3748            $retVal = (! defined($b) ? 0 : -1);
3749        } elsif (! defined($b)) {
3750            $retVal = 1;
3751        } else {
3752            # Here we have two real values. Parse the two strings.
3753            my @aParsed = _Parse($a);
3754            my @bParsed = _Parse($b);
3755            # Loop through the first string.
3756            while (! $retVal && @aParsed) {
3757                # Extract the string parts.
3758                my $aPiece = shift(@aParsed);
3759                my $bPiece = shift(@bParsed) || '';
3760                # Extract the number parts.
3761                my $aNum = shift(@aParsed);
3762                my $bNum = shift(@bParsed) || 0;
3763                # Compare the string parts insensitively.
3764                $retVal = (lc($aPiece) cmp lc($bPiece));
3765                # If they're equal, compare them sensitively.
3766                if (! $retVal) {
3767                    $retVal = ($aPiece cmp $bPiece);
3768                    # If they're STILL equal, compare the number parts.
3769                    if (! $retVal) {
3770                        $retVal = $aNum <=> $bNum;
3771                    }
3772                }
3773            }
3774        }
3775        # Return the result.
3776        return $retVal;
3777    }
3778    
3779    # This method parses an input string into a string parts alternating with
3780    # number parts.
3781    sub _Parse {
3782        # Get the incoming string.
3783        my ($string) = @_;
3784        # The pieces will be put in here.
3785        my @retVal;
3786        # Loop through as many alpha/num sets as we can.
3787        while ($string =~ /^(\D*)(\d+)(.*)/) {
3788            # Push the alpha and number parts into the return string.
3789            push @retVal, $1, $2;
3790            # Save the residual.
3791            $string = $3;
3792        }
3793        # If there's still stuff left, add it to the end with a trailing
3794        # zero.
3795        if ($string) {
3796            push @retVal, $string, 0;
3797        }
3798        # Return the list.
3799        return @retVal;
3800    }
3801    
3802    =head3 ListEQ
3803    
3804        my $flag = Tracer::ListEQ(\@a, \@b);
3805    
3806    Return TRUE if the specified lists contain the same strings in the same
3807    order, else FALSE.
3808    
3809    =over 4
3810    
3811    =item a
3812    
3813    Reference to the first list.
3814    
3815    =item b
3816    
3817    Reference to the second list.
3818    
3819    =item RETURN
3820    
3821    Returns TRUE if the two parameters are identical string lists, else FALSE.
3822    
3823    =back
3824    
3825    =cut
3826    
3827    sub ListEQ {
3828        # Get the parameters.
3829        my ($a, $b) = @_;
3830        # Declare the return variable. Start by checking the lengths.
3831        my $n = scalar(@$a);
3832        my $retVal = ($n == scalar(@$b));
3833        # Now compare the list elements.
3834        for (my $i = 0; $retVal && $i < $n; $i++) {
3835            $retVal = ($a->[$i] eq $b->[$i]);
3836        }
3837        # Return the result.
3838        return $retVal;
3839    }
3840    
3841    =head2 CGI Script Utilities
3842    
3843    =head3 ScriptSetup (deprecated)
3844    
3845        my ($cgi, $varHash) = ScriptSetup($noTrace);
3846    
3847    Perform standard tracing and debugging setup for scripts. The value returned is
3848    the CGI object followed by a pre-built variable hash. At the end of the script,
3849    the client should call L</ScriptFinish> to output the web page.
3850    
3851    This method calls L</ETracing> to configure tracing, which allows the tracing
3852    to be configured via the emergency tracing form on the debugging control panel.
3853    Tracing will then be turned on automatically for all programs that use the L</ETracing>
3854    method, which includes every program that uses this method or L</StandardSetup>.
3855    
3856    =over 4
3857    
3858    =item noTrace (optional)
3859    
3860    If specified, tracing will be suppressed. This is useful if the script wants to set up
3861    tracing manually.
3862    
3863    =item RETURN
3864    
3865    Returns a two-element list consisting of a CGI query object and a variable hash for
3866    the output page.
3867    
3868    =back
3869    
3870    =cut
3871    
3872    sub ScriptSetup {
3873        # Get the parameters.
3874        my ($noTrace) = @_;
3875        # Get the CGI query object.
3876        my $cgi = CGI->new();
3877        # Set up tracing if it's not suppressed.
3878        ETracing($cgi) unless $noTrace;
3879        # Create the variable hash.
3880        my $varHash = { results => '' };
3881        # Return the query object and variable hash.
3882        return ($cgi, $varHash);
3883    }
3884    
3885    =head3 ScriptFinish (deprecated)
3886    
3887        ScriptFinish($webData, $varHash);
3888    
3889    Output a web page at the end of a script. Either the string to be output or the
3890    name of a template file can be specified. If the second parameter is omitted,
3891    it is assumed we have a string to be output; otherwise, it is assumed we have the
3892    name of a template file. The template should have the variable C<DebugData>
3893    specified in any form that invokes a standard script. If debugging mode is turned
3894    on, a form field will be put in that allows the user to enter tracing data.
3895    Trace messages will be placed immediately before the terminal C<BODY> tag in
3896    the output, formatted as a list.
3897    
3898    A typical standard script would loook like the following.
3899    
3900        BEGIN {
3901            # Print the HTML header.
3902            print "CONTENT-TYPE: text/html\n\n";
3903        }
3904        use Tracer;
3905        use CGI;
3906        use FIG;
3907        # ... more uses ...
3908    
3909        my ($cgi, $varHash) = ScriptSetup();
3910        eval {
3911            # ... get data from $cgi, put it in $varHash ...
3912        };
3913        if ($@) {
3914            Trace("Script Error: $@") if T(0);
3915        }
3916        ScriptFinish("Html/MyTemplate.html", $varHash);
3917    
3918    The idea here is that even if the script fails, you'll see trace messages and
3919    useful output.
3920    
3921    =over 4
3922    
3923    =item webData
3924    
3925    A string containing either the full web page to be written to the output or the
3926    name of a template file from which the page is to be constructed. If the name
3927    of a template file is specified, then the second parameter must be present;
3928    otherwise, it must be absent.
3929    
3930    =item varHash (optional)
3931    
3932    If specified, then a reference to a hash mapping variable names for a template
3933    to their values. The template file will be read into memory, and variable markers
3934    will be replaced by data in this hash reference.
3935    
3936    =back
3937    
3938    =cut
3939    
3940    sub ScriptFinish {
3941        # Get the parameters.
3942        my ($webData, $varHash) = @_;
3943        # Check for a template file situation.
3944        my $outputString;
3945        if (defined $varHash) {
3946            # Here we have a template file. We need to determine the template type.
3947            my $template;
3948            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
3949                $template = "$FIG_Config::template_url/$webData";
3950            } else {
3951                $template = "<<$webData";
3952            }
3953            $outputString = PageBuilder::Build($template, $varHash, "Html");
3954        } else {
3955            # Here the user gave us a raw string.
3956            $outputString = $webData;
3957        }
3958        # Check for trace messages.
3959        if ($Destination ne "NONE" && $TraceLevel > 0) {
3960            # We have trace messages, so we want to put them at the end of the body. This
3961            # is either at the end of the whole string or at the beginning of the BODY
3962            # end-tag.
3963            my $pos = length $outputString;
3964            if ($outputString =~ m#</body>#gi) {
3965                $pos = (pos $outputString) - 7;
3966            }
3967            # If the trace messages were queued, we unroll them. Otherwise, we display the
3968            # destination.
3969            my $traceHtml;
3970            if ($Destination eq "QUEUE") {
3971                $traceHtml = QTrace('Html');
3972            } elsif ($Destination =~ /^>>(.+)$/) {
3973                # Here the tracing output it to a file. We code it as a hyperlink so the user
3974                # can copy the file name into the clipboard easily.
3975                my $actualDest = $1;
3976                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
3977            } else {
3978                # Here we have one of the special destinations.
3979                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
3980            }
3981            substr $outputString, $pos, 0, $traceHtml;
3982        }
3983        # Write the output string.
3984        print $outputString;
3985    }
3986    
3987  =head3 GenerateURL  =head3 GenerateURL
3988    
3989      my $queryUrl = Tracer::GenerateURL($page, %parameters);      my $queryUrl = Tracer::GenerateURL($page, %parameters);
# Line 3280  Line 4118 
4118      return $retVal;      return $retVal;
4119  }  }
4120    
4121  =head3 Cmp  =head3 TrackingCode
4122    
4123      my $cmp = Tracer::Cmp($a, $b);      my $html = Tracer::TrackingCode();
4124    
4125  This method performs a universal sort comparison. Each value coming in is  Returns the HTML code for doing web page traffic monitoring. If the
4126  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;
4127  part is string compared, and if both parts are equal, then the number  otherwise, it returns a bunch of javascript containing code for turning
4128  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.  
4129    
4130  =over 4  =cut
4131    
4132  =item a  sub TrackingCode {
4133        # Declare the return variable.
4134        my $retVal = "<!-- tracking off -->";
4135        # Determine if we're in production.
4136        if ($FIG_Config::site_meter) {
4137            $retVal = <<END_HTML
4138            <!-- Site Meter -->
4139            <script type="text/javascript" src="http://s20.sitemeter.com/js/counter.js?site=s20nmpdr">
4140            </script>
4141            <noscript>
4142            <a href="http://s20.sitemeter.com/stats.asp?site=s20nmpdr" target="_top">
4143            <img src="http://s20.sitemeter.com/meter.asp?site=s20nmpdr" alt="Site Meter" border="0"/></a>
4144            </noscript>
4145            <!-- Copyright (c)2006 Site Meter -->
4146    END_HTML
4147        }
4148        return $retVal;
4149    }
4150    
4151  First item to compare.  =head3 Clean
4152    
4153  =item b      my $cleaned = Tracer::Clean($string);
4154    
4155  Second item to compare.  Clean up a string for HTML display. This not only converts special
4156    characters to HTML entity names, it also removes control characters.
4157    
4158    =over 4
4159    
4160    =item string
4161    
4162    String to convert.
4163    
4164  =item RETURN  =item RETURN
4165    
4166  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
4167  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.  
4168    
4169  =back  =back
4170    
4171  =cut  =cut
4172    
4173  sub Cmp {  sub Clean {
4174      # Get the parameters.      # Get the parameters.
4175      my ($a, $b) = @_;      my ($string) = @_;
4176      # Declare the return value.      # Declare the return variable.
4177      my $retVal;      my $retVal = "";
4178      # Check for nulls.      # Only proceed if the value exists.
4179      if (! defined($a)) {      if (defined $string) {
4180          $retVal = (! defined($b) ? 0 : -1);          # Get the string.
4181      } elsif (! defined($b)) {          $retVal = $string;
4182          $retVal = 1;          # Clean the control characters.
4183      } else {          $retVal =~ tr/\x00-\x1F/?/;
4184          # Here we have two real values. Parse the two strings.          # Escape the rest.
4185          $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];  
         }  
4186      }      }
4187      # Return the result.      # Return the result.
4188      return $retVal;      return $retVal;
4189  }  }
4190    
4191    =head3 SortByValue
4192    
4193        my @keys = Tracer::SortByValue(\%hash);
4194    
4195    Get a list of hash table keys sorted by hash table values.
4196    
4197    =over 4
4198    
4199    =item hash
4200    
4201    Hash reference whose keys are to be extracted.
4202    
4203    =item RETURN
4204    
4205    Returns a list of the hash keys, ordered so that the corresponding hash values
4206    are in alphabetical sequence.
4207    
4208    =back
4209    
4210    =cut
4211    
4212    sub SortByValue {
4213        # Get the parameters.
4214        my ($hash) = @_;
4215        # Sort the hash's keys using the values.
4216        my @retVal = sort { Cmp($hash->{$a}, $hash->{$b}) } keys %$hash;
4217        # Return the result.
4218        return @retVal;
4219    }
4220    
4221    =head3 GetSet
4222    
4223        my $value = Tracer::GetSet($object, $name => $newValue);
4224    
4225    Get or set the value of an object field. The object is treated as an
4226    ordinary hash reference. If a new value is specified, it is stored in the
4227    hash under the specified name and then returned. If no new value is
4228    specified, the current value is returned.
4229    
4230    =over 4
4231    
4232    =item object
4233    
4234    Reference to the hash that is to be interrogated or updated.
4235    
4236    =item name
4237    
4238    Name of the field. This is the hash key.
4239    
4240    =item newValue (optional)
4241    
4242    New value to be stored in the field. If no new value is specified, the current
4243    value of the field is returned.
4244    
4245    =item RETURN
4246    
4247    Returns the value of the named field in the specified hash.
4248    
4249    =back
4250    
4251    =cut
4252    
4253    sub GetSet {
4254        # Get the parameters.
4255        my ($object, $name, $newValue) = @_;
4256        # Is a new value specified?
4257        if (defined $newValue) {
4258            # Yes, so store it.
4259            $object->{$name} = $newValue;
4260        }
4261        # Return the result.
4262        return $object->{$name};
4263    }
4264    
4265  1;  1;

Legend:
Removed from v.1.94  
changed lines
  Added in v.1.128

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3