[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.61, Fri Jul 28 02:03:04 2006 UTC revision 1.131, Wed Nov 17 11:32:35 2010 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 ScriptSetup ScriptFinish Insure ChDir);  
     @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 confess);
27      use CGI;      use CGI;
28      use Cwd;      use Cwd;
29      use FIG_Config;      use FIG_Config;
# Line 32  Line 33 
33      use File::Path;      use File::Path;
34      use File::stat;      use File::stat;
35      use LWP::UserAgent;      use LWP::UserAgent;
36        use Time::HiRes 'gettimeofday';
37        use URI::Escape;
38        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    
47  =head2 Introduction  =head2 Tracing
48    
49  This package provides simple tracing for debugging and reporting purposes. To use it simply call the  This package provides simple tracing for debugging and reporting purposes. To use it simply call the
50  L</TSetup> method to set the options and call L</Trace> to write out trace messages. Each trace  L</TSetup> or L</ETracing> method to set the options and call L</Trace> to write out trace messages.
51  message has a I<trace level> and I<category> associated with it. In addition, the tracing package itself  L</TSetup> and L</ETracing> both establish a I<trace level> and a list of I<categories>. Similarly,
52  has a list of categories and a single trace level set by the B<TSetup> method. Only messages whose trace  each trace message has a I<trace level> and I<category> associated with it. Only messages whose trace
53  level is less than or equal to this package's trace level and whose category is activated will  level is less than or equal to the setup trace level and whose category is activated will
54  be written. Thus, a higher trace level on a message indicates that the message  be written. Thus, a higher trace level on a message indicates that the message
55  is less likely to be seen. A higher trace level passed to B<TSetup> means more trace messages will  is less likely to be seen, while a higher trace level passed to B<TSetup> means more trace messages will
56  appear. To generate a trace message, use the following syntax.  appear.
57    
58    =head3 Putting Trace Messages in Your Code
59    
60  C<< Trace($message) if T(errors => 4); >>  To generate a trace message, use the following syntax.
61    
62        Trace($message) if T(errors => 4);
63    
64  This statement will produce a trace message if the trace level is 4 or more and the C<errors>  This statement will produce a trace message if the trace level is 4 or more and the C<errors>
65  category is active. Note that the special category C<main> is always active, so  category is active. There is a special category C<main> that is always active, so
66    
67  C<< Trace($message) if T(main => 4); >>      Trace($message) if T(main => 4);
68    
69  will trace if the trace level is 4 or more.  will trace if the trace level is 4 or more.
70    
# Line 59  Line 72 
72  following call is made in the B<Sprout> package, it will appear if the C<Sprout> category is  following call is made in the B<Sprout> package, it will appear if the C<Sprout> category is
73  active and the trace level is 2 or more.  active and the trace level is 2 or more.
74    
75  C<< Trace($message) if T(2); >>      Trace($message) if T(2);
76    
77    In scripts, where no package name is available, the category defaults to C<main>.
78    
79    =head3 Custom Tracing
80    
81    Many programs have customized tracing configured using the L</TSetup> method. This is no longer
82    the preferred method, but a knowledge of how custom tracing works can make the more modern
83    L</Emergency Tracing> easier to understand.
84    
85  To set up tracing, you call the L</TSetup> method. The method takes as input a trace level, a list  To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
86  of category names, and a set of options. The trace level and list of category names are  a list of category names, and a destination. The trace level and list of category names are
87  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
88    
89  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
90    
91  sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and  sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and
92  specifies that messages should be output as HTML paragraphs.  specifies that messages should be sent to the standard output.
93    
94  To turn on tracing for ALL categories, use an asterisk. The call below sets every category to  To turn on tracing for ALL categories, use an asterisk. The call below sets every category to
95  level 3 and writes the output to the standard error output. This sort of thing might be  level 3 and writes the output to the standard error output. This sort of thing might be
96  useful in a CGI environment.  useful in a CGI environment.
97    
98  C<< TSetup('3 *', 'WARN'); >>      TSetup('3 *', 'WARN');
99    
100  In addition to HTML and file output for trace messages, you can specify that the trace messages  In addition standard error and file output for trace messages, you can specify that the trace messages
101  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach
102  is useful if you are building a web page. Instead of having the trace messages interspersed with  is useful if you are building a web page. Instead of having the trace messages interspersed with
103  the page output, they can be gathered together and displayed at the end of the page. This makes  the page output, they can be gathered together and displayed at the end of the page. This makes
104  it easier to debug page formatting problems.  it easier to debug page formatting problems.
105    
106  Finally, you can specify that all trace messages be emitted as warnings.  Finally, you can specify that all trace messages be emitted to a file, or the standard output and
107    a file at the same time. To trace to a file, specify the filename with an output character in front
108    of it.
109    
110        TSetup('4 SQL', ">$fileName");
111    
112    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
113    bracket.
114    
115        TSetup('3 *', "+>$fileName");
116    
117  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.
118  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.
119  Thus, debugging information is available and easily retrieved even when the application is  Thus, debugging information is available and easily retrieved even when the application is
120  being used out in the field.  being used out in the field.
121    
122    =head3 Trace Levels
123    
124  There is no hard and fast rule on how to use trace levels. The following is therefore only  There is no hard and fast rule on how to use trace levels. The following is therefore only
125  a suggestion.  a suggestion.
126    
# Line 119  Line 151 
151    
152  =back  =back
153    
154    The format of trace messages is important because some utilities analyze trace files.
155    There are three fields-- the time stamp, the category name, and the text.
156    The time stamp is between square brackets and the category name between angle brackets.
157    After the category name there is a colon (C<:>) followed by the message text.
158    If the square brackets or angle brackets are missing, then the trace management
159    utilities assume that they are encountering a set of pre-formatted lines.
160    
161    Note, however, that this formatting is done automatically by the tracing functions. You
162    only need to know about it if you want to parse a trace file.
163    
164    =head3 Emergency Tracing
165    
166    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
168    from the debug form, which is accessed from the [[DebugConsole]]. Emergency tracing requires
169    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
171    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.
173    
174    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
175    generate one for you.
176    
177    You can activate and de-activate emergency tracing from the debugging control panel, as
178    well as display the trace file itself.
179    
180    To enable emergency tracing in your code, call
181    
182        ETracing($cgi)
183    
184    from a web script and
185    
186        ETracing()
187    
188    from a command-line script.
189    
190    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
192    using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
193    will be configured automatically.
194    
195  =cut  =cut
196    
197  # Declare the configuration variables.  # Declare the configuration variables.
198    
199  my $Destination = "NONE";   # Description of where to send the trace output.  my $Destination = "WARN";   # Description of where to send the trace output.
200  my $TeeFlag = 0;            # TRUE if output is going to a file and to the  my $TeeFlag = 0;            # TRUE if output is going to a file and to the
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
218    
219    =head3 Setups
220    
221        my $count = Tracer::Setups();
222    
223    Return the number of times L</TSetup> has been called.
224    
225    This method allows for the creation of conditional tracing setups where, for example, we
226    may want to set up tracing if nobody else has done it before us.
227    
228    =cut
229    
230  =head2 Public Methods  sub Setups {
231        return $SetupCount;
232    }
233    
234  =head3 TSetup  =head3 TSetup
235    
236  C<< TSetup($categoryList, $target); >>      TSetup($categoryList, $target);
237    
238  This method is used to specify the trace options. The options are stored as package data  This method is used to specify the trace options. The options are stored as package data
239  and interrogated by the L</Trace> and L</T> methods.  and interrogated by the L</Trace> and L</T> methods.
# Line 189  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() . " 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 211  Line 308 
308      $SetupCount++;      $SetupCount++;
309  }  }
310    
311  =head3 StandardSetup  =head3 SetLevel
312    
313  C<< my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV); >>      Tracer::SetLevel($newLevel);
314    
315  This method performs standard command-line parsing and tracing setup. The return  Modify the trace level. A higher trace level will cause more messages to appear.
 values are a hash of the command-line options and a list of the positional  
 parameters. Tracing is automatically set up and the command-line options are  
 validated.  
316    
317  This is a complex method that does a lot of grunt work. The parameters can  =over 4
 be more easily understood, however, once they are examined individually.  
318    
319  The I<categories> parameter is the most obtuse. It is a reference to a list of  =item newLevel
 special-purpose tracing categories. Most tracing categories are PERL package  
 names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,  
 B<ERDB>, and B<SproutLoad> packages, you would specify the categories  
320    
321      ["Sprout", "SproutLoad", "ERDB"]  Proposed new trace level.
322    
323  This would cause trace messages in the specified three packages to appear in  =back
 the output. There are threer special tracing categories that are automatically  
 handled by this method. In other words, if you used L</TSetup> you would need  
 to include these categories manually, but if you use this method they are turned  
 on automatically.  
324    
325  =over 4  =cut
326    
327  =item FIG  sub SetLevel {
328        $TraceLevel = $_[0];
329    }
330    
331  Turns on trace messages inside the B<FIG> package.  =head3 ParseDate
332    
333  =item SQL      my $time = Tracer::ParseDate($dateString);
334    
335  Traces SQL commands and activity.  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  =item Tracer  If a time of day is present, it must be in military time with two digits for
342    everything but the hour.
343    
344  Traces error messages and call stacks.  The year must be exactly four digits.
345    
346  =back  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  C<SQL> is only turned on if the C<-sql> option is specified in the command line.  It should be guaranteed that this method will parse the output of the L</Now> function.
 The trace level is specified using the C<-trace> command-line option. For example,  
 the following command line for C<TransactFeatures> turns on SQL tracing and runs  
 all tracing at level 3.  
351    
352      TransactFeatures -trace=3 -sql register ../xacts IDs.tbl  The parameters are as follows.
353    
354  Standard tracing is output to the standard output and echoed to the file  =over 4
 C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the  
 process ID. You can also specify the C<user> parameter to put a user ID  
 instead of a process ID in the trace file name. So, for example  
355    
356  The default trace level is 2. To get all messages, specify a trace level of 4.  =item dateString
 For a genome-by-genome update, use 3.  
357    
358      TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl  The date string to convert.
359    
360  would send the trace output to C<traceBruce.log> in the temporary directory.  =item RETURN
361    
362  The I<options> parameter is a reference to a hash containing the command-line  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
363  options, their default values, and an explanation of what they mean. Command-line  the date string is invalid. A valid date string must contain a month and day.
 options may be in the form of switches or keywords. In the case of a switch, the  
 option value is 1 if it is specified and 0 if it is not specified. In the case  
 of a keyword, the value is separated from the option name by an equal sign. You  
 can see this last in the command-line example above.  
364    
365  You can specify a different default trace level by setting C<$options->{trace}>  =back
 prior to calling this method.  
366    
367  An example at this point would help. Consider, for example, the command-line utility  =cut
 C<TransactFeatures>. It accepts a list of positional parameters plus the options  
 C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute  
 the following code.  
368    
369      my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],  # Universal month conversion table.
370                          { safe => [0, "use database transactions"],  use constant MONTHS => {    Jan =>  0, January   =>  0, '01' =>  0,  '1' =>  0,
371                            noAlias => [0, "do not expect aliases in CHANGE transactions"],                              Feb =>  1, February  =>  1, '02' =>  1,  '2' =>  1,
372                            start => [' ', "start with this genome"],                              Mar =>  2, March     =>  2, '03' =>  2,  '3' =>  2,
373                            tblFiles => [0, "output TBL files containing the corrected IDs"] },                              Apr =>  3, April     =>  3, '04' =>  3,  '4' =>  3,
374                          "command transactionDirectory IDfile",                              May =>  4, May       =>  4, '05' =>  4,  '5' =>  4,
375                        @ARGV);                              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.
386        my ($dateString) = @_;
387        # Declare the return variable.
388        my $retVal;
389        # Find the month and day of month. There are two ways that can happen. We check for the
390        # numeric style first. That way, if the user's done something like "Sun 12/22", then we
391        # won't be fooled into thinking the month is Sunday.
392        if ($dateString =~ m#\b(\d{1,2})/(\d{1,2})\b# || $dateString =~ m#\b(\w+)\s(\d{1,2})\b#) {
393            my ($mon, $mday) = (MONTHS->{$1}, $2);
394            # 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.
415        return $retVal;
416    }
417    
418  The call to C<ParseCommand> specifies the default values for the options and  =head3 LogErrors
 stores the actual options in a hash that is returned as C<$options>. The  
 positional parameters are returned in C<@parameters>.  
419    
420  The following is a sample command line for C<TransactFeatures>.      Tracer::LogErrors($fileName);
421    
422      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl  Route the standard error output to a log file.
423    
424  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional  =over 4
 parameters, and would find themselves in I<@parameters> after executing the  
 above code fragment. The tracing would be set to level 2, and the categories  
 would be C<FIG>, C<Tracer>, and <DocUtils>. C<FIG> and C<Tracer> are standard,  
 and C<DocUtils> was included because it came in within the first parameter  
 to this method. The I<$options> hash would be  
425    
426      { trace => 2, sql => 0, safe => 0,  =item fileName
       noAlias => 1, start => ' ', tblFiles => 0 }  
427    
428  Use of C<StandardSetup> in this way provides a simple way of performing  Name of the file to receive the error output.
 standard tracing setup and command-line parsing. Note that the caller is  
 not even aware of the command-line switches C<-trace> and C<-sql>, which  
 are used by this method to control the tracing. If additional tracing features  
 need to be added in the future, they can be processed by this method without  
 upsetting the command-line utilities.  
429    
430  If the C<background> option is specified on the command line, then the  =back
 standard and error outputs will be directed to files in the temporary  
 directory, using the same suffix as the trace file. So, if the command  
 line specified  
431    
432      -user=Bruce -background  =cut
433    
434  then the trace output would go to C<traceBruce.log>, the standard output to  sub LogErrors {
435  C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to      # Get the file name.
436  simplify starting a command in the background.      my ($fileName) = @_;
437        # Open the file as the standard error output.
438        open STDERR, '>', $fileName;
439    }
440    
441  Finally, if the special option C<-h> is specified, the option names will  =head3 Trace
 be traced at level 0 and the program will exit without processing.  
 This provides a limited help capability. For example, if the user enters  
442    
443      TransactFeatures -h      Trace($message);
444    
445  he would see the following output.  Write a trace message to the target location specified in L</TSetup>. If there has not been
446    any prior call to B<TSetup>.
447    
448      TransactFeatures [options] command transactionDirectory IDfile  =over 4
         -trace    tracing level (default 2)  
         -sql      trace SQL commands  
         -safe     use database transactions  
         -noAlias  do not expect aliases in CHANGE transactions  
         -start    start with this genome  
         -tblFiles output TBL files containing the corrected IDs  
449    
450  The caller has the option of modifying the tracing scheme by placing a value  =item message
 for C<trace> in the incoming options hash. The default value can be overridden,  
 or the tracing to the standard output can be turned off by suffixing a minus  
 sign to the trace level. So, for example,  
451    
452      { trace => [0, "tracing level (default 0)"],  Message to write.
        ...  
453    
454  would set the default trace level to 0 instead of 2, while  =back
455    
456      { trace => ["2-", "tracing level (default 2)"],  =cut
        ...  
457    
458  would leave the default at 2, but trace only to the log file, not to the  sub Trace {
459  standard output.      # Get the parameters.
460        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.
470        my $timeStamp = Now();
471        # Build the prefix.
472        my $level = $LevelNames[$LastLevel] || "($LastLevel)";
473        my $prefix = "[$timeStamp] [$level] [$LastCategory]$callerInfo";
474        # Format the message.
475        my $formatted = "$prefix $stripped";
476        # Process according to the destination.
477        if ($Destination eq "TEXT") {
478            # Write the message to the standard output.
479            print "$formatted\n";
480        } elsif ($Destination eq "ERROR") {
481            # Write the message to the error output. Here, we want our prefix fields.
482            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") {
489            # Push the message into the queue.
490            push @Queue, "$formatted";
491        } elsif ($Destination eq "HTML") {
492            # Convert the message to HTML.
493            my $escapedMessage = CGI::escapeHTML($stripped);
494            # The stuff after the first line feed should be pre-formatted.
495            my @lines = split /\s*\n/, $escapedMessage;
496            # Get the normal portion.
497            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/^>>/) {
503            # Write the trace message to an output file.
504            open(TRACING, $Destination) || confess("Tracing open for \"$Destination\" failed: $!");
505            # Lock the file.
506            flock TRACING, LOCK_EX;
507            print TRACING "$formatted\n";
508            close TRACING;
509            # If the Tee flag is on, echo it to the standard output.
510            if ($TeeFlag) {
511                print "$formatted\n";
512            }
513        }
514    }
515    
516  The parameters to this method are as follows.  =head3 MemTrace
517    
518        MemTrace($message);
519    
520    Output a trace message that includes memory size information.
521    
522  =over 4  =over 4
523    
524  =item categories  =item message
525    
526  Reference to a list of tracing category names. These should be names of  Message to display. The message will be followed by a sentence about the memory size.
 packages whose internal workings will need to be debugged to get the  
 command working.  
527    
528  =item options  =back
529    
530  Reference to a hash containing the legal options for the current command mapped  =cut
 to their default values and descriptions. The user can override the defaults  
 by specifying the options as command-line switches prefixed by a hyphen.  
 Tracing-related options may be added to this hash. If the C<-h> option is  
 specified on the command line, the option descriptions will be used to  
 explain the options. To turn off tracing to the standard output, add a  
 minus sign to the value for C<trace> (see above).  
531    
532  =item parmHelp  sub MemTrace {
533        # Get the parameters.
534        my ($message) = @_;
535        my $memory = GetMemorySize();
536        Trace("$message $memory in use.");
537    }
538    
 A string that vaguely describes the positional parameters. This is used  
 if the user specifies the C<-h> option.  
539    
540  =item argv  =head3 TraceDump
541    
542  List of command line parameters, including the option switches, which must      TraceDump($title, $object);
 precede the positional parameters and be prefixed by a hyphen.  
543    
544  =item RETURN  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  Returns a list. The first element of the list is the reference to a hash that  =over 4
550  maps the command-line option switches to their values. These will either be the  
551  default values or overrides specified on the command line. The remaining  =item title
552  elements of the list are the position parameters, in order.  
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  =back
560    
561  =cut  =cut
562    
563  sub StandardSetup {  sub TraceDump {
564      # Get the parameters.      # Get the parameters.
565      my ($categories, $options, $parmHelp, @argv) = @_;      my ($title, $object) = @_;
566      # Add the tracing options.      # Trace the object.
567      if (! exists $options->{trace}) {      Trace("Object dump for $title:\n" . Dumper($object));
         $options->{trace} = [2, "tracing level"];  
568      }      }
569      $options->{sql} = [0, "turn on SQL tracing"];  
570      $options->{h} = [0, "display command-line options"];  =head3 T
571      $options->{user} = [$$, "trace log file name suffix"];  
572      $options->{background} = [0, "spool standard and error output"];      my $switch = T($category, $traceLevel);
573      # Create a parsing hash from the options hash. The parsing hash  
574      # contains the default values rather than the default value      or
575      # and the description. While we're at it, we'll memorize the  
576      # length of the longest option name.      my $switch = T($traceLevel);
577      my $longestName = 0;  
578      my %parseOptions = ();  Return TRUE if the trace level is at or above a specified value and the specified category
579      for my $key (keys %{$options}) {  is active, else FALSE. If no category is specified, the caller's package name is used.
580    
581    =over 4
582    
583    =item category
584    
585    Category to which the message belongs. If not specified, the caller's package name is
586    used.
587    
588    =item traceLevel
589    
590    Relevant tracing level.
591    
592    =item RETURN
593    
594    TRUE if a message at the specified trace level would appear in the trace, else FALSE.
595    
596    =back
597    
598    =cut
599    
600    sub T {
601        # Declare the return variable.
602        my $retVal = 0;
603        # Only proceed if tracing is turned on.
604        if ($Destination ne "NONE") {
605            # Get the parameters.
606            my ($category, $traceLevel) = @_;
607            if (!defined $traceLevel) {
608                # Here we have no category, so we need to get the calling package.
609                # The calling package is normally the first parameter. If it is
610                # omitted, the first parameter will be the tracelevel. So, the
611                # first thing we do is shift the so-called category into the
612                # $traceLevel variable where it belongs.
613                $traceLevel = $category;
614                my ($package, $fileName, $line) = caller;
615                # If there is no calling package, we default to "main".
616                if (!$package) {
617                    $category = "main";
618                } else {
619                    my @cats = split /::/, $package;
620                    $category = $cats[$#cats];
621                }
622            }
623            # Save the category name and level.
624            $LastCategory = $category;
625            $LastLevel = $traceLevel;
626            # Convert it to lower case before we hash it.
627            $category = lc $category;
628            # Validate the trace level.
629            if (ref $traceLevel) {
630                Confess("Bad trace level.");
631            } elsif (ref $TraceLevel) {
632                Confess("Bad trace config.");
633            }
634            # 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.
638        return $retVal;
639    }
640    
641    =head3 QTrace
642    
643        my $data = QTrace($format);
644    
645    Return the queued trace data in the specified format.
646    
647    =over 4
648    
649    =item format
650    
651    C<html> to format the data as an HTML list, C<text> to format it as straight text.
652    
653    =back
654    
655    =cut
656    
657    sub QTrace {
658        # Get the parameter.
659        my ($format) = @_;
660        # Create the return variable.
661        my $retVal = "";
662        # Only proceed if there is an actual queue.
663        if (@Queue) {
664            # Process according to the format.
665            if ($format =~ m/^HTML$/i) {
666                # Convert the queue into an HTML list.
667                $retVal = "<ul>\n";
668                for my $line (@Queue) {
669                    my $escapedLine = CGI::escapeHTML($line);
670                    $retVal .= "<li>$escapedLine</li>\n";
671                }
672                $retVal .= "</ul>\n";
673            } elsif ($format =~ m/^TEXT$/i) {
674                # Convert the queue into a list of text lines.
675                $retVal = join("\n", @Queue) . "\n";
676            }
677            # Clear the queue.
678            @Queue = ();
679        }
680        # Return the formatted list.
681        return $retVal;
682    }
683    
684    =head3 Confess
685    
686        Confess($message);
687    
688    Trace the call stack and abort the program with the specified message. When used with
689    the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.
690    So, for example
691    
692        Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
693    
694    Will abort the program with a stack trace if the value of C<$recNum> is negative.
695    
696    =over 4
697    
698    =item message
699    
700    Message to include in the trace.
701    
702    =back
703    
704    =cut
705    
706    sub Confess {
707        # Get the parameters.
708        my ($message) = @_;
709        # Set up the category and level.
710        $LastCategory = "(confess)";
711        $LastLevel = 0;
712        # Trace the call stack.
713        Cluck($message);
714        # Increment the confession count.
715        $Confessions++;
716        # Abort the program.
717        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
978    
979        Assert($condition1, $condition2, ... $conditionN);
980    
981    Return TRUE if all the conditions are true. This method can be used in conjunction with
982    the OR operator and the L</Confess> method as a debugging assert.
983    So, for example
984    
985        Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
986    
987    Will abort the program with a stack trace if the value of C<$recNum> is negative.
988    
989    =cut
990    sub Assert {
991        my $retVal = 1;
992        LOOP: for my $condition (@_) {
993            if (! $condition) {
994                $retVal = 0;
995                last LOOP;
996            }
997        }
998        return $retVal;
999    }
1000    
1001    =head3 Cluck
1002    
1003        Cluck($message);
1004    
1005    Trace the call stack. Note that for best results, you should qualify the call with a
1006    trace condition. For example,
1007    
1008        Cluck("Starting record parse.") if T(3);
1009    
1010    will only trace the stack if the trace level for the package is 3 or more.
1011    
1012    =over 4
1013    
1014    =item message
1015    
1016    Message to include in the trace.
1017    
1018    =back
1019    
1020    =cut
1021    
1022    sub Cluck {
1023        # Get the parameters.
1024        my ($message) = @_;
1025        # Trace what's happening.
1026        Trace("Stack trace for event: $message");
1027        # Get the stack trace.
1028        my @trace = LongMess();
1029        # Convert the trace to a series of messages.
1030        for my $line (@trace) {
1031            # 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 LongMess
1041    
1042        my @lines = Tracer::LongMess();
1043    
1044    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
1048    
1049    sub LongMess {
1050        # Declare the return variable.
1051        my @retVal = ();
1052        my $confession = longmess("");
1053        for my $line (split /\s*\n/, $confession) {
1054            unless ($line =~ /Tracer\.pm/) {
1055                # Here we have a line worth keeping. Push it onto the result list.
1056                push @retVal, $line;
1057            }
1058        }
1059        # Return the result.
1060        return @retVal;
1061    }
1062    
1063    =head3 ETracing
1064    
1065        ETracing($parameter, %options);
1066    
1067    Set up emergency tracing. Emergency tracing is tracing that is turned
1068    on automatically for any program that calls this method. The emergency
1069    tracing parameters are stored in a a file identified by a tracing key.
1070    If this method is called with a CGI object, then the tracing key is
1071    taken from a cookie. If it is called with no parameters, then the tracing
1072    key is taken from an environment variable. If it is called with a string,
1073    the tracing key is that string.
1074    
1075    =over 4
1076    
1077    =item parameter
1078    
1079    A parameter from which the tracing key is computed. If it is a scalar,
1080    that scalar is used as the tracing key. If it is a CGI object, the
1081    tracing key is taken from the C<IP> cookie. If it is omitted, the
1082    tracing key is taken from the C<TRACING> environment variable. If it
1083    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.
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
1106    
1107    =back
1108    
1109    =cut
1110    
1111    sub ETracing {
1112        # Get the parameter.
1113        my ($parameter, %options) = @_;
1114        # Check for CGI mode.
1115        if (defined $parameter && ref $parameter eq 'CGI') {
1116            $SavedCGI = $parameter;
1117        } else {
1118            $SavedCGI = undef;
1119        }
1120        # Check for the noParms option.
1121        my $noParms = $options{noParms} || 0;
1122        # Get the default tracing information.
1123        my $tracing = $options{level} || 0;
1124        my $dest = $options{destType} || "WARN";
1125        # Check for emergency tracing.
1126        my $tkey = EmergencyKey($parameter);
1127        my $emergencyFile = EmergencyFileName($tkey);
1128        if (-e $emergencyFile && (my $stat = stat($emergencyFile))) {
1129            # We have the file. Read in the data.
1130            my @tracing = GetFile($emergencyFile);
1131            # Pull off the time limit.
1132            my $expire = shift @tracing;
1133            # Convert it to seconds.
1134            $expire *= 3600;
1135            # Check the file data.
1136            my ($now) = gettimeofday;
1137            if ($now - $stat->mtime <= $expire) {
1138                # Emergency tracing is on. Pull off the destination and
1139                # the trace level;
1140                $dest = shift @tracing;
1141                my $level = shift @tracing;
1142                # Insure Tracer is specified.
1143                my %moduleHash = map { $_ => 1 } @tracing;
1144                $moduleHash{Tracer} = 1;
1145                # Set the trace parameter.
1146                $tracing = join(" ", $level, sort keys %moduleHash);
1147            }
1148        }
1149        # Convert the destination to a real tracing destination.
1150        $dest = EmergencyTracingDest($tkey, $dest);
1151        # Setup the tracing we've determined from all the stuff above.
1152        TSetup($tracing, $dest);
1153        # Check to see if we're a web script.
1154        if (defined $SavedCGI) {
1155            # Yes we are. Trace the form and environment data if it's not suppressed.
1156            if (! $noParms) {
1157                TraceParms($SavedCGI);
1158            }
1159            # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1160            # emitted by the script in its raw form.
1161            if (T(Raw => 3)) {
1162                print CGI::header(-type => 'text/plain', -tracing => 'Raw');
1163            }
1164        }
1165    }
1166    
1167    =head3 EmergencyFileName
1168    
1169        my $fileName = Tracer::EmergencyFileName($tkey);
1170    
1171    Return the emergency tracing file name. This is the file that specifies
1172    the tracing information.
1173    
1174    =over 4
1175    
1176    =item tkey
1177    
1178    Tracing key for the current program.
1179    
1180    =item RETURN
1181    
1182    Returns the name of the file to contain the emergency tracing information.
1183    
1184    =back
1185    
1186    =cut
1187    
1188    sub EmergencyFileName {
1189        # Get the parameters.
1190        my ($tkey) = @_;
1191        # Compute the emergency tracing file name.
1192        return "$FIG_Config::temp/Emergency$tkey.txt";
1193    }
1194    
1195    =head3 EmergencyFileTarget
1196    
1197        my $fileName = Tracer::EmergencyFileTarget($tkey);
1198    
1199    Return the emergency tracing target file name. This is the file that receives
1200    the tracing output for file-based tracing.
1201    
1202    =over 4
1203    
1204    =item tkey
1205    
1206    Tracing key for the current program.
1207    
1208    =item RETURN
1209    
1210    Returns the name of the file to contain the trace output.
1211    
1212    =back
1213    
1214    =cut
1215    
1216    sub EmergencyFileTarget {
1217        # Get the parameters.
1218        my ($tkey) = @_;
1219        # Compute the emergency tracing file name.
1220        return "$FIG_Config::temp/trace$tkey.log";
1221    }
1222    
1223    =head3 EmergencyTracingDest
1224    
1225        my $dest = Tracer::EmergencyTracingDest($tkey, $myDest);
1226    
1227    This method converts an emergency tracing destination to a real
1228    tracing destination. The main difference is that if the
1229    destination is C<FILE> or C<APPEND>, we convert it to file
1230    output. If the destination is C<DUAL>, we convert it to file
1231    and standard output.
1232    
1233    =over 4
1234    
1235    =item tkey
1236    
1237    Tracing key for this environment.
1238    
1239    =item myDest
1240    
1241    Destination from the emergency tracing file.
1242    
1243    =item RETURN
1244    
1245    Returns a destination that can be passed into L</TSetup>.
1246    
1247    =back
1248    
1249    =cut
1250    
1251    sub EmergencyTracingDest {
1252        # Get the parameters.
1253        my ($tkey, $myDest) = @_;
1254        # Declare the return variable.
1255        my $retVal = $myDest;
1256        # Process according to the destination value.
1257        if ($myDest eq 'FILE') {
1258            $retVal = ">" . EmergencyFileTarget($tkey);
1259        } elsif ($myDest eq 'APPEND') {
1260            $retVal = ">>" . EmergencyFileTarget($tkey);
1261        } elsif ($myDest eq 'DUAL') {
1262            $retVal = "+>" . EmergencyFileTarget($tkey);
1263        } elsif ($myDest eq 'WARN') {
1264            $retVal = "WARN";
1265        }
1266        # Return the result.
1267        return $retVal;
1268    }
1269    
1270    =head3 Emergency
1271    
1272        Emergency($key, $hours, $dest, $level, @modules);
1273    
1274    Turn on emergency tracing. This method is normally invoked over the web from
1275    a debugging console, but it can also be called by the C<trace.pl> script.
1276    The caller specifies the duration of the emergency in hours, the desired tracing
1277    destination, the trace level, and a list of the trace modules to activate.
1278    For the length of the duration, when a program in an environment with the
1279    specified tracing key active invokes a Sprout CGI script, tracing will be
1280    turned on automatically. See L</TSetup> for more about tracing setup and
1281    L</ETracing> for more about emergency tracing.
1282    
1283    =over 4
1284    
1285    =item tkey
1286    
1287    The tracing key. This is used to identify the control file and the trace file.
1288    
1289    =item hours
1290    
1291    Number of hours to keep emergency tracing alive.
1292    
1293    =item dest
1294    
1295    Tracing destination. If no path information is specified for a file
1296    destination, it is put in the FIG temporary directory.
1297    
1298    =item level
1299    
1300    Tracing level. A higher level means more trace messages.
1301    
1302    =item modules
1303    
1304    A list of the tracing modules to activate.
1305    
1306    =back
1307    
1308    =cut
1309    
1310    sub Emergency {
1311        # Get the parameters.
1312        my ($tkey, $hours, $dest, $level, @modules) = @_;
1313        # Create the emergency file.
1314        my $specFile = EmergencyFileName($tkey);
1315        my $outHandle = Open(undef, ">$specFile");
1316        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
1317    }
1318    
1319    =head3 EmergencyKey
1320    
1321        my $tkey = EmergencyKey($parameter);
1322    
1323    Return the Key to be used for emergency tracing. This could be an IP address,
1324     a session ID, or a user name, depending on the environment.
1325    
1326    =over 4
1327    
1328    =item parameter
1329    
1330    Parameter defining the method for finding the tracing key. If it is a scalar,
1331    then it is presumed to be the tracing key itself. If it is a CGI object, then
1332    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
1333    taken from the C<TRACING> environment variable.
1334    
1335    =item RETURN
1336    
1337    Returns the key to be used for labels in emergency tracing.
1338    
1339    =back
1340    
1341    =cut
1342    
1343    sub EmergencyKey {
1344        # Get the parameters.
1345        my ($parameter) = @_;
1346        # Declare the return variable.
1347        my $retVal;
1348        # Determine the parameter type.
1349        if (! defined $parameter) {
1350            # Here we're supposed to check the environment. If that fails, we
1351            # get the effective login ID.
1352            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1353        } else {
1354            my $ptype = ref $parameter;
1355            if ($ptype eq 'CGI') {
1356                # Here we were invoked from a web page. Look for a cookie.
1357                $retVal = $parameter->cookie('IP');
1358            } elsif (! $ptype) {
1359                # Here the key was passed in.
1360                $retVal = $parameter;
1361            }
1362        }
1363        # If no luck finding a key, use the PID.
1364        if (! defined $retVal) {
1365            $retVal = $$;
1366        }
1367        # Return the result.
1368        return $retVal;
1369    }
1370    
1371    
1372    =head3 TraceParms
1373    
1374        Tracer::TraceParms($cgi);
1375    
1376    Trace the CGI parameters at trace level CGI => 3 and the environment variables
1377    at level CGI => 4. A self-referencing URL is traced at level CGI => 2.
1378    
1379    =over 4
1380    
1381    =item cgi
1382    
1383    CGI query object containing the parameters to trace.
1384    
1385    =back
1386    
1387    =cut
1388    
1389    sub TraceParms {
1390        # Get the parameters.
1391        my ($cgi) = @_;
1392        if (T(CGI => 2)) {
1393            # Here we trace the GET-style URL for the script, but only if it's
1394            # relatively small.
1395            my $url = $cgi->url(-relative => 1, -query => 1);
1396            my $len = length($url);
1397            if ($len < 500) {
1398                Trace("[URL] $url");
1399            } elsif ($len > 2048) {
1400                Trace("[URL] URL is too long to use with GET ($len characters).");
1401            } else {
1402                Trace("[URL] URL length is $len characters.");
1403            }
1404        }
1405        if (T(CGI => 3)) {
1406            # Here we want to trace the parameter data.
1407            my @names = $cgi->param;
1408            for my $parmName (sort @names) {
1409                # Note we skip the Trace parameters, which are for our use only.
1410                if ($parmName ne 'Trace' && $parmName ne 'TF') {
1411                    my @values = $cgi->param($parmName);
1412                    Trace("[CGI] $parmName = " . join(", ", @values));
1413                }
1414            }
1415            # Display the request method.
1416            my $method = $cgi->request_method();
1417            Trace("Method: $method");
1418        }
1419        if (T(CGI => 4)) {
1420            # Here we want the environment data too.
1421            for my $envName (sort keys %ENV) {
1422                Trace("[ENV] $envName = $ENV{$envName}");
1423            }
1424        }
1425    }
1426    
1427    =head3 TraceImages
1428    
1429        Tracer::TraceImages($htmlString);
1430    
1431    Trace information about all of an html document's images. The tracing
1432    will be for type "IMG" at level 3. The image's source string
1433    will be displayed. This is generally either the URL of the image or
1434    raw data for the image itself. If the source is too long, only the first 300
1435    characters will be shown at trace level 3. The entire source will be shown,
1436    however, at trace level 4. This method is not very smart, and might catch
1437    Javascript code, but it is still useful when debugging the arcane
1438    behavior of images in multiple browser environments.
1439    
1440    =over 4
1441    
1442    =item htmlString
1443    
1444    HTML text for an outgoing web page.
1445    
1446    =back
1447    
1448    =cut
1449    
1450    sub TraceImages {
1451        # Only proceed if we're at the proper trace level.
1452        if (T(IMG => 3)) {
1453            # For performance reasons we're manipulating $_[0] instead of retrieving the string
1454            # into a variable called "$htmlString". This is because we expect html strings to be
1455            # long, and don't want to copy them any more than we have to.
1456            Trace(length($_[0]) . " characters in web page.");
1457            # Loop through the HTML, culling image tags.
1458            while ($_[0] =~ /<img\s+[^>]+?src="([^"]+)"/sgi) {
1459                # Extract the source string and determine whether or not it's too long.
1460                my $srcString = $1;
1461                my $pos = pos($_[0]) - length($srcString);
1462                my $excess = length($srcString) - 300;
1463                # We'll put the display string in here.
1464                my $srcDisplay = $srcString;
1465                # If it's a data string, split it at the comma.
1466                $srcDisplay =~ s/^(data[^,]+,)/$1\n/;
1467                # If there's no excess or we're at trace level 4, we're done. At level 3 with
1468                # a long string, however, we only show the first 300 characters.
1469                if ($excess > 0 && ! T(IMG => 4)) {
1470                    $srcDisplay = substr($srcDisplay,0,300) . "\nplus $excess characters.";
1471                }
1472                # Output the trace message.
1473                Trace("Image tag at position $pos:\n$srcDisplay");
1474            }
1475        }
1476    }
1477    
1478    =head2 Command-Line Utility Methods
1479    
1480    =head3 SendSMS
1481    
1482        my $msgID = Tracer::SendSMS($phoneNumber, $msg);
1483    
1484    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1485    user name, password, and API ID for the relevant account in the hash reference variable
1486    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1487    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1488    is C<2561022>, then the FIG_Config file must contain
1489    
1490        $phone =  { user => 'BruceTheHumanPet',
1491                    password => 'silly',
1492                    api_id => '2561022' };
1493    
1494    The original purpose of this method was to insure Bruce would be notified immediately when the
1495    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1496    when you call this method.
1497    
1498    The message ID will be returned if successful, and C<undef> if an error occurs.
1499    
1500    =over 4
1501    
1502    =item phoneNumber
1503    
1504    Phone number to receive the message, in international format. A United States phone number
1505    would be prefixed by "1". A British phone number would be prefixed by "44".
1506    
1507    =item msg
1508    
1509    Message to send to the specified phone.
1510    
1511    =item RETURN
1512    
1513    Returns the message ID if successful, and C<undef> if the message could not be sent.
1514    
1515    =back
1516    
1517    =cut
1518    
1519    sub SendSMS {
1520        # Get the parameters.
1521        my ($phoneNumber, $msg) = @_;
1522        # Declare the return variable. If we do not change it, C<undef> will be returned.
1523        my $retVal;
1524        # Only proceed if we have phone support.
1525        if (! defined $FIG_Config::phone) {
1526            Trace("Phone support not present in FIG_Config.") if T(1);
1527        } else {
1528            # Get the phone data.
1529            my $parms = $FIG_Config::phone;
1530            # Get the Clickatell URL.
1531            my $url = "http://api.clickatell.com/http/";
1532            # Create the user agent.
1533            my $ua = LWP::UserAgent->new;
1534            # Request a Clickatell session.
1535            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
1536                                         password => $parms->{password},
1537                                         api_id => $parms->{api_id},
1538                                         to => $phoneNumber,
1539                                         text => $msg});
1540            # Check for an error.
1541            if (! $resp->is_success) {
1542                Trace("Alert failed.") if T(1);
1543            } else {
1544                # Get the message ID.
1545                my $rstring = $resp->content;
1546                if ($rstring =~ /^ID:\s+(.*)$/) {
1547                    $retVal = $1;
1548                } else {
1549                    Trace("Phone attempt failed with $rstring") if T(1);
1550                }
1551            }
1552        }
1553        # Return the result.
1554        return $retVal;
1555    }
1556    
1557    =head3 StandardSetup
1558    
1559        my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV);
1560    
1561    This method performs standard command-line parsing and tracing setup. The return
1562    values are a hash of the command-line options and a list of the positional
1563    parameters. Tracing is automatically set up and the command-line options are
1564    validated.
1565    
1566    This is a complex method that does a lot of grunt work. The parameters can
1567    be more easily understood, however, once they are examined individually.
1568    
1569    The I<categories> parameter is the most obtuse. It is a reference to a list of
1570    special-purpose tracing categories. Most tracing categories are PERL package
1571    names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
1572    B<ERDB>, and B<SproutLoad> packages, you would specify the categories
1573    
1574        ["Sprout", "SproutLoad", "ERDB"]
1575    
1576    This would cause trace messages in the specified three packages to appear in
1577    the output. There are two special tracing categories that are automatically
1578    handled by this method. In other words, if you used L</TSetup> you would need
1579    to include these categories manually, but if you use this method they are turned
1580    on automatically.
1581    
1582    =over 4
1583    
1584    =item SQL
1585    
1586    Traces SQL commands and activity.
1587    
1588    =item Tracer
1589    
1590    Traces error messages and call stacks.
1591    
1592    =back
1593    
1594    C<SQL> is only turned on if the C<-sql> option is specified in the command line.
1595    The trace level is specified using the C<-trace> command-line option. For example,
1596    the following command line for C<TransactFeatures> turns on SQL tracing and runs
1597    all tracing at level 3.
1598    
1599        TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
1600    
1601    Standard tracing is output to the standard output and echoed to the file
1602    C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
1603    process ID. You can also specify the C<user> parameter to put a user ID
1604    instead of a process ID in the trace file name. So, for example
1605    
1606    The default trace level is 2. To get all messages, specify a trace level of 4.
1607    For a genome-by-genome update, use 3.
1608    
1609        TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
1610    
1611    would send the trace output to C<traceBruce.log> in the temporary directory.
1612    
1613    The I<options> parameter is a reference to a hash containing the command-line
1614    options, their default values, and an explanation of what they mean. Command-line
1615    options may be in the form of switches or keywords. In the case of a switch, the
1616    option value is 1 if it is specified and 0 if it is not specified. In the case
1617    of a keyword, the value is separated from the option name by an equal sign. You
1618    can see this last in the command-line example above.
1619    
1620    You can specify a different default trace level by setting C<$options->{trace}>
1621    prior to calling this method.
1622    
1623    An example at this point would help. Consider, for example, the command-line utility
1624    C<TransactFeatures>. It accepts a list of positional parameters plus the options
1625    C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
1626    the following code.
1627    
1628        my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
1629                            { safe => [0, "use database transactions"],
1630                              noAlias => [0, "do not expect aliases in CHANGE transactions"],
1631                              start => [' ', "start with this genome"],
1632                              tblFiles => [0, "output TBL files containing the corrected IDs"] },
1633                            "<command> <transactionDirectory> <IDfile>",
1634                          @ARGV);
1635    
1636    
1637    The call to C<ParseCommand> specifies the default values for the options and
1638    stores the actual options in a hash that is returned as C<$options>. The
1639    positional parameters are returned in C<@parameters>.
1640    
1641    The following is a sample command line for C<TransactFeatures>.
1642    
1643        TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
1644    
1645    Single and double hyphens are equivalent. So, you could also code the
1646    above command as
1647    
1648        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
1649    
1650    In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
1651    parameters, and would find themselves in I<@parameters> after executing the
1652    above code fragment. The tracing would be set to level 2, and the categories
1653    would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
1654    and C<DocUtils> was included because it came in within the first parameter
1655    to this method. The I<$options> hash would be
1656    
1657        { trace => 2, sql => 0, safe => 0,
1658          noAlias => 1, start => ' ', tblFiles => 0 }
1659    
1660    Use of C<StandardSetup> in this way provides a simple way of performing
1661    standard tracing setup and command-line parsing. Note that the caller is
1662    not even aware of the command-line switches C<-trace> and C<-sql>, which
1663    are used by this method to control the tracing. If additional tracing features
1664    need to be added in the future, they can be processed by this method without
1665    upsetting the command-line utilities.
1666    
1667    If the C<background> option is specified on the command line, then the
1668    standard and error outputs will be directed to files in the temporary
1669    directory, using the same suffix as the trace file. So, if the command
1670    line specified
1671    
1672        -user=Bruce -background
1673    
1674    then the trace output would go to C<traceBruce.log>, the standard output to
1675    C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
1676    simplify starting a command in the background.
1677    
1678    The user name is also used as the tracing key for L</Emergency Tracing>.
1679    Specifying a value of C<E> for the trace level causes emergency tracing to
1680    be used instead of custom tracing. If the user name is not specified,
1681    the tracing key is taken from the C<Tracing> environment variable. If there
1682    is no value for that variable, the tracing key will be computed from the active
1683    login ID.
1684    
1685    Since the default situation in StandardSetup is to trace to the standard
1686    output, errors that occur in command-line scripts will not generate
1687    RSS events. To force the events, use the C<warn> option.
1688    
1689        TransactFeatures -background -warn register ../xacts IDs.tbl
1690    
1691    Finally, if the special option C<-help> is specified, the option
1692    names will be traced at level 0 and the program will exit without processing.
1693    This provides a limited help capability. For example, if the user enters
1694    
1695        TransactFeatures -help
1696    
1697    he would see the following output.
1698    
1699        TransactFeatures [options] <command> <transactionDirectory> <IDfile>
1700            -trace    tracing level (default E)
1701            -sql      trace SQL commands
1702            -safe     use database transactions
1703            -noAlias  do not expect aliases in CHANGE transactions
1704            -start    start with this genome
1705            -tblFiles output TBL files containing the corrected IDs
1706            -forked   do not erase the trace file before tracing
1707    
1708    The caller has the option of modifying the tracing scheme by placing a value
1709    for C<trace> in the incoming options hash. The default value can be overridden,
1710    or the tracing to the standard output can be turned off by suffixing a minus
1711    sign to the trace level. So, for example,
1712    
1713        { trace => [0, "tracing level (default 0)"],
1714           ...
1715    
1716    would set the default trace level to 0 instead of E, while
1717    
1718        { trace => ["2-", "tracing level (default 2)"],
1719           ...
1720    
1721    would set the default to 2, but trace only to the log file, not to the
1722    standard output.
1723    
1724    The parameters to this method are as follows.
1725    
1726    =over 4
1727    
1728    =item categories
1729    
1730    Reference to a list of tracing category names. These should be names of
1731    packages whose internal workings will need to be debugged to get the
1732    command working.
1733    
1734    =item options
1735    
1736    Reference to a hash containing the legal options for the current command mapped
1737    to their default values and descriptions. The user can override the defaults
1738    by specifying the options as command-line switches prefixed by a hyphen.
1739    Tracing-related options may be added to this hash. If the C<-h> option is
1740    specified on the command line, the option descriptions will be used to
1741    explain the options. To turn off tracing to the standard output, add a
1742    minus sign to the value for C<trace> (see above).
1743    
1744    =item parmHelp
1745    
1746    A string that vaguely describes the positional parameters. This is used
1747    if the user specifies the C<-h> option.
1748    
1749    =item argv
1750    
1751    List of command line parameters, including the option switches, which must
1752    precede the positional parameters and be prefixed by a hyphen.
1753    
1754    =item RETURN
1755    
1756    Returns a list. The first element of the list is the reference to a hash that
1757    maps the command-line option switches to their values. These will either be the
1758    default values or overrides specified on the command line. The remaining
1759    elements of the list are the position parameters, in order.
1760    
1761    =back
1762    
1763    =cut
1764    
1765    sub StandardSetup {
1766        # Get the parameters.
1767        my ($categories, $options, $parmHelp, @argv) = @_;
1768        # Get the default tracing key.
1769        my $tkey = EmergencyKey();
1770        # Save the command line.
1771        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1772        # Add the tracing options.
1773        if (! exists $options->{trace}) {
1774            $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1775        }
1776        if (! exists $options->{forked}) {
1777            $options->{forked} = [0, "keep old trace file"];
1778        }
1779        $options->{sql} = [0, "turn on SQL tracing"];
1780        $options->{help} = [0, "display command-line options"];
1781        $options->{user} = [$tkey, "tracing key"];
1782        $options->{background} = [0, "spool standard and error output"];
1783        $options->{warn} = [0, "send errors to RSS feed"];
1784        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1785        # Create a parsing hash from the options hash. The parsing hash
1786        # contains the default values rather than the default value
1787        # and the description. While we're at it, we'll memorize the
1788        # length of the longest option name.
1789        my $longestName = 0;
1790        my %parseOptions = ();
1791        for my $key (keys %{$options}) {
1792          if (length $key > $longestName) {          if (length $key > $longestName) {
1793              $longestName = length $key;              $longestName = length $key;
1794          }          }
1795          $parseOptions{$key} = $options->{$key}->[0];          $parseOptions{$key} = $options->{$key}->[0];
1796        }
1797        # Parse the command line.
1798        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1799        # Get the logfile suffix.
1800        my $suffix = $retOptions->{user};
1801        # We'll put the trace file name in here. We need it later if background
1802        # mode is on.
1803        my $traceFileName;
1804        # Now we want to set up tracing. First, we need to know if the user
1805        # wants emergency tracing.
1806        if ($retOptions->{trace} eq 'E') {
1807            ETracing($retOptions->{user});
1808        } else {
1809            # Here the tracing is controlled from the command line.
1810            my @cats = @{$categories};
1811            if ($retOptions->{sql}) {
1812                push @cats, "SQL";
1813            }
1814            if ($retOptions->{warn}) {
1815                push @cats, "Feed";
1816            }
1817            # Add the default categories.
1818            push @cats, "Tracer";
1819            # Check for more tracing groups.
1820            if ($retOptions->{moreTracing}) {
1821                push @cats, split /,/, $retOptions->{moreTracing};
1822            }
1823            # Next, we create the category string by joining the categories.
1824            my $cats = join(" ", @cats);
1825            # Check to determine whether or not the caller wants to turn off tracing
1826            # to the standard output.
1827            my $traceLevel = $retOptions->{trace};
1828            my $textOKFlag = 1;
1829            if ($traceLevel =~ /^(.)-/) {
1830                $traceLevel = $1;
1831                $textOKFlag = 0;
1832            }
1833            # Now we set up the trace mode.
1834            my $traceMode;
1835            # Verify that we can open a file in the FIG temporary directory.
1836            my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1837            my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1838            if (open TESTTRACE, "$traceFileSpec") {
1839                # Here we can trace to a file.
1840                $traceMode = ">>$traceFileName";
1841                if ($textOKFlag) {
1842                    # Echo to standard output if the text-OK flag is set.
1843                    $traceMode = "+$traceMode";
1844                }
1845                # Close the test file.
1846                close TESTTRACE;
1847            } else {
1848                # Here we can't trace to a file. Complain about this.
1849                warn "Could not open trace file $traceFileName: $!\n";
1850                # We trace to the standard output if it's
1851                # okay, and the error log otherwise.
1852                if ($textOKFlag) {
1853                    $traceMode = "TEXT";
1854                } else {
1855                    $traceMode = "WARN";
1856                }
1857            }
1858            # Now set up the tracing.
1859            TSetup("$traceLevel $cats", $traceMode);
1860        }
1861        # Check for background mode.
1862        if ($retOptions->{background}) {
1863            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1864            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1865            # Spool the output.
1866            open STDOUT, ">$outFileName";
1867            # If we have a trace file, trace the errors to the log. Otherwise,
1868            # spool the errors.
1869            if (defined $traceFileName) {
1870                open STDERR, "| Tracer $traceFileName";
1871            } else {
1872                open STDERR, ">$errFileName";
1873            }
1874            # Check for phone support. If we have phone support and a phone number,
1875            # we want to turn it on.
1876            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1877                $retOptions->{phone} = $ENV{PHONE};
1878            }
1879        }
1880        # Check for the "help" option. If it is specified, dump the command-line
1881        # options and exit the program.
1882        if ($retOptions->{help}) {
1883            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
1884            print "$1 [options] $parmHelp\n";
1885            for my $key (sort keys %{$options}) {
1886                my $name = Pad($key, $longestName, 0, ' ');
1887                my $desc = $options->{$key}->[1];
1888                if ($options->{$key}->[0]) {
1889                    $desc .= " (default " . $options->{$key}->[0] . ")";
1890                }
1891                print "  $name $desc\n";
1892            }
1893            exit(0);
1894        }
1895        # Trace the options, if applicable.
1896        if (T(3)) {
1897            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
1898            Trace("Selected options: " . join(", ", sort @parms) . ".");
1899        }
1900        # Return the parsed parameters.
1901        return ($retOptions, @retParameters);
1902    }
1903    
1904    =head3 ReadOptions
1905    
1906        my %options = Tracer::ReadOptions($fileName);
1907    
1908    Read a set of options from a file. Each option is encoded in a line of text that has the
1909    format
1910    
1911    I<optionName>C<=>I<optionValue>C<; >I<comment>
1912    
1913    The option name must consist entirely of letters, digits, and the punctuation characters
1914    C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank
1915    character is a semi-colon will be ignored. The return hash will map each option name to
1916    the corresponding option value.
1917    
1918    =over 4
1919    
1920    =item fileName
1921    
1922    Name of the file containing the option data.
1923    
1924    =item RETURN
1925    
1926    Returns a hash mapping the option names specified in the file to their corresponding option
1927    value.
1928    
1929    =back
1930    
1931    =cut
1932    
1933    sub ReadOptions {
1934        # Get the parameters.
1935        my ($fileName) = @_;
1936        # Open the file.
1937        (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");
1938        # Count the number of records read.
1939        my ($records, $comments) = 0;
1940        # Create the return hash.
1941        my %retVal = ();
1942        # Loop through the file, accumulating key-value pairs.
1943        while (my $line = <CONFIGFILE>) {
1944            # Denote we've read a line.
1945            $records++;
1946            # Determine the line type.
1947            if ($line =~ /^\s*[\n\r]/) {
1948                # A blank line is a comment.
1949                $comments++;
1950            } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {
1951                # Here we have an option assignment.
1952                retVal{$1} = $2;
1953            } elsif ($line =~ /^\s*;/) {
1954                # Here we have a text comment.
1955                $comments++;
1956            } else {
1957                # Here we have an invalid line.
1958                Trace("Invalid option statement in record $records.") if T(0);
1959            }
1960        }
1961        # Return the hash created.
1962        return %retVal;
1963    }
1964    
1965    =head3 GetOptions
1966    
1967        Tracer::GetOptions(\%defaults, \%options);
1968    
1969    Merge a specified set of options into a table of defaults. This method takes two hash references
1970    as input and uses the data from the second to update the first. If the second does not exist,
1971    there will be no effect. An error will be thrown if one of the entries in the second hash does not
1972    exist in the first.
1973    
1974    Consider the following example.
1975    
1976        my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options);
1977    
1978    In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and
1979    B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of
1980    B<$options> is C<< {dbType => 'Oracle'} >>, then the database type will be changed to C<Oracle> and
1981    the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level
1982    will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as
1983    
1984        {databaseType => 'Oracle'}
1985    
1986    an error will occur because the B<databaseType> option does not exist.
1987    
1988    =over 4
1989    
1990    =item defaults
1991    
1992    Table of default option values.
1993    
1994    =item options
1995    
1996    Table of overrides, if any.
1997    
1998    =item RETURN
1999    
2000    Returns a reference to the default table passed in as the first parameter.
2001    
2002    =back
2003    
2004    =cut
2005    
2006    sub GetOptions {
2007        # Get the parameters.
2008        my ($defaults, $options) = @_;
2009        # Check for overrides.
2010        if ($options) {
2011            # Loop through the overrides.
2012            while (my ($option, $setting) = each %{$options}) {
2013                # Insure this override exists.
2014                if (!exists $defaults->{$option}) {
2015                    croak "Unrecognized option $option encountered.";
2016                } else {
2017                    # Apply the override.
2018                    $defaults->{$option} = $setting;
2019                }
2020      }      }
     # Parse the command line.  
     my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);  
     # Get the logfile suffix.  
     my $suffix = $retOptions->{user};  
     # Check for background mode.  
     if ($retOptions->{background}) {  
         my $outFileName = "$FIG_Config::temp/out$suffix.log";  
         my $errFileName = "$FIG_Config::temp/err$suffix.log";  
         open STDOUT, ">$outFileName";  
         open STDERR, ">$errFileName";  
2021      }      }
2022      # Now we want to set up tracing. First, we need to know if SQL is to      # Return the merged table.
2023      # be traced.      return $defaults;
     my @cats = @{$categories};  
     if ($retOptions->{sql}) {  
         push @cats, "SQL";  
2024      }      }
2025      # Add the default categories.  
2026      push @cats, "Tracer", "FIG";  =head3 MergeOptions
2027      # Next, we create the category string by joining the categories.  
2028      my $cats = join(" ", @cats);      Tracer::MergeOptions(\%table, \%defaults);
2029      # Check to determine whether or not the caller wants to turn off tracing  
2030      # to the standard output.  Merge default values into a hash table. This method looks at the key-value pairs in the
2031      my $traceLevel = $retOptions->{trace};  second (default) hash, and if a matching key is not found in the first hash, the default
2032      my $textOKFlag = 1;  pair is copied in. The process is similar to L</GetOptions>, but there is no error-
2033      if ($traceLevel =~ /^(.)-/) {  checking and no return value.
2034          $traceLevel = $1;  
2035          $textOKFlag = 0;  =over 4
2036    
2037    =item table
2038    
2039    Hash table to be updated with the default values.
2040    
2041    =item defaults
2042    
2043    Default values to be merged into the first hash table if they are not already present.
2044    
2045    =back
2046    
2047    =cut
2048    
2049    sub MergeOptions {
2050        # Get the parameters.
2051        my ($table, $defaults) = @_;
2052        # Loop through the defaults.
2053        while (my ($key, $value) = each %{$defaults}) {
2054            if (!exists $table->{$key}) {
2055                $table->{$key} = $value;
2056      }      }
     # Now we set up the trace mode.  
     my $traceMode;  
     # Verify that we can open a file in the FIG temporary directory.  
     my $traceFileName = "$FIG_Config::temp/trace$suffix.log";  
     if (open TESTTRACE, ">$traceFileName") {  
         # Here we can trace to a file.  
         $traceMode = ">$traceFileName";  
         if ($textOKFlag) {  
             # Echo to standard output if the text-OK flag is set.  
             $traceMode = "+$traceMode";  
2057          }          }
2058          # Close the test file.  }
2059          close TESTTRACE;  
2060    =head3 UnparseOptions
2061    
2062        my $optionString = Tracer::UnparseOptions(\%options);
2063    
2064    Convert an option hash into a command-line string. This will not
2065    necessarily be the same text that came in, but it will nonetheless
2066    produce the same ultimate result when parsed by L</StandardSetup>.
2067    
2068    =over 4
2069    
2070    =item options
2071    
2072    Reference to a hash of options to convert into an option string.
2073    
2074    =item RETURN
2075    
2076    Returns a string that will parse to the same set of options when
2077    parsed by L</StandardSetup>.
2078    
2079    =back
2080    
2081    =cut
2082    
2083    sub UnparseOptions {
2084        # Get the parameters.
2085        my ($options) = @_;
2086        # The option segments will be put in here.
2087        my @retVal = ();
2088        # Loop through the options.
2089        for my $key (keys %$options) {
2090            # Get the option value.
2091            my $value = $options->{$key};
2092            # Only use it if it's nonempty.
2093            if (defined $value && $value ne "") {
2094                my $segment = "--$key=$value";
2095                # Quote it if necessary.
2096                if ($segment =~ /[ |<>*]/) {
2097                    $segment = '"' . $segment . '"';
2098                }
2099                # Add it to the return list.
2100                push @retVal, $segment;
2101            }
2102        }
2103        # Return the result.
2104        return join(" ", @retVal);
2105    }
2106    
2107    =head3 ParseCommand
2108    
2109        my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
2110    
2111    Parse a command line consisting of a list of parameters. The initial parameters may be option
2112    specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped
2113    off and merged into a table of default options. The remainder of the command line is
2114    returned as a list of positional arguments. For example, consider the following invocation.
2115    
2116        my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words);
2117    
2118    In this case, the list @words will be treated as a command line and there are two options available,
2119    B<errors> and B<logFile>. If @words has the following format
2120    
2121        -logFile=error.log apple orange rutabaga
2122    
2123    then at the end of the invocation, C<$options> will be
2124    
2125        { errors => 0, logFile => 'error.log' }
2126    
2127    and C<@arguments> will contain
2128    
2129        apple orange rutabaga
2130    
2131    The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
2132    support for quote characters. Options can be specified with single or double hyphens.
2133    
2134    =over 4
2135    
2136    =item optionTable
2137    
2138    Table of default options.
2139    
2140    =item inputList
2141    
2142    List of words on the command line.
2143    
2144    =item RETURN
2145    
2146    Returns a reference to the option table and a list of the positional arguments.
2147    
2148    =back
2149    
2150    =cut
2151    
2152    sub ParseCommand {
2153        # Get the parameters.
2154        my ($optionTable, @inputList) = @_;
2155        # Process any options in the input list.
2156        my %overrides = ();
2157        while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
2158            # Get the current option.
2159            my $arg = shift @inputList;
2160            # Pull out the option name.
2161            $arg =~ /^--?([^=]*)/g;
2162            my $name = $1;
2163            # Check for an option value.
2164            if ($arg =~ /\G=(.*)$/g) {
2165                # Here we have a value for the option.
2166                $overrides{$name} = UnEscape($1);
2167      } else {      } else {
2168          # Here we can't trace to a file. We trace to the standard output if it's              # Here there is no value, so we use 1.
2169          # okay, and the error log otherwise.              $overrides{$name} = 1;
2170          if ($textOKFlag) {          }
2171              $traceMode = "TEXT";      }
2172        # Merge the options into the defaults.
2173        GetOptions($optionTable, \%overrides);
2174        # Translate the remaining parameters.
2175        my @retVal = ();
2176        for my $inputParm (@inputList) {
2177            push @retVal, UnEscape($inputParm);
2178        }
2179        # Return the results.
2180        return ($optionTable, @retVal);
2181    }
2182    
2183    
2184    =head2 File Utility Methods
2185    
2186    =head3 GetFile
2187    
2188        my @fileContents = Tracer::GetFile($fileName);
2189    
2190        or
2191    
2192        my $fileContents = Tracer::GetFile($fileName);
2193    
2194    Return the entire contents of a file. In list context, line-ends are removed and
2195    each line is a list element. In scalar context, line-ends are replaced by C<\n>.
2196    
2197    =over 4
2198    
2199    =item fileName
2200    
2201    Name of the file to read.
2202    
2203    =item RETURN
2204    
2205    In a list context, returns the entire file as a list with the line terminators removed.
2206    In a scalar context, returns the entire file as a string. If an error occurs opening
2207    the file, an empty list will be returned.
2208    
2209    =back
2210    
2211    =cut
2212    
2213    sub GetFile {
2214        # Get the parameters.
2215        my ($fileName) = @_;
2216        # Declare the return variable.
2217        my @retVal = ();
2218        # Open the file for input.
2219        my $handle = Open(undef, "<$fileName");
2220        # Read the whole file into the return variable, stripping off any terminator
2221        # characters.
2222        my $lineCount = 0;
2223        while (my $line = <$handle>) {
2224            $lineCount++;
2225            $line = Strip($line);
2226            push @retVal, $line;
2227        }
2228        # Close it.
2229        close $handle;
2230        my $actualLines = @retVal;
2231        Trace("$actualLines lines read from file $fileName.") if T(File => 2);
2232        # Return the file's contents in the desired format.
2233        if (wantarray) {
2234            return @retVal;
2235          } else {          } else {
2236              $traceMode = "WARN";          return join "\n", @retVal;
2237          }          }
2238      }      }
2239      # Now set up the tracing.  
2240      TSetup("$traceLevel $cats", $traceMode);  =head3 PutFile
2241      # Check for the "h" option. If it is specified, dump the command-line  
2242      # options and exit the program.      Tracer::PutFile($fileName, \@lines);
2243      if ($retOptions->{h}) {  
2244          $0 =~ m#[/\\](\w+)(\.pl)?$#i;  Write out a file from a list of lines of text.
2245          Trace("$1 [options] $parmHelp") if T(0);  
2246          for my $key (sort keys %{$options}) {  =over 4
2247              my $name = Pad($key, $longestName, 0, ' ');  
2248              my $desc = $options->{$key}->[1];  =item fileName
2249              if ($options->{$key}->[0]) {  
2250                  $desc .= " (default " . $options->{$key}->[0] . ")";  Name of the output file.
2251    
2252    =item lines
2253    
2254    Reference to a list of text lines. The lines will be written to the file in order, with trailing
2255    new-line characters. Alternatively, may be a string, in which case the string will be written without
2256    modification.
2257    
2258    =back
2259    
2260    =cut
2261    
2262    sub PutFile {
2263        # Get the parameters.
2264        my ($fileName, $lines) = @_;
2265        # Open the output file.
2266        my $handle = Open(undef, ">$fileName");
2267        # Count the lines written.
2268        if (ref $lines ne 'ARRAY') {
2269            # Here we have a scalar, so we write it raw.
2270            print $handle $lines;
2271            Trace("Scalar put to file $fileName.") if T(File => 3);
2272        } else {
2273            # Write the lines one at a time.
2274            my $count = 0;
2275            for my $line (@{$lines}) {
2276                print $handle "$line\n";
2277                $count++;
2278              }              }
2279              Trace("  $name $desc") if T(0);          Trace("$count lines put to file $fileName.") if T(File => 3);
2280          }          }
2281          exit(0);      # Close the output file.
2282        close $handle;
2283    }
2284    
2285    =head3 ParseRecord
2286    
2287        my @fields = Tracer::ParseRecord($line);
2288    
2289    Parse a tab-delimited data line. The data line is split into field values. Embedded tab
2290    and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.
2291    These will automatically be converted.
2292    
2293    =over 4
2294    
2295    =item line
2296    
2297    Line of data containing the tab-delimited fields.
2298    
2299    =item RETURN
2300    
2301    Returns a list of the fields found in the data line.
2302    
2303    =back
2304    
2305    =cut
2306    
2307    sub ParseRecord {
2308        # Get the parameter.
2309        my ($line) = @_;
2310        # Remove the trailing new-line, if any.
2311        chomp $line;
2312        # Split the line read into pieces using the tab character.
2313        my @retVal = split /\t/, $line;
2314        # Trim and fix the escapes in each piece.
2315        for my $value (@retVal) {
2316            # Trim leading whitespace.
2317            $value =~ s/^\s+//;
2318            # Trim trailing whitespace.
2319            $value =~ s/\s+$//;
2320            # Delete the carriage returns.
2321            $value =~ s/\r//g;
2322            # Convert the escapes into their real values.
2323            $value =~ s/\\t/"\t"/ge;
2324            $value =~ s/\\n/"\n"/ge;
2325      }      }
2326      # Return the parsed parameters.      # Return the result.
2327      return ($retOptions, @retParameters);      return @retVal;
2328  }  }
2329    
2330  =head3 Setups  =head3 Merge
2331    
2332  C<< my $count = Tracer::Setups(); >>      my @mergedList = Tracer::Merge(@inputList);
2333    
2334  Return the number of times L</TSetup> has been called.  Sort a list of strings and remove duplicates.
2335    
2336  This method allows for the creation of conditional tracing setups where, for example, we  =over 4
2337  may want to set up tracing if nobody else has done it before us.  
2338    =item inputList
2339    
2340    List of scalars to sort and merge.
2341    
2342    =item RETURN
2343    
2344    Returns a list containing the same elements sorted in ascending order with duplicates
2345    removed.
2346    
2347    =back
2348    
2349  =cut  =cut
2350    
2351  sub Setups {  sub Merge {
2352      return $SetupCount;      # Get the input list in sort order.
2353        my @inputList = sort @_;
2354        # Only proceed if the list has at least two elements.
2355        if (@inputList > 1) {
2356            # Now we want to move through the list splicing out duplicates.
2357            my $i = 0;
2358            while ($i < @inputList) {
2359                # Get the current entry.
2360                my $thisEntry = $inputList[$i];
2361                # Find out how many elements duplicate the current entry.
2362                my $j = $i + 1;
2363                my $dup1 = $i + 1;
2364                while ($j < @inputList && $inputList[$j] eq $thisEntry) { $j++; };
2365                # If the number is nonzero, splice out the duplicates found.
2366                if ($j > $dup1) {
2367                    splice @inputList, $dup1, $j - $dup1;
2368                }
2369                # Now the element at position $dup1 is different from the element before it
2370                # at position $i. We push $i forward one position and start again.
2371                $i++;
2372            }
2373        }
2374        # Return the merged list.
2375        return @inputList;
2376  }  }
2377    
2378  =head3 Open  =head3 Open
2379    
2380  C<< my $handle = Open($fileHandle, $fileSpec, $message); >>      my $handle = Open($fileHandle, $fileSpec, $message);
2381    
2382  Open a file.  Open a file.
2383    
# Line 608  Line 2469 
2469    
2470  =head3 FindNamePart  =head3 FindNamePart
2471    
2472  C<< my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec); >>      my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec);
2473    
2474  Extract the portion of a file specification that contains the file name.  Extract the portion of a file specification that contains the file name.
2475    
# Line 659  Line 2520 
2520    
2521  =head3 OpenDir  =head3 OpenDir
2522    
2523  C<< my @files = OpenDir($dirName, $filtered, $flag); >>      my @files = OpenDir($dirName, $filtered, $flag);
2524    
2525  Open a directory and return all the file names. This function essentially performs  Open a directory and return all the file names. This function essentially performs
2526  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
# Line 715  Line 2576 
2576          } else {          } else {
2577              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2578          }          }
2579            closedir $dirHandle;
2580      } elsif (! $flag) {      } elsif (! $flag) {
2581          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2582          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 723  Line 2585 
2585      return @retVal;      return @retVal;
2586  }  }
2587    
 =head3 SetLevel  
2588    
2589  C<< Tracer::SetLevel($newLevel); >>  =head3 Insure
2590    
2591        Insure($dirName, $chmod);
2592    
2593  Modify the trace level. A higher trace level will cause more messages to appear.  Insure a directory is present.
2594    
2595  =over 4  =over 4
2596    
2597  =item newLevel  =item dirName
2598    
2599  Proposed new trace level.  Name of the directory to check. If it does not exist, it will be created.
2600    
2601    =item chmod (optional)
2602    
2603    Security privileges to be given to the directory if it is created.
2604    
2605  =back  =back
2606    
2607  =cut  =cut
2608    
2609  sub SetLevel {  sub Insure {
2610      $TraceLevel = $_[0];      my ($dirName, $chmod) = @_;
2611        if (! -d $dirName) {
2612            Trace("Creating $dirName directory.") if T(2);
2613            eval {
2614                mkpath $dirName;
2615                # If we have permissions specified, set them here.
2616                if (defined($chmod)) {
2617                    chmod $chmod, $dirName;
2618                }
2619            };
2620            if ($@) {
2621                Confess("Error creating $dirName: $@");
2622            }
2623        }
2624  }  }
2625    
2626  =head3 Now  =head3 ChDir
2627    
2628        ChDir($dirName);
2629    
2630    Change to the specified directory.
2631    
2632    =over 4
2633    
2634    =item dirName
2635    
2636  C<< my $string = Tracer::Now(); >>  Name of the directory to which we want to change.
2637    
2638  Return a displayable time stamp containing the local time.  =back
2639    
2640  =cut  =cut
2641    
2642  sub Now {  sub ChDir {
2643      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      my ($dirName) = @_;
2644      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .      if (! -d $dirName) {
2645                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);          Confess("Cannot change to directory $dirName: no such directory.");
2646      return $retVal;      } else {
2647            Trace("Changing to directory $dirName.") if T(File => 4);
2648            my $okFlag = chdir $dirName;
2649            if (! $okFlag) {
2650                Confess("Error switching to directory $dirName.");
2651            }
2652  }  }
   
 # Pad a number to 2 digits.  
 sub _p2 {  
     my ($value) = @_;  
     $value = "0$value" if ($value < 10);  
     return $value;  
2653  }  }
2654    
2655  =head3 LogErrors  =head3 SetPermissions
2656    
2657  C<< Tracer::LogErrors($fileName); >>      Tracer::SetPermissions($dirName, $group, $mask, %otherMasks);
2658    
2659  Route the standard error output to a log file.  Set the permissions for a directory and all the files and folders inside it.
2660    In addition, the group ownership will be changed to the specified value.
2661    
2662    This method is more vulnerable than most to permission and compatability
2663    problems, so it does internal error recovery.
2664    
2665  =over 4  =over 4
2666    
2667  =item fileName  =item dirName
2668    
2669  Name of the file to receive the error output.  Name of the directory to process.
2670    
2671    =item group
2672    
2673    Name of the group to be assigned.
2674    
2675    =item mask
2676    
2677    Permission mask. Bits that are C<1> in this mask will be ORed into the
2678    permission bits of any file or directory that does not already have them
2679    set to 1.
2680    
2681    =item otherMasks
2682    
2683    Map of search patterns to permission masks. If a directory name matches
2684    one of the patterns, that directory and all its members and subdirectories
2685    will be assigned the new pattern. For example, the following would
2686    assign 0664 to most files, but would use 0777 for directories named C<tmp>.
2687    
2688        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2689    
2690    The list is ordered, so the following would use 0777 for C<tmp1> and
2691    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2692    
2693        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2694                                                       '^tmp' => 0666);
2695    
2696    Note that the pattern matches are all case-insensitive, and only directory
2697    names are matched, not file names.
2698    
2699  =back  =back
2700    
2701  =cut  =cut
2702    
2703  sub LogErrors {  sub SetPermissions {
2704      # Get the file name.      # Get the parameters.
2705      my ($fileName) = @_;      my ($dirName, $group, $mask, @otherMasks) = @_;
2706      # Open the file as the standard error output.      # Set up for error recovery.
2707      open STDERR, '>', $fileName;      eval {
2708            # Switch to the specified directory.
2709            ChDir($dirName);
2710            # Get the group ID.
2711            my $gid = getgrnam($group);
2712            # Get the mask for tracing.
2713            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2714            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2715            my $fixCount = 0;
2716            my $lookCount = 0;
2717            # @dirs will be a stack of directories to be processed.
2718            my @dirs = (getcwd());
2719            while (scalar(@dirs) > 0) {
2720                # Get the current directory.
2721                my $dir = pop @dirs;
2722                # Check for a match to one of the specified directory names. To do
2723                # that, we need to pull the individual part of the name off of the
2724                # whole path.
2725                my $simpleName = $dir;
2726                if ($dir =~ m!/([^/]+)$!) {
2727                    $simpleName = $1;
2728                }
2729                Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2730                # Search for a match.
2731                my $match = 0;
2732                my $i;
2733                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2734                    my $pattern = $otherMasks[$i];
2735                    if ($simpleName =~ /$pattern/i) {
2736                        $match = 1;
2737                    }
2738                }
2739                # Find out if we have a match. Note we use $i-1 because the loop added 2
2740                # before terminating due to the match.
2741                if ($match && $otherMasks[$i-1] != $mask) {
2742                    # This directory matches one of the incoming patterns, and it's
2743                    # a different mask, so we process it recursively with that mask.
2744                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2745                } else {
2746                    # Here we can process normally. Get all of the non-hidden members.
2747                    my @submems = OpenDir($dir, 1);
2748                    for my $submem (@submems) {
2749                        # Get the full name.
2750                        my $thisMem = "$dir/$submem";
2751                        Trace("Checking member $thisMem.") if T(4);
2752                        $lookCount++;
2753                        if ($lookCount % 1000 == 0) {
2754                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2755                        }
2756                        # Fix the group.
2757                        chown -1, $gid, $thisMem;
2758                        # Insure this member is not a symlink.
2759                        if (! -l $thisMem) {
2760                            # Get its info.
2761                            my $fileInfo = stat $thisMem;
2762                            # Only proceed if we got the info. Otherwise, it's a hard link
2763                            # and we want to skip it anyway.
2764                            if ($fileInfo) {
2765                                my $fileMode = $fileInfo->mode;
2766                                if (($fileMode & $mask) != $mask) {
2767                                    # Fix this member.
2768                                    $fileMode |= $mask;
2769                                    chmod $fileMode, $thisMem;
2770                                    $fixCount++;
2771                                }
2772                                # If it's a subdirectory, stack it.
2773                                if (-d $thisMem) {
2774                                    push @dirs, $thisMem;
2775                                }
2776                            }
2777                        }
2778                    }
2779                }
2780            }
2781            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2782        };
2783        # Check for an error.
2784        if ($@) {
2785            Confess("SetPermissions error: $@");
2786        }
2787  }  }
2788    
2789  =head3 ReadOptions  =head3 GetLine
   
 C<< my %options = Tracer::ReadOptions($fileName); >>  
   
 Read a set of options from a file. Each option is encoded in a line of text that has the  
 format  
2790    
2791  I<optionName>C<=>I<optionValue>C<; >I<comment>      my @data = Tracer::GetLine($handle);
2792    
2793  The option name must consist entirely of letters, digits, and the punctuation characters  Read a line of data from a tab-delimited file.
 C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank  
 character is a semi-colon will be ignored. The return hash will map each option name to  
 the corresponding option value.  
2794    
2795  =over 4  =over 4
2796    
2797  =item fileName  =item handle
2798    
2799  Name of the file containing the option data.  Open file handle from which to read.
2800    
2801  =item RETURN  =item RETURN
2802    
2803  Returns a hash mapping the option names specified in the file to their corresponding option  Returns a list of the fields in the record read. The fields are presumed to be
2804  value.  tab-delimited. If we are at the end of the file, then an empty list will be
2805    returned. If an empty line is read, a single list item consisting of a null
2806    string will be returned.
2807    
2808  =back  =back
2809    
2810  =cut  =cut
2811    
2812  sub ReadOptions {  sub GetLine {
2813      # Get the parameters.      # Get the parameters.
2814      my ($fileName) = @_;      my ($handle) = @_;
2815      # Open the file.      # Declare the return variable.
2816      (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");      my @retVal = ();
2817      # Count the number of records read.      Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2818      my ($records, $comments) = 0;      # Read from the file.
2819      # Create the return hash.      my $line = <$handle>;
2820      my %retVal = ();      # Only proceed if we found something.
2821      # Loop through the file, accumulating key-value pairs.      if (defined $line) {
2822      while (my $line = <CONFIGFILE>) {          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2823          # Denote we've read a line.          # upload control and have a nonstandard EOL combination.
2824          $records++;          $line =~ s/(\r|\n)+$//;
2825          # Determine the line type.          # Here we do some fancy tracing to help in debugging complicated EOL marks.
2826          if ($line =~ /^\s*[\n\r]/) {          if (T(File => 4)) {
2827              # A blank line is a comment.              my $escapedLine = $line;
2828              $comments++;              $escapedLine =~ s/\n/\\n/g;
2829          } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {              $escapedLine =~ s/\r/\\r/g;
2830              # Here we have an option assignment.              $escapedLine =~ s/\t/\\t/g;
2831              retVal{$1} = $2;              Trace("Line read: -->$escapedLine<--");
2832          } elsif ($line =~ /^\s*;/) {          }
2833              # Here we have a text comment.          # If the line is empty, return a single empty string; otherwise, parse
2834              $comments++;          # it into fields.
2835            if ($line eq "") {
2836                push @retVal, "";
2837          } else {          } else {
2838              # Here we have an invalid line.              push @retVal, split /\t/,$line;
             Trace("Invalid option statement in record $records.") if T(0);  
2839          }          }
2840        } else {
2841            # Trace the reason the read failed.
2842            Trace("End of file: $!") if T(File => 3);
2843      }      }
2844      # Return the hash created.      # Return the result.
2845      return %retVal;      return @retVal;
2846  }  }
2847    
2848  =head3 GetOptions  =head3 PutLine
2849    
2850  C<< Tracer::GetOptions(\%defaults, \%options); >>      Tracer::PutLine($handle, \@fields, $eol);
2851    
2852  Merge a specified set of options into a table of defaults. This method takes two hash references  Write a line of data to a tab-delimited file. The specified field values will be
2853  as input and uses the data from the second to update the first. If the second does not exist,  output in tab-separated form, with a trailing new-line.
 there will be no effect. An error will be thrown if one of the entries in the second hash does not  
 exist in the first.  
2854    
2855  Consider the following example.  =over 4
2856    
2857  C<< my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options); >>  =item handle
2858    
2859  In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and  Output file handle.
 B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of  
 B<$options> is C<< {dbType => 'Oracle'} >>, then the database type will be changed to C<Oracle> and  
 the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level  
 will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as  
2860    
2861  C<< {databaseType => 'Oracle'} >>  =item fields
2862    
2863  an error will occur because the B<databaseType> option does not exist.  List of field values.
2864    
2865  =over 4  =item eol (optional)
2866    
2867  =item defaults  End-of-line character (default is "\n").
2868    
2869  Table of default option values.  =back
2870    
2871  =item options  =cut
2872    
2873  Table of overrides, if any.  sub PutLine {
2874        # Get the parameters.
2875        my ($handle, $fields, $eol) = @_;
2876        # Write the data.
2877        print $handle join("\t", @{$fields}) . ($eol || "\n");
2878    }
2879    
 =item RETURN  
2880    
2881  Returns a reference to the default table passed in as the first parameter.  =head3 PrintLine
2882    
2883        Tracer::PrintLine($line);
2884    
2885    Print a line of text with a trailing new-line.
2886    
2887    =over 4
2888    
2889    =item line
2890    
2891    Line of text to print.
2892    
2893  =back  =back
2894    
2895  =cut  =cut
2896    
2897  sub GetOptions {  sub PrintLine {
2898      # Get the parameters.      # Get the parameters.
2899      my ($defaults, $options) = @_;      my ($line) = @_;
2900      # Check for overrides.      # Print the line.
2901      if ($options) {      print "$line\n";
         # Loop through the overrides.  
         while (my ($option, $setting) = each %{$options}) {  
             # Insure this override exists.  
             if (!exists $defaults->{$option}) {  
                 croak "Unrecognized option $option encountered.";  
             } else {  
                 # Apply the override.  
                 $defaults->{$option} = $setting;  
             }  
         }  
2902      }      }
2903      # Return the merged table.  
2904      return $defaults;  
2905    =head2 Other Useful Methods
2906    
2907    =head3 IDHASH
2908    
2909        my $hash = SHTargetSearch::IDHASH(@keys);
2910    
2911    This is a dinky little method that converts a list of values to a reference
2912    to hash of values to labels. The values and labels are the same.
2913    
2914    =cut
2915    
2916    sub IDHASH {
2917        my %retVal = map { $_ => $_ } @_;
2918        return \%retVal;
2919  }  }
2920    
2921  =head3 MergeOptions  =head3 Pluralize
2922    
2923  C<< Tracer::MergeOptions(\%table, \%defaults); >>      my $plural = Tracer::Pluralize($word);
2924    
2925  Merge default values into a hash table. This method looks at the key-value pairs in the  This is a very simple pluralization utility. It adds an C<s> at the end
2926  second (default) hash, and if a matching key is not found in the first hash, the default  of the input word unless it already ends in an C<s>, in which case it
2927  pair is copied in. The process is similar to L</GetOptions>, but there is no error-  adds C<es>.
 checking and no return value.  
2928    
2929  =over 4  =over 4
2930    
2931  =item table  =item word
2932    
2933  Hash table to be updated with the default values.  Singular word to pluralize.
2934    
2935  =item defaults  =item RETURN
2936    
2937  Default values to be merged into the first hash table if they are not already present.  Returns the probable plural form of the word.
2938    
2939  =back  =back
2940    
2941  =cut  =cut
2942    
2943  sub MergeOptions {  sub Pluralize {
2944      # Get the parameters.      # Get the parameters.
2945      my ($table, $defaults) = @_;      my ($word) = @_;
2946      # Loop through the defaults.      # Declare the return variable.
2947      while (my ($key, $value) = each %{$defaults}) {      my $retVal;
2948          if (!exists $table->{$key}) {      if ($word =~ /s$/) {
2949              $table->{$key} = $value;          $retVal = $word . 'es';
2950          }      } else {
2951            $retVal = $word . 's';
2952      }      }
2953        # Return the result.
2954        return $retVal;
2955  }  }
2956    
2957  =head3 Trace  =head3 Numeric
2958    
2959  C<< Trace($message); >>      my $okFlag = Tracer::Numeric($string);
2960    
2961  Write a trace message to the target location specified in L</TSetup>. If there has not been  Return the value of the specified string if it is numeric, or an undefined value
2962  any prior call to B<TSetup>.  if it is not numeric.
2963    
2964  =over 4  =over 4
2965    
2966  =item message  =item string
2967    
2968  Message to write.  String to check.
2969    
2970    =item RETURN
2971    
2972    Returns the numeric value of the string if successful, or C<undef> if the string
2973    is not numeric.
2974    
2975  =back  =back
2976    
2977  =cut  =cut
2978    
2979  sub Trace {  sub Numeric {
2980      # Get the parameters.      # Get the parameters.
2981      my ($message) = @_;      my ($string) = @_;
2982      # Get the timestamp.      # We'll put the value in here if we succeed.
2983      my $timeStamp = Now();      my $retVal;
2984      # Format the message. Note we strip off any line terminators at the end.      # Get a working copy of the string.
2985      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $copy = $string;
2986      # Process according to the destination.      # Trim leading and trailing spaces.
2987      if ($Destination eq "TEXT") {      $copy =~ s/^\s+//;
2988          # Write the message to the standard output.      $copy =~ s/\s+$//;
2989          print "$formatted\n";      # Check the result.
2990      } elsif ($Destination eq "ERROR") {      if ($copy =~ /^[+-]?\d+$/) {
2991          # Write the message to the error output.          $retVal = $copy;
2992          print STDERR "$formatted\n";      } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2993      } elsif ($Destination eq "QUEUE") {          $retVal = $copy;
2994          # Push the message into the queue.      } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
2995          push @Queue, "$formatted";          $retVal = $copy;
     } elsif ($Destination eq "HTML") {  
         # Convert the message to HTML and write it to the standard output.  
         my $escapedMessage = CGI::escapeHTML($message);  
         print "<p>$formatted</p>\n";  
     } elsif ($Destination eq "WARN") {  
        # Emit the message as a warning.  
        warn $message;  
     } elsif ($Destination =~ m/^>>/) {  
         # Write the trace message to an output file.  
         (open TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";  
         print TRACING "$formatted\n";  
         close TRACING;  
         # If the Tee flag is on, echo it to the standard output.  
         if ($TeeFlag) {  
             print "$formatted\n";  
         }  
2996      }      }
2997        # Return the result.
2998        return $retVal;
2999  }  }
3000    
 =head3 T  
   
 C<< my $switch = T($category, $traceLevel); >>  
3001    
3002      or  =head3 ParseParm
3003    
3004  C<< my $switch = T($traceLevel); >>      my $listValue = Tracer::ParseParm($string);
3005    
3006  Return TRUE if the trace level is at or above a specified value and the specified category  Convert a parameter into a list reference. If the parameter is undefined,
3007  is active, else FALSE. If no category is specified, the caller's package name is used.  an undefined value will be returned. Otherwise, it will be parsed as a
3008    comma-separated list of values.
3009    
3010  =over 4  =over 4
3011    
3012  =item category  =item string
   
 Category to which the message belongs. If not specified, the caller's package name is  
 used.  
   
 =item traceLevel  
3013    
3014  Relevant tracing level.  Incoming string.
3015    
3016  =item RETURN  =item RETURN
3017    
3018  TRUE if a message at the specified trace level would appear in the trace, else FALSE.  Returns a reference to a list of values, or C<undef> if the incoming value
3019    was undefined.
3020    
3021  =back  =back
3022    
3023  =cut  =cut
3024    
3025  sub T {  sub ParseParm {
     # Declare the return variable.  
     my $retVal = 0;  
     # Only proceed if tracing is turned on.  
     if ($Destination ne "NONE") {  
3026          # Get the parameters.          # Get the parameters.
3027          my ($category, $traceLevel) = @_;      my ($string) = @_;
3028          if (!defined $traceLevel) {      # Declare the return variable.
3029              # Here we have no category, so we need to get the calling package.      my $retVal;
3030              # The calling package is normally the first parameter. If it is      # Check for data.
3031              # omitted, the first parameter will be the tracelevel. So, the      if (defined $string) {
3032              # first thing we do is shift the so-called category into the          # We have some, so split it into a list.
3033              # $traceLevel variable where it belongs.          $retVal = [ split /\s*,\s*/, $string];
             $traceLevel = $category;  
             my ($package, $fileName, $line) = caller;  
             # If there is no calling package, we default to "main".  
             if (!$package) {  
                 $category = "main";  
             } else {  
                 $category = $package;  
             }  
         }  
         # Save the category name.  
         $LastCategory = $category;  
         # Convert it to lower case before we hash it.  
         $category = lc $category;  
         # Use the category and tracelevel to compute the result.  
         if (ref $traceLevel) {  
             Confess("Bad trace level.");  
         } elsif (ref $TraceLevel) {  
             Confess("Bad trace config.");  
         }  
         $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));  
3034      }      }
3035      # Return the computed result.      # Return the result.
3036      return $retVal;      return $retVal;
3037  }  }
3038    
3039  =head3 ParseCommand  =head3 Now
   
 C<< my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList); >>  
   
 Parse a command line consisting of a list of parameters. The initial parameters may be option  
 specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped  
 off and merged into a table of default options. The remainder of the command line is  
 returned as a list of positional arguments. For example, consider the following invocation.  
   
 C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>  
3040    
3041  In this case, the list @words will be treated as a command line. There are two options available,      my $string = Tracer::Now();
 B<errors> and B<logFile>. If @words has the following format  
3042    
3043  C<< -logFile=error.log apple orange rutabaga >>  Return a displayable time stamp containing the local time. Whatever format this
3044    method produces must be parseable by L</ParseDate>.
3045    
3046  then at the end of the invocation, C<$options> will be  =cut
3047    
3048  C<< { errors => 0, logFile => 'error.log' } >>  sub Now {
3049        return DisplayTime(time);
3050    }
3051    
3052  and C<@arguments> will contain  =head3 DisplayTime
3053    
3054  C<< apple orange rutabaga >>      my $string = Tracer::DisplayTime($time);
3055    
3056  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no  Convert a time value to a displayable time stamp. Whatever format this
3057  support for quote characters.  method produces must be parseable by L</ParseDate>.
3058    
3059  =over 4  =over 4
3060    
3061  =item optionTable  =item time
   
 Table of default options.  
   
 =item inputList  
3062    
3063  List of words on the command line.  Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
3064    
3065  =item RETURN  =item RETURN
3066    
3067  Returns a reference to the option table and a list of the positional arguments.  Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
   
 =back  
   
 =cut  
3068    
3069  sub ParseCommand {  =back
3070      # Get the parameters.  
3071      my ($optionTable, @inputList) = @_;  =cut
3072      # Process any options in the input list.  
3073      my %overrides = ();  sub DisplayTime {
3074      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      my ($time) = @_;
3075          # Get the current option.      my $retVal = "(n/a)";
3076          my $arg = shift @inputList;      if (defined $time) {
3077          # Pull out the option name.          my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
3078          $arg =~ /^-([^=]*)/g;          $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
3079          my $name = $1;                    _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
         # Check for an option value.  
         if ($arg =~ /\G=(.*)$/g) {  
             # Here we have a value for the option.  
             $overrides{$name} = UnEscape($1);  
         } else {  
             # Here there is no value, so we use 1.  
             $overrides{$name} = 1;  
         }  
3080      }      }
3081      # Merge the options into the defaults.      return $retVal;
     GetOptions($optionTable, \%overrides);  
     # Translate the remaining parameters.  
     my @retVal = ();  
     for my $inputParm (@inputList) {  
         push @retVal, UnEscape($inputParm);  
3082      }      }
3083      # Return the results.  
3084      return ($optionTable, @retVal);  # Pad a number to 2 digits.
3085    sub _p2 {
3086        my ($value) = @_;
3087        $value = "0$value" if ($value < 10);
3088        return $value;
3089  }  }
3090    
3091  =head3 Escape  =head3 Escape
3092    
3093  C<< my $codedString = Tracer::Escape($realString); >>      my $codedString = Tracer::Escape($realString);
3094    
3095  Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines  Escape a string for use in a command. Tabs will be replaced by C<\t>, new-lines
3096  replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The  replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
3097  result is to reverse the effect of L</UnEscape>.  result is to reverse the effect of L</UnEscape>.
3098    
# Line 1198  Line 3145 
3145    
3146  =head3 UnEscape  =head3 UnEscape
3147    
3148  C<< my $realString = Tracer::UnEscape($codedString); >>      my $realString = Tracer::UnEscape($codedString);
3149    
3150  Replace escape sequences with their actual equivalents. C<\t> will be replaced by  Replace escape sequences with their actual equivalents. C<\t> will be replaced by
3151  a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will  a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will
# Line 1256  Line 3203 
3203      return $retVal;      return $retVal;
3204  }  }
3205    
 =head3 ParseRecord  
   
 C<< my @fields = Tracer::ParseRecord($line); >>  
   
 Parse a tab-delimited data line. The data line is split into field values. Embedded tab  
 and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.  
 These will automatically be converted.  
   
 =over 4  
   
 =item line  
   
 Line of data containing the tab-delimited fields.  
   
 =item RETURN  
   
 Returns a list of the fields found in the data line.  
   
 =back  
   
 =cut  
   
 sub ParseRecord {  
     # Get the parameter.  
     my ($line) = @_;  
     # Remove the trailing new-line, if any.  
     chomp $line;  
     # Split the line read into pieces using the tab character.  
     my @retVal = split /\t/, $line;  
     # Trim and fix the escapes in each piece.  
     for my $value (@retVal) {  
         # Trim leading whitespace.  
         $value =~ s/^\s+//;  
         # Trim trailing whitespace.  
         $value =~ s/\s+$//;  
         # Delete the carriage returns.  
         $value =~ s/\r//g;  
         # Convert the escapes into their real values.  
         $value =~ s/\\t/"\t"/ge;  
         $value =~ s/\\n/"\n"/ge;  
     }  
     # Return the result.  
     return @retVal;  
 }  
   
 =head3 Merge  
   
 C<< my @mergedList = Tracer::Merge(@inputList); >>  
   
 Sort a list of strings and remove duplicates.  
   
 =over 4  
   
 =item inputList  
   
 List of scalars to sort and merge.  
   
 =item RETURN  
   
 Returns a list containing the same elements sorted in ascending order with duplicates  
 removed.  
   
 =back  
   
 =cut  
   
 sub Merge {  
     # Get the input list in sort order.  
     my @inputList = sort @_;  
     # Only proceed if the list has at least two elements.  
     if (@inputList > 1) {  
         # Now we want to move through the list splicing out duplicates.  
         my $i = 0;  
         while ($i < @inputList) {  
             # Get the current entry.  
             my $thisEntry = $inputList[$i];  
             # Find out how many elements duplicate the current entry.  
             my $j = $i + 1;  
             my $dup1 = $i + 1;  
             while ($j < @inputList && $inputList[$j] eq $thisEntry) { $j++; };  
             # If the number is nonzero, splice out the duplicates found.  
             if ($j > $dup1) {  
                 splice @inputList, $dup1, $j - $dup1;  
             }  
             # Now the element at position $dup1 is different from the element before it  
             # at position $i. We push $i forward one position and start again.  
             $i++;  
         }  
     }  
     # Return the merged list.  
     return @inputList;  
 }  
   
3206  =head3 Percent  =head3 Percent
3207    
3208  C<< my $percent = Tracer::Percent($number, $base); >>      my $percent = Tracer::Percent($number, $base);
3209    
3210  Returns the percent of the base represented by the given number. If the base  Returns the percent of the base represented by the given number. If the base
3211  is zero, returns zero.  is zero, returns zero.
# Line 1377  Line 3231 
3231  sub Percent {  sub Percent {
3232      # Get the parameters.      # Get the parameters.
3233      my ($number, $base) = @_;      my ($number, $base) = @_;
3234      # Declare the return variable.      # Declare the return variable.
3235      my $retVal = 0;      my $retVal = 0;
3236      # Compute the percent.      # Compute the percent.
3237      if ($base != 0) {      if ($base != 0) {
3238          $retVal = $number * 100 / $base;          $retVal = $number * 100 / $base;
3239      }      }
3240      # Return the result.      # Return the result.
3241      return $retVal;      return $retVal;
3242  }  }
   
 =head3 GetFile  
   
 C<< my @fileContents = Tracer::GetFile($fileName); >>  
   
     or  
   
 C<< my $fileContents = Tracer::GetFile($fileName); >>  
   
 Return the entire contents of a file. In list context, line-ends are removed and  
 each line is a list element. In scalar context, line-ends are replaced by C<\n>.  
   
 =over 4  
   
 =item fileName  
   
 Name of the file to read.  
   
 =item RETURN  
   
 In a list context, returns the entire file as a list with the line terminators removed.  
 In a scalar context, returns the entire file as a string. If an error occurs opening  
 the file, an empty list will be returned.  
   
 =back  
   
 =cut  
   
 sub GetFile {  
     # Get the parameters.  
     my ($fileName) = @_;  
     # Declare the return variable.  
     my @retVal = ();  
     # Open the file for input.  
     my $handle = Open(undef, "<$fileName");  
     # Read the whole file into the return variable, stripping off any terminator  
     # characters.  
     my $lineCount = 0;  
     while (my $line = <$handle>) {  
         $lineCount++;  
         $line = Strip($line);  
         push @retVal, $line;  
     }  
     # Close it.  
     close $handle;  
     my $actualLines = @retVal;  
     # Return the file's contents in the desired format.  
     if (wantarray) {  
         return @retVal;  
     } else {  
         return join "\n", @retVal;  
     }  
 }  
   
 =head3 PutFile  
   
 C<< Tracer::PutFile($fileName, \@lines); >>  
   
 Write out a file from a list of lines of text.  
   
 =over 4  
   
 =item fileName  
   
 Name of the output file.  
   
 =item lines  
   
 Reference to a list of text lines. The lines will be written to the file in order, with trailing  
 new-line characters.  
   
 =back  
   
 =cut  
   
 sub PutFile {  
     # Get the parameters.  
     my ($fileName, $lines) = @_;  
     # Open the output file.  
     my $handle = Open(undef, ">$fileName");  
     # Write the lines.  
     for my $line (@{$lines}) {  
         print $handle "$line\n";  
     }  
     # Close the output file.  
     close $handle;  
 }  
   
 =head3 QTrace  
   
 C<< my $data = QTrace($format); >>  
   
 Return the queued trace data in the specified format.  
   
 =over 4  
   
 =item format  
   
 C<html> to format the data as an HTML list, C<text> to format it as straight text.  
   
 =back  
   
 =cut  
   
 sub QTrace {  
     # Get the parameter.  
     my ($format) = @_;  
     # Create the return variable.  
     my $retVal = "";  
     # Only proceed if there is an actual queue.  
     if (@Queue) {  
         # Process according to the format.  
         if ($format =~ m/^HTML$/i) {  
             # Convert the queue into an HTML list.  
             $retVal = "<ul>\n";  
             for my $line (@Queue) {  
                 my $escapedLine = CGI::escapeHTML($line);  
                 $retVal .= "<li>$escapedLine</li>\n";  
             }  
             $retVal .= "</ul>\n";  
         } elsif ($format =~ m/^TEXT$/i) {  
             # Convert the queue into a list of text lines.  
             $retVal = join("\n", @Queue) . "\n";  
         }  
         # Clear the queue.  
         @Queue = ();  
     }  
     # Return the formatted list.  
     return $retVal;  
 }  
   
 =head3 Confess  
   
 C<< Confess($message); >>  
   
 Trace the call stack and abort the program with the specified message. When used with  
 the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.  
 So, for example  
   
 C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>  
   
 Will abort the program with a stack trace if the value of C<$recNum> is negative.  
   
 =over 4  
3243    
3244  =item message  =head3 In
3245    
3246  Message to include in the trace.      my $flag = Tracer::In($value, $min, $max);
3247    
3248  =back  Return TRUE if the value is between the minimum and the maximum, else FALSE.
3249    
3250  =cut  =cut
3251    
3252  sub Confess {  sub In {
3253      # Get the parameters.      return ($_[0] <= $_[2] && $_[0] >= $_[1]);
     my ($message) = @_;  
     # Trace the call stack.  
     Cluck($message);  
     # Abort the program.  
     croak(">>> $message");  
3254  }  }
3255    
 =head3 Assert  
   
 C<< Assert($condition1, $condition2, ... $conditionN); >>  
3256    
3257  Return TRUE if all the conditions are true. This method can be used in conjunction with  =head3 Constrain
 the OR operator and the L</Confess> method as a debugging assert.  
 So, for example  
3258    
3259  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>      my $constrained = Constrain($value, $min, $max);
3260    
3261  Will abort the program with a stack trace if the value of C<$recNum> is negative.  Modify a numeric value to bring it to a point in between a maximum and a minimum.
3262    
3263  =cut  =over 4
 sub Assert {  
     my $retVal = 1;  
     LOOP: for my $condition (@_) {  
         if (! $condition) {  
             $retVal = 0;  
             last LOOP;  
         }  
     }  
     return $retVal;  
 }  
3264    
3265  =head3 Cluck  =item value
3266    
3267  C<< Cluck($message); >>  Value to constrain.
3268    
3269  Trace the call stack. Note that for best results, you should qualify the call with a  =item min (optional)
 trace condition. For example,  
3270    
3271  C<< Cluck("Starting record parse.") if T(3); >>  Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3272    
3273  will only trace the stack if the trace level for the package is 3 or more.  =item max (optional)
3274    
3275  =over 4  Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3276    
3277  =item message  =item RETURN
3278    
3279  Message to include in the trace.  Returns the incoming value, constrained according to the other parameters.
3280    
3281  =back  =back
3282    
3283  =cut  =cut
3284    
3285  sub Cluck {  sub Constrain {
3286      # Get the parameters.      # Get the parameters.
3287      my ($message) = @_;      my ($value, $min, $max) = @_;
3288      # Trace what's happening.      # Declare the return variable.
3289      Trace("Stack trace for event: $message");      my $retVal = $value;
3290      my $confession = longmess($message);      # Apply the minimum constraint.
3291      # Convert the confession to a series of trace messages. Note we skip any      if (defined $min && $retVal < $min) {
3292      # messages relating to calls into Tracer.          $retVal = $min;
3293      for my $line (split /\s*\n/, $confession) {      }
3294          Trace($line) if ($line !~ /Tracer\.pm/);      # Apply the maximum constraint.
3295        if (defined $max && $retVal > $max) {
3296            $retVal = $max;
3297      }      }
3298        # Return the result.
3299        return $retVal;
3300  }  }
3301    
3302  =head3 Min  =head3 Min
3303    
3304  C<< my $min = Min($value1, $value2, ... $valueN); >>      my $min = Min($value1, $value2, ... $valueN);
3305    
3306  Return the minimum argument. The arguments are treated as numbers.  Return the minimum argument. The arguments are treated as numbers.
3307    
# Line 1641  Line 3334 
3334    
3335  =head3 Max  =head3 Max
3336    
3337  C<< my $max = Max($value1, $value2, ... $valueN); >>      my $max = Max($value1, $value2, ... $valueN);
3338    
3339  Return the maximum argument. The arguments are treated as numbers.  Return the maximum argument. The arguments are treated as numbers.
3340    
# Line 1672  Line 3365 
3365      return $retVal;      return $retVal;
3366  }  }
3367    
3368  =head3 AddToListMap  =head3 Strip
3369    
3370  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>      my $string = Tracer::Strip($line);
3371    
3372  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list  Strip all line terminators off a string. This is necessary when dealing with files
3373  is created for the key. Otherwise, the new value is pushed onto the list.  that may have been transferred back and forth several times among different
3374    operating environments.
3375    
3376  =over 4  =over 4
3377    
3378  =item hash  =item line
   
 Reference to the target hash.  
   
 =item key  
3379    
3380  Key for which the value is to be added.  Line of text to be stripped.
3381    
3382  =item value1, value2, ... valueN  =item RETURN
3383    
3384  List of values to add to the key's value list.  The same line of text with all the line-ending characters chopped from the end.
3385    
3386  =back  =back
3387    
3388  =cut  =cut
3389    
3390  sub AddToListMap {  sub Strip {
3391      # Get the parameters.      # Get a copy of the parameter string.
3392      my ($hash, $key, @values) = @_;      my ($string) = @_;
3393      # Process according to whether or not the key already has a value.      my $retVal = (defined $string ? $string : "");
3394      if (! exists $hash->{$key}) {      # Strip the line terminator characters.
3395          $hash->{$key} = [@values];      $retVal =~ s/(\r|\n)+$//g;
3396      } else {      # Return the result.
         push @{$hash->{$key}}, @values;  
     }  
 }  
   
 =head3 DebugMode  
   
 C<< if (Tracer::DebugMode) { ...code... } >>  
   
 Return TRUE if debug mode has been turned on, else output an error  
 page and return FALSE.  
   
 Certain CGI scripts are too dangerous to exist in the production  
 environment. This method provides a simple way to prevent them  
 from working unless they are explicitly turned on by creating a password  
 cookie via the B<SetPassword> script.  If debugging mode  
 is not turned on, an error web page will be output directing the  
 user to enter in the correct password.  
   
 =cut  
   
 sub DebugMode {  
     # Declare the return variable.  
     my $retVal = 0;  
     # Check the debug configuration.  
     my $password = CGI::cookie("DebugMode");  
     my $encrypted = Digest::MD5::md5_hex($password);  
     if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {  
         $retVal = 1;  
     } else {  
         # Here debug mode is off, so we generate an error page.  
         my $pageString = PageBuilder::Build("<<Html/ErrorPage.html", {}, "Html");  
         print $pageString;  
     }  
     # Return the determination indicator.  
3397      return $retVal;      return $retVal;
3398  }  }
3399    
3400  =head3 Strip  =head3 Trim
3401    
3402  C<< my $string = Tracer::Strip($line); >>      my $string = Tracer::Trim($line);
3403    
3404  Strip all line terminators off a string. This is necessary when dealing with files  Trim all spaces from the beginning and ending of a string.
 that may have been transferred back and forth several times among different  
 operating environments.  
3405    
3406  =over 4  =over 4
3407    
3408  =item line  =item line
3409    
3410  Line of text to be stripped.  Line of text to be trimmed.
3411    
3412  =item RETURN  =item RETURN
3413    
3414  The same line of text with all the line-ending characters chopped from the end.  The same line of text with all whitespace chopped off either end.
3415    
3416  =back  =back
3417    
3418  =cut  =cut
3419    
3420  sub Strip {  sub Trim {
3421      # Get a copy of the parameter string.      # Get a copy of the parameter string.
3422      my ($string) = @_;      my ($string) = @_;
3423      my $retVal = (defined $string ? $string : "");      my $retVal = (defined $string ? $string : "");
3424      # Strip the line terminator characters.      # Strip the front spaces.
3425      $retVal =~ s/(\r|\n)+$//g;      $retVal =~ s/^\s+//;
3426        # Strip the back spaces.
3427        $retVal =~ s/\s+$//;
3428      # Return the result.      # Return the result.
3429      return $retVal;      return $retVal;
3430  }  }
3431    
3432  =head3 Pad  =head3 Pad
3433    
3434  C<< my $paddedString = Tracer::Pad($string, $len, $left, $padChar); >>      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
3435    
3436  Pad a string to a specified length. The pad character will be a  Pad a string to a specified length. The pad character will be a
3437  space, and the padding will be on the right side unless specified  space, and the padding will be on the right side unless specified
# Line 1834  Line 3490 
3490      return $retVal;      return $retVal;
3491  }  }
3492    
3493    =head3 Quoted
3494    
3495        my $string = Tracer::Quoted($var);
3496    
3497    Convert the specified value to a string and enclose it in single quotes.
3498    If it's undefined, the string C<undef> in angle brackets will be used
3499    instead.
3500    
3501    =over 4
3502    
3503    =item var
3504    
3505    Value to quote.
3506    
3507    =item RETURN
3508    
3509    Returns a string enclosed in quotes, or an indication the value is undefined.
3510    
3511    =back
3512    
3513    =cut
3514    
3515    sub Quoted {
3516        # Get the parameters.
3517        my ($var) = @_;
3518        # Declare the return variable.
3519        my $retVal;
3520        # Are we undefined?
3521        if (! defined $var) {
3522            $retVal = "<undef>";
3523        } else {
3524            # No, so convert to a string and enclose in quotes.
3525            $retVal = $var;
3526            $retVal =~ s/'/\\'/;
3527            $retVal = "'$retVal'";
3528        }
3529        # Return the result.
3530        return $retVal;
3531    }
3532    
3533  =head3 EOF  =head3 EOF
3534    
3535  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 1846  Line 3542 
3542    
3543  =head3 TICK  =head3 TICK
3544    
3545  C<< my @results = TICK($commandString); >>      my @results = TICK($commandString);
3546    
3547  Perform a back-tick operation on a command. If this is a Windows environment, any leading  Perform a back-tick operation on a command. If this is a Windows environment, any leading
3548  dot-slash (C<./> will be removed. So, for example, if you were doing  dot-slash (C<./> will be removed. So, for example, if you were doing
# Line 1885  Line 3581 
3581      return `$commandString`;      return `$commandString`;
3582  }  }
3583    
 =head3 ScriptSetup  
3584    
3585  C<< my ($query, $varHash) = ScriptSetup(); >>  =head3 CommaFormat
3586    
3587        my $formatted = Tracer::CommaFormat($number);
3588    
3589  Perform standard tracing and debugging setup for scripts. The value returned is  Insert commas into a number.
3590  the CGI object followed by a pre-built variable hash.  
3591    =over 4
3592    
3593    =item number
3594    
3595    A sequence of digits.
3596    
3597    =item RETURN
3598    
3599    Returns the same digits with commas strategically inserted.
3600    
3601  The C<Trace> query parameter is used to determine whether or not tracing is active and  =back
 which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  
 the C<CGI> trace module will trace parameter and environment information. Parameters are  
 traced at level 3 and environment variables at level 4. At the end of the script, the  
 client should call L</ScriptFinish> to output the web page.  
3602    
3603  =cut  =cut
3604    
3605  sub ScriptSetup {  sub CommaFormat {
3606      # Get the CGI query object.      # Get the parameters.
3607      my $query = CGI->new();      my ($number) = @_;
3608      # Check for tracing. Set it up if the user asked for it.      # Pad the length up to a multiple of three.
3609      if ($query->param('Trace')) {      my $padded = "$number";
3610          # Set up tracing to be queued for display at the bottom of the web page.      $padded = " " . $padded while length($padded) % 3 != 0;
3611          TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");      # This is a fancy PERL trick. The parentheses in the SPLIT pattern
3612          # Trace the parameter and environment data.      # cause the delimiters to be included in the output stream. The
3613          if (T(CGI => 3)) {      # GREP removes the empty strings in between the delimiters.
3614              # Here we want to trace the parameter data.      my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
3615              my @names = $query->param;      # Clean out the spaces.
3616              for my $parmName (sort @names) {      $retVal =~ s/ //g;
3617                  # Note we skip "Trace", which is for our use only.      # Return the result.
3618                  if ($parmName ne 'Trace') {      return $retVal;
                     my @values = $query->param($parmName);  
                     Trace("CGI: $parmName = " . join(", ", @values));  
3619                  }                  }
3620    
3621    
3622    =head3 GetMemorySize
3623    
3624        my $string = Tracer::GetMemorySize();
3625    
3626    Return a memory size string for the current process. The string will be
3627    in comma format, with a size indicator (K, M, G) at the end.
3628    
3629    =cut
3630    
3631    sub GetMemorySize {
3632        # Get the memory size from Unix.
3633        my ($retVal) = `ps h -o vsz $$`;
3634        # Remove the ending new-line.
3635        chomp $retVal;
3636        # Format and return the result.
3637        return CommaFormat($retVal) . "K";
3638              }              }
3639    
3640    =head3 CompareLists
3641    
3642        my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
3643    
3644    Compare two lists of tuples, and return a hash analyzing the differences. The lists
3645    are presumed to be sorted alphabetically by the value in the $keyIndex column.
3646    The return value contains a list of items that are only in the new list
3647    (inserted) and only in the old list (deleted).
3648    
3649    =over 4
3650    
3651    =item newList
3652    
3653    Reference to a list of new tuples.
3654    
3655    =item oldList
3656    
3657    Reference to a list of old tuples.
3658    
3659    =item keyIndex (optional)
3660    
3661    Index into each tuple of its key field. The default is 0.
3662    
3663    =item RETURN
3664    
3665    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
3666    list (inserted) followed by a reference to the list of items that are only in the old
3667    list (deleted).
3668    
3669    =back
3670    
3671    =cut
3672    
3673    sub CompareLists {
3674        # Get the parameters.
3675        my ($newList, $oldList, $keyIndex) = @_;
3676        if (! defined $keyIndex) {
3677            $keyIndex = 0;
3678        }
3679        # Declare the return variables.
3680        my ($inserted, $deleted) = ([], []);
3681        # Loop through the two lists simultaneously.
3682        my ($newI, $oldI) = (0, 0);
3683        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
3684        while ($newI < $newN || $oldI < $oldN) {
3685            # Get the current object in each list. Note that if one
3686            # of the lists is past the end, we'll get undef.
3687            my $newItem = $newList->[$newI];
3688            my $oldItem = $oldList->[$oldI];
3689            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
3690                # The old item is not in the new list, so mark it deleted.
3691                push @{$deleted}, $oldItem;
3692                $oldI++;
3693            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
3694                # The new item is not in the old list, so mark it inserted.
3695                push @{$inserted}, $newItem;
3696                $newI++;
3697            } else {
3698                # The item is in both lists, so push forward.
3699                $oldI++;
3700                $newI++;
3701          }          }
         if (T(CGI => 4)) {  
             # Here we want the environment data too.  
             for my $envName (sort keys %ENV) {  
                 Trace("ENV: $envName = $ENV{$envName}");  
3702              }              }
3703        # Return the result.
3704        return ($inserted, $deleted);
3705          }          }
3706    
3707    =head3 Cmp
3708    
3709        my $cmp = Tracer::Cmp($a, $b);
3710    
3711    This method performs a universal sort comparison. Each value coming in is
3712    separated into a text parts and number parts. The text
3713    part is string compared, and if both parts are equal, then the number
3714    parts are compared numerically. A stream of just numbers or a stream of
3715    just strings will sort correctly, and a mixed stream will sort with the
3716    numbers first. Strings with a label and a number will sort in the
3717    expected manner instead of lexically. Undefined values sort last.
3718    
3719    =over 4
3720    
3721    =item a
3722    
3723    First item to compare.
3724    
3725    =item b
3726    
3727    Second item to compare.
3728    
3729    =item RETURN
3730    
3731    Returns a negative number if the first item should sort first (is less), a positive
3732    number if the first item should sort second (is greater), and a zero if the items are
3733    equal.
3734    
3735    =back
3736    
3737    =cut
3738    
3739    sub Cmp {
3740        # Get the parameters.
3741        my ($a, $b) = @_;
3742        # Declare the return value.
3743        my $retVal;
3744        # Check for nulls.
3745        if (! defined($a)) {
3746            $retVal = (! defined($b) ? 0 : -1);
3747        } elsif (! defined($b)) {
3748            $retVal = 1;
3749      } else {      } else {
3750          # Here tracing is to be turned off. All we allow is errors traced into the          # Here we have two real values. Parse the two strings.
3751          # error log.          my @aParsed = _Parse($a);
3752          TSetup("0", "WARN");          my @bParsed = _Parse($b);
3753            # Loop through the first string.
3754            while (! $retVal && @aParsed) {
3755                # Extract the string parts.
3756                my $aPiece = shift(@aParsed);
3757                my $bPiece = shift(@bParsed) || '';
3758                # Extract the number parts.
3759                my $aNum = shift(@aParsed);
3760                my $bNum = shift(@bParsed) || 0;
3761                # Compare the string parts insensitively.
3762                $retVal = (lc($aPiece) cmp lc($bPiece));
3763                # If they're equal, compare them sensitively.
3764                if (! $retVal) {
3765                    $retVal = ($aPiece cmp $bPiece);
3766                    # If they're STILL equal, compare the number parts.
3767                    if (! $retVal) {
3768                        $retVal = $aNum <=> $bNum;
3769                    }
3770                }
3771            }
3772        }
3773        # Return the result.
3774        return $retVal;
3775    }
3776    
3777    # This method parses an input string into a string parts alternating with
3778    # number parts.
3779    sub _Parse {
3780        # Get the incoming string.
3781        my ($string) = @_;
3782        # The pieces will be put in here.
3783        my @retVal;
3784        # Loop through as many alpha/num sets as we can.
3785        while ($string =~ /^(\D*)(\d+)(.*)/) {
3786            # Push the alpha and number parts into the return string.
3787            push @retVal, $1, $2;
3788            # Save the residual.
3789            $string = $3;
3790        }
3791        # If there's still stuff left, add it to the end with a trailing
3792        # zero.
3793        if ($string) {
3794            push @retVal, $string, 0;
3795        }
3796        # Return the list.
3797        return @retVal;
3798    }
3799    
3800    =head3 ListEQ
3801    
3802        my $flag = Tracer::ListEQ(\@a, \@b);
3803    
3804    Return TRUE if the specified lists contain the same strings in the same
3805    order, else FALSE.
3806    
3807    =over 4
3808    
3809    =item a
3810    
3811    Reference to the first list.
3812    
3813    =item b
3814    
3815    Reference to the second list.
3816    
3817    =item RETURN
3818    
3819    Returns TRUE if the two parameters are identical string lists, else FALSE.
3820    
3821    =back
3822    
3823    =cut
3824    
3825    sub ListEQ {
3826        # Get the parameters.
3827        my ($a, $b) = @_;
3828        # Declare the return variable. Start by checking the lengths.
3829        my $n = scalar(@$a);
3830        my $retVal = ($n == scalar(@$b));
3831        # Now compare the list elements.
3832        for (my $i = 0; $retVal && $i < $n; $i++) {
3833            $retVal = ($a->[$i] eq $b->[$i]);
3834        }
3835        # Return the result.
3836        return $retVal;
3837      }      }
3838    
3839    =head2 CGI Script Utilities
3840    
3841    =head3 ScriptSetup (deprecated)
3842    
3843        my ($cgi, $varHash) = ScriptSetup($noTrace);
3844    
3845    Perform standard tracing and debugging setup for scripts. The value returned is
3846    the CGI object followed by a pre-built variable hash. At the end of the script,
3847    the client should call L</ScriptFinish> to output the web page.
3848    
3849    This method calls L</ETracing> to configure tracing, which allows the tracing
3850    to be configured via the emergency tracing form on the debugging control panel.
3851    Tracing will then be turned on automatically for all programs that use the L</ETracing>
3852    method, which includes every program that uses this method or L</StandardSetup>.
3853    
3854    =over 4
3855    
3856    =item noTrace (optional)
3857