[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.126, Wed Dec 16 20:00:53 2009 UTC
# Line 1  Line 1 
1  #  # -*- perl -*-
2    ########################################################################
3  # Copyright (c) 2003-2006 University of Chicago and Fellowship  # Copyright (c) 2003-2006 University of Chicago and Fellowship
4  # for Interpretations of Genomes. All Rights Reserved.  # for Interpretations of Genomes. All Rights Reserved.
5  #  #
# Line 13  Line 14 
14  # at info@ci.uchicago.edu or the Fellowship for Interpretation of  # at info@ci.uchicago.edu or the Fellowship for Interpretation of
15  # Genomes at veronika@thefig.info or download a copy from  # Genomes at veronika@thefig.info or download a copy from
16  # http://www.theseed.org/LICENSE.TXT.  # http://www.theseed.org/LICENSE.TXT.
17  #  ########################################################################
18    
19  package Tracer;  package Tracer;
20    
     require Exporter;  
     @ISA = ('Exporter');  
     @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup 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);
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) || die "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    =cut
1108    
1109    sub ETracing {
1110        # Get the parameter.
1111        my ($parameter, %options) = @_;
1112        # Check for CGI mode.
1113        if (defined $parameter && ref $parameter eq 'CGI') {
1114            $SavedCGI = $parameter;
1115        } else {
1116            $SavedCGI = undef;
1117        }
1118        # Check for the noParms option.
1119        my $noParms = $options{noParms} || 0;
1120        # Get the default tracing information.
1121        my $tracing = $options{level} || 0;
1122        my $dest = $options{destType} || "WARN";
1123        # Check for emergency tracing.
1124        my $tkey = EmergencyKey($parameter);
1125        warn "Tracing key is $tkey.\n"; ##HACK
1126        my $emergencyFile = EmergencyFileName($tkey);
1127        if (-e $emergencyFile) {
1128            # We have the file. Read in the data.
1129            my @tracing = GetFile($emergencyFile);
1130            # Pull off the time limit.
1131            my $expire = shift @tracing;
1132            # Convert it to seconds.
1133            $expire *= 3600;
1134            # Check the file data.
1135            my $stat = stat($emergencyFile);
1136            my ($now) = gettimeofday;
1137            if ($now - $stat->mtime > $expire) {
1138                # Delete the expired file.
1139                unlink $emergencyFile;
1140            } else {
1141                # Emergency tracing is on. Pull off the destination and
1142                # the trace level;
1143                $dest = shift @tracing;
1144                my $level = shift @tracing;
1145                # Insure Tracer is specified.
1146                my %moduleHash = map { $_ => 1 } @tracing;
1147                $moduleHash{Tracer} = 1;
1148                # Set the trace parameter.
1149                $tracing = join(" ", $level, sort keys %moduleHash);
1150            }
1151        }
1152        # Convert the destination to a real tracing destination.
1153        warn "Tracing destination is $dest.\n"; ##HACK
1154        $dest = EmergencyTracingDest($tkey, $dest);
1155        # Setup the tracing we've determined from all the stuff above.
1156        warn "TSetup is \"$tracing\", \"$dest\".\n"; ##HACK
1157        TSetup($tracing, $dest);
1158        # Check to see if we're a web script.
1159        if (defined $SavedCGI) {
1160            # Yes we are. Trace the form and environment data if it's not suppressed.
1161            if (! $noParms) {
1162                TraceParms($SavedCGI);
1163            }
1164            # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1165            # emitted by the script in its raw form.
1166            if (T(Raw => 3)) {
1167                print CGI::header(-type => 'text/plain', -tracing => 'Raw');
1168            }
1169        }
1170    }
1171    
1172    =head3 EmergencyFileName
1173    
1174        my $fileName = Tracer::EmergencyFileName($tkey);
1175    
1176    Return the emergency tracing file name. This is the file that specifies
1177    the tracing information.
1178    
1179    =over 4
1180    
1181    =item tkey
1182    
1183    Tracing key for the current program.
1184    
1185    =item RETURN
1186    
1187    Returns the name of the file to contain the emergency tracing information.
1188    
1189    =back
1190    
1191    =cut
1192    
1193    sub EmergencyFileName {
1194        # Get the parameters.
1195        my ($tkey) = @_;
1196        # Compute the emergency tracing file name.
1197        return "$FIG_Config::temp/Emergency$tkey.txt";
1198    }
1199    
1200    =head3 EmergencyFileTarget
1201    
1202        my $fileName = Tracer::EmergencyFileTarget($tkey);
1203    
1204    Return the emergency tracing target file name. This is the file that receives
1205    the tracing output for file-based tracing.
1206    
1207    =over 4
1208    
1209    =item tkey
1210    
1211    Tracing key for the current program.
1212    
1213    =item RETURN
1214    
1215    Returns the name of the file to contain the trace output.
1216    
1217    =back
1218    
1219    =cut
1220    
1221    sub EmergencyFileTarget {
1222        # Get the parameters.
1223        my ($tkey) = @_;
1224        # Compute the emergency tracing file name.
1225        return "$FIG_Config::temp/trace$tkey.log";
1226    }
1227    
1228    =head3 EmergencyTracingDest
1229    
1230        my $dest = Tracer::EmergencyTracingDest($tkey, $myDest);
1231    
1232    This method converts an emergency tracing destination to a real
1233    tracing destination. The main difference is that if the
1234    destination is C<FILE> or C<APPEND>, we convert it to file
1235    output. If the destination is C<DUAL>, we convert it to file
1236    and standard output.
1237    
1238    =over 4
1239    
1240    =item tkey
1241    
1242    Tracing key for this environment.
1243    
1244    =item myDest
1245    
1246    Destination from the emergency tracing file.
1247    
1248    =item RETURN
1249    
1250    Returns a destination that can be passed into L</TSetup>.
1251    
1252    =back
1253    
1254    =cut
1255    
1256    sub EmergencyTracingDest {
1257        # Get the parameters.
1258        my ($tkey, $myDest) = @_;
1259        # Declare the return variable.
1260        my $retVal = $myDest;
1261        # Process according to the destination value.
1262        if ($myDest eq 'FILE') {
1263            $retVal = ">" . EmergencyFileTarget($tkey);
1264        } elsif ($myDest eq 'APPEND') {
1265            $retVal = ">>" . EmergencyFileTarget($tkey);
1266        } elsif ($myDest eq 'DUAL') {
1267            $retVal = "+>" . EmergencyFileTarget($tkey);
1268        } elsif ($myDest eq 'WARN') {
1269            $retVal = "WARN";
1270        }
1271        # Return the result.
1272        return $retVal;
1273    }
1274    
1275    =head3 Emergency
1276    
1277        Emergency($key, $hours, $dest, $level, @modules);
1278    
1279    Turn on emergency tracing. This method is normally invoked over the web from
1280    a debugging console, but it can also be called by the C<trace.pl> script.
1281    The caller specifies the duration of the emergency in hours, the desired tracing
1282    destination, the trace level, and a list of the trace modules to activate.
1283    For the length of the duration, when a program in an environment with the
1284    specified tracing key active invokes a Sprout CGI script, tracing will be
1285    turned on automatically. See L</TSetup> for more about tracing setup and
1286    L</ETracing> for more about emergency tracing.
1287    
1288    =over 4
1289    
1290    =item tkey
1291    
1292    The tracing key. This is used to identify the control file and the trace file.
1293    
1294    =item hours
1295    
1296    Number of hours to keep emergency tracing alive.
1297    
1298    =item dest
1299    
1300    Tracing destination. If no path information is specified for a file
1301    destination, it is put in the FIG temporary directory.
1302    
1303    =item level
1304    
1305    Tracing level. A higher level means more trace messages.
1306    
1307    =item modules
1308    
1309    A list of the tracing modules to activate.
1310    
1311    =back
1312    
1313    =cut
1314    
1315    sub Emergency {
1316        # Get the parameters.
1317        my ($tkey, $hours, $dest, $level, @modules) = @_;
1318        # Create the emergency file.
1319        my $specFile = EmergencyFileName($tkey);
1320        my $outHandle = Open(undef, ">$specFile");
1321        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
1322    }
1323    
1324    =head3 EmergencyKey
1325    
1326        my $tkey = EmergencyKey($parameter);
1327    
1328    Return the Key to be used for emergency tracing. This could be an IP address,
1329     a session ID, or a user name, depending on the environment.
1330    
1331    =over 4
1332    
1333    =item parameter
1334    
1335    Parameter defining the method for finding the tracing key. If it is a scalar,
1336    then it is presumed to be the tracing key itself. If it is a CGI object, then
1337    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
1338    taken from the C<TRACING> environment variable.
1339    
1340    =item RETURN
1341    
1342    Returns the key to be used for labels in emergency tracing.
1343    
1344    =back
1345    
1346    =cut
1347    
1348    sub EmergencyKey {
1349        # Get the parameters.
1350        my ($parameter) = @_;
1351        # Declare the return variable.
1352        my $retVal;
1353        # Determine the parameter type.
1354        if (! defined $parameter || defined($ENV{TRACING})) {
1355            # Here we're supposed to check the environment. If that fails, we
1356            # get the effective login ID.
1357            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1358        } else {
1359            my $ptype = ref $parameter;
1360            if ($ptype eq 'CGI') {
1361                # Here we were invoked from a web page. Look for a cookie.
1362                $retVal = $parameter->cookie('IP');
1363            } elsif (! $ptype) {
1364                # Here the key was passed in.
1365                $retVal = $parameter;
1366            }
1367        }
1368        # If no luck finding a key, use the PID.
1369        if (! defined $retVal) {
1370            $retVal = $$;
1371        }
1372        # Return the result.
1373        return $retVal;
1374    }
1375    
1376    
1377    =head3 TraceParms
1378    
1379        Tracer::TraceParms($cgi);
1380    
1381    Trace the CGI parameters at trace level CGI => 3 and the environment variables
1382    at level CGI => 4. A self-referencing URL is traced at level CGI => 2.
1383    
1384    =over 4
1385    
1386    =item cgi
1387    
1388    CGI query object containing the parameters to trace.
1389    
1390    =back
1391    
1392    =cut
1393    
1394    sub TraceParms {
1395        # Get the parameters.
1396        my ($cgi) = @_;
1397        if (T(CGI => 2)) {
1398            # Here we trace the GET-style URL for the script, but only if it's
1399            # relatively small.
1400            my $url = $cgi->url(-relative => 1, -query => 1);
1401            my $len = length($url);
1402            if ($len < 500) {
1403                Trace("[URL] $url");
1404            } elsif ($len > 2048) {
1405                Trace("[URL] URL is too long to use with GET ($len characters).");
1406            } else {
1407                Trace("[URL] URL length is $len characters.");
1408            }
1409        }
1410        if (T(CGI => 3)) {
1411            # Here we want to trace the parameter data.
1412            my @names = $cgi->param;
1413            for my $parmName (sort @names) {
1414                # Note we skip the Trace parameters, which are for our use only.
1415                if ($parmName ne 'Trace' && $parmName ne 'TF') {
1416                    my @values = $cgi->param($parmName);
1417                    Trace("[CGI] $parmName = " . join(", ", @values));
1418                }
1419            }
1420            # Display the request method.
1421            my $method = $cgi->request_method();
1422            Trace("Method: $method");
1423        }
1424        if (T(CGI => 4)) {
1425            # Here we want the environment data too.
1426            for my $envName (sort keys %ENV) {
1427                Trace("[ENV] $envName = $ENV{$envName}");
1428            }
1429        }
1430    }
1431    
1432    =head3 TraceImages
1433    
1434        Tracer::TraceImages($htmlString);
1435    
1436    Trace information about all of an html document's images. The tracing
1437    will be for type "IMG" at level 3. The image's source string
1438    will be displayed. This is generally either the URL of the image or
1439    raw data for the image itself. If the source is too long, only the first 300
1440    characters will be shown at trace level 3. The entire source will be shown,
1441    however, at trace level 4. This method is not very smart, and might catch
1442    Javascript code, but it is still useful when debugging the arcane
1443    behavior of images in multiple browser environments.
1444    
1445    =over 4
1446    
1447    =item htmlString
1448    
1449    HTML text for an outgoing web page.
1450    
1451    =back
1452    
1453    =cut
1454    
1455    sub TraceImages {
1456        # Only proceed if we're at the proper trace level.
1457        if (T(IMG => 3)) {
1458            # For performance reasons we're manipulating $_[0] instead of retrieving the string
1459            # into a variable called "$htmlString". This is because we expect html strings to be
1460            # long, and don't want to copy them any more than we have to.
1461            Trace(length($_[0]) . " characters in web page.");
1462            # Loop through the HTML, culling image tags.
1463            while ($_[0] =~ /<img\s+[^>]+?src="([^"]+)"/sgi) {
1464                # Extract the source string and determine whether or not it's too long.
1465                my $srcString = $1;
1466                my $pos = pos($_[0]) - length($srcString);
1467                my $excess = length($srcString) - 300;
1468                # We'll put the display string in here.
1469                my $srcDisplay = $srcString;
1470                # If it's a data string, split it at the comma.
1471                $srcDisplay =~ s/^(data[^,]+,)/$1\n/;
1472                # If there's no excess or we're at trace level 4, we're done. At level 3 with
1473                # a long string, however, we only show the first 300 characters.
1474                if ($excess > 0 && ! T(IMG => 4)) {
1475                    $srcDisplay = substr($srcDisplay,0,300) . "\nplus $excess characters.";
1476                }
1477                # Output the trace message.
1478                Trace("Image tag at position $pos:\n$srcDisplay");
1479            }
1480        }
1481    }
1482    
1483    =head2 Command-Line Utility Methods
1484    
1485    =head3 SendSMS
1486    
1487        my $msgID = Tracer::SendSMS($phoneNumber, $msg);
1488    
1489    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1490    user name, password, and API ID for the relevant account in the hash reference variable
1491    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1492    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1493    is C<2561022>, then the FIG_Config file must contain
1494    
1495        $phone =  { user => 'BruceTheHumanPet',
1496                    password => 'silly',
1497                    api_id => '2561022' };
1498    
1499    The original purpose of this method was to insure Bruce would be notified immediately when the
1500    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1501    when you call this method.
1502    
1503    The message ID will be returned if successful, and C<undef> if an error occurs.
1504    
1505    =over 4
1506    
1507    =item phoneNumber
1508    
1509    Phone number to receive the message, in international format. A United States phone number
1510    would be prefixed by "1". A British phone number would be prefixed by "44".
1511    
1512    =item msg
1513    
1514    Message to send to the specified phone.
1515    
1516    =item RETURN
1517    
1518    Returns the message ID if successful, and C<undef> if the message could not be sent.
1519    
1520    =back
1521    
1522    =cut
1523    
1524    sub SendSMS {
1525        # Get the parameters.
1526        my ($phoneNumber, $msg) = @_;
1527        # Declare the return variable. If we do not change it, C<undef> will be returned.
1528        my $retVal;
1529        # Only proceed if we have phone support.
1530        if (! defined $FIG_Config::phone) {
1531            Trace("Phone support not present in FIG_Config.") if T(1);
1532        } else {
1533            # Get the phone data.
1534            my $parms = $FIG_Config::phone;
1535            # Get the Clickatell URL.
1536            my $url = "http://api.clickatell.com/http/";
1537            # Create the user agent.
1538            my $ua = LWP::UserAgent->new;
1539            # Request a Clickatell session.
1540            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
1541                                         password => $parms->{password},
1542                                         api_id => $parms->{api_id},
1543                                         to => $phoneNumber,
1544                                         text => $msg});
1545            # Check for an error.
1546            if (! $resp->is_success) {
1547                Trace("Alert failed.") if T(1);
1548            } else {
1549                # Get the message ID.
1550                my $rstring = $resp->content;
1551                if ($rstring =~ /^ID:\s+(.*)$/) {
1552                    $retVal = $1;
1553                } else {
1554                    Trace("Phone attempt failed with $rstring") if T(1);
1555                }
1556            }
1557        }
1558        # Return the result.
1559        return $retVal;
1560    }
1561    
1562    =head3 StandardSetup
1563    
1564        my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV);
1565    
1566    This method performs standard command-line parsing and tracing setup. The return
1567    values are a hash of the command-line options and a list of the positional
1568    parameters. Tracing is automatically set up and the command-line options are
1569    validated.
1570    
1571    This is a complex method that does a lot of grunt work. The parameters can
1572    be more easily understood, however, once they are examined individually.
1573    
1574    The I<categories> parameter is the most obtuse. It is a reference to a list of
1575    special-purpose tracing categories. Most tracing categories are PERL package
1576    names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
1577    B<ERDB>, and B<SproutLoad> packages, you would specify the categories
1578    
1579        ["Sprout", "SproutLoad", "ERDB"]
1580    
1581    This would cause trace messages in the specified three packages to appear in
1582    the output. There are two special tracing categories that are automatically
1583    handled by this method. In other words, if you used L</TSetup> you would need
1584    to include these categories manually, but if you use this method they are turned
1585    on automatically.
1586    
1587    =over 4
1588    
1589    =item SQL
1590    
1591    Traces SQL commands and activity.
1592    
1593    =item Tracer
1594    
1595    Traces error messages and call stacks.
1596    
1597    =back
1598    
1599    C<SQL> is only turned on if the C<-sql> option is specified in the command line.
1600    The trace level is specified using the C<-trace> command-line option. For example,
1601    the following command line for C<TransactFeatures> turns on SQL tracing and runs
1602    all tracing at level 3.
1603    
1604        TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
1605    
1606    Standard tracing is output to the standard output and echoed to the file
1607    C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
1608    process ID. You can also specify the C<user> parameter to put a user ID
1609    instead of a process ID in the trace file name. So, for example
1610    
1611    The default trace level is 2. To get all messages, specify a trace level of 4.
1612    For a genome-by-genome update, use 3.
1613    
1614        TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
1615    
1616    would send the trace output to C<traceBruce.log> in the temporary directory.
1617    
1618    The I<options> parameter is a reference to a hash containing the command-line
1619    options, their default values, and an explanation of what they mean. Command-line
1620    options may be in the form of switches or keywords. In the case of a switch, the
1621    option value is 1 if it is specified and 0 if it is not specified. In the case
1622    of a keyword, the value is separated from the option name by an equal sign. You
1623    can see this last in the command-line example above.
1624    
1625    You can specify a different default trace level by setting C<$options->{trace}>
1626    prior to calling this method.
1627    
1628    An example at this point would help. Consider, for example, the command-line utility
1629    C<TransactFeatures>. It accepts a list of positional parameters plus the options
1630    C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
1631    the following code.
1632    
1633        my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
1634                            { safe => [0, "use database transactions"],
1635                              noAlias => [0, "do not expect aliases in CHANGE transactions"],
1636                              start => [' ', "start with this genome"],
1637                              tblFiles => [0, "output TBL files containing the corrected IDs"] },
1638                            "<command> <transactionDirectory> <IDfile>",
1639                          @ARGV);
1640    
1641    
1642    The call to C<ParseCommand> specifies the default values for the options and
1643    stores the actual options in a hash that is returned as C<$options>. The
1644    positional parameters are returned in C<@parameters>.
1645    
1646    The following is a sample command line for C<TransactFeatures>.
1647    
1648        TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
1649    
1650    Single and double hyphens are equivalent. So, you could also code the
1651    above command as
1652    
1653        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
1654    
1655    In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
1656    parameters, and would find themselves in I<@parameters> after executing the
1657    above code fragment. The tracing would be set to level 2, and the categories
1658    would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
1659    and C<DocUtils> was included because it came in within the first parameter
1660    to this method. The I<$options> hash would be
1661    
1662        { trace => 2, sql => 0, safe => 0,
1663          noAlias => 1, start => ' ', tblFiles => 0 }
1664    
1665    Use of C<StandardSetup> in this way provides a simple way of performing
1666    standard tracing setup and command-line parsing. Note that the caller is
1667    not even aware of the command-line switches C<-trace> and C<-sql>, which
1668    are used by this method to control the tracing. If additional tracing features
1669    need to be added in the future, they can be processed by this method without
1670    upsetting the command-line utilities.
1671    
1672    If the C<background> option is specified on the command line, then the
1673    standard and error outputs will be directed to files in the temporary
1674    directory, using the same suffix as the trace file. So, if the command
1675    line specified
1676    
1677        -user=Bruce -background
1678    
1679    then the trace output would go to C<traceBruce.log>, the standard output to
1680    C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
1681    simplify starting a command in the background.
1682    
1683    The user name is also used as the tracing key for L</Emergency Tracing>.
1684    Specifying a value of C<E> for the trace level causes emergency tracing to
1685    be used instead of custom tracing. If the user name is not specified,
1686    the tracing key is taken from the C<Tracing> environment variable. If there
1687    is no value for that variable, the tracing key will be computed from the active
1688    login ID.
1689    
1690    Since the default situation in StandardSetup is to trace to the standard
1691    output, errors that occur in command-line scripts will not generate
1692    RSS events. To force the events, use the C<warn> option.
1693    
1694        TransactFeatures -background -warn register ../xacts IDs.tbl
1695    
1696    Finally, if the special option C<-help> is specified, the option
1697    names will be traced at level 0 and the program will exit without processing.
1698    This provides a limited help capability. For example, if the user enters
1699    
1700        TransactFeatures -help
1701    
1702    he would see the following output.
1703    
1704        TransactFeatures [options] <command> <transactionDirectory> <IDfile>
1705            -trace    tracing level (default E)
1706            -sql      trace SQL commands
1707            -safe     use database transactions
1708            -noAlias  do not expect aliases in CHANGE transactions
1709            -start    start with this genome
1710            -tblFiles output TBL files containing the corrected IDs
1711            -forked   do not erase the trace file before tracing
1712    
1713    The caller has the option of modifying the tracing scheme by placing a value
1714    for C<trace> in the incoming options hash. The default value can be overridden,
1715    or the tracing to the standard output can be turned off by suffixing a minus
1716    sign to the trace level. So, for example,
1717    
1718        { trace => [0, "tracing level (default 0)"],
1719           ...
1720    
1721    would set the default trace level to 0 instead of E, while
1722    
1723        { trace => ["2-", "tracing level (default 2)"],
1724           ...
1725    
1726    would set the default to 2, but trace only to the log file, not to the
1727    standard output.
1728    
1729    The parameters to this method are as follows.
1730    
1731    =over 4
1732    
1733    =item categories
1734    
1735    Reference to a list of tracing category names. These should be names of
1736    packages whose internal workings will need to be debugged to get the
1737    command working.
1738    
1739    =item options
1740    
1741    Reference to a hash containing the legal options for the current command mapped
1742    to their default values and descriptions. The user can override the defaults
1743    by specifying the options as command-line switches prefixed by a hyphen.
1744    Tracing-related options may be added to this hash. If the C<-h> option is
1745    specified on the command line, the option descriptions will be used to
1746    explain the options. To turn off tracing to the standard output, add a
1747    minus sign to the value for C<trace> (see above).
1748    
1749    =item parmHelp
1750    
1751    A string that vaguely describes the positional parameters. This is used
1752    if the user specifies the C<-h> option.
1753    
1754    =item argv
1755    
1756    List of command line parameters, including the option switches, which must
1757    precede the positional parameters and be prefixed by a hyphen.
1758    
1759    =item RETURN
1760    
1761    Returns a list. The first element of the list is the reference to a hash that
1762    maps the command-line option switches to their values. These will either be the
1763    default values or overrides specified on the command line. The remaining
1764    elements of the list are the position parameters, in order.
1765    
1766    =back
1767    
1768    =cut
1769    
1770    sub StandardSetup {
1771        # Get the parameters.
1772        my ($categories, $options, $parmHelp, @argv) = @_;
1773        # Get the default tracing key.
1774        my $tkey = EmergencyKey();
1775        # Save the command line.
1776        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1777        # Add the tracing options.
1778        if (! exists $options->{trace}) {
1779            $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1780        }
1781        if (! exists $options->{forked}) {
1782            $options->{forked} = [0, "keep old trace file"];
1783        }
1784        $options->{sql} = [0, "turn on SQL tracing"];
1785        $options->{help} = [0, "display command-line options"];
1786        $options->{user} = [$tkey, "tracing key"];
1787        $options->{background} = [0, "spool standard and error output"];
1788        $options->{warn} = [0, "send errors to RSS feed"];
1789        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1790        # Create a parsing hash from the options hash. The parsing hash
1791        # contains the default values rather than the default value
1792        # and the description. While we're at it, we'll memorize the
1793        # length of the longest option name.
1794        my $longestName = 0;
1795        my %parseOptions = ();
1796        for my $key (keys %{$options}) {
1797          if (length $key > $longestName) {          if (length $key > $longestName) {
1798              $longestName = length $key;              $longestName = length $key;
1799          }          }
1800          $parseOptions{$key} = $options->{$key}->[0];          $parseOptions{$key} = $options->{$key}->[0];
1801        }
1802        # Parse the command line.
1803        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1804        # Get the logfile suffix.
1805        my $suffix = $retOptions->{user};
1806        # We'll put the trace file name in here. We need it later if background
1807        # mode is on.
1808        my $traceFileName;
1809        # Now we want to set up tracing. First, we need to know if the user
1810        # wants emergency tracing.
1811        if ($retOptions->{trace} eq 'E') {
1812            ETracing($retOptions->{user});
1813        } else {
1814            # Here the tracing is controlled from the command line.
1815            my @cats = @{$categories};
1816            if ($retOptions->{sql}) {
1817                push @cats, "SQL";
1818            }
1819            if ($retOptions->{warn}) {
1820                push @cats, "Feed";
1821            }
1822            # Add the default categories.
1823            push @cats, "Tracer";
1824            # Check for more tracing groups.
1825            if ($retOptions->{moreTracing}) {
1826                push @cats, split /,/, $retOptions->{moreTracing};
1827            }
1828            # Next, we create the category string by joining the categories.
1829            my $cats = join(" ", @cats);
1830            # Check to determine whether or not the caller wants to turn off tracing
1831            # to the standard output.
1832            my $traceLevel = $retOptions->{trace};
1833            my $textOKFlag = 1;
1834            if ($traceLevel =~ /^(.)-/) {
1835                $traceLevel = $1;
1836                $textOKFlag = 0;
1837            }
1838            # Now we set up the trace mode.
1839            my $traceMode;
1840            # Verify that we can open a file in the FIG temporary directory.
1841            my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1842            my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1843            if (open TESTTRACE, "$traceFileSpec") {
1844                # Here we can trace to a file.
1845                $traceMode = ">>$traceFileName";
1846                if ($textOKFlag) {
1847                    # Echo to standard output if the text-OK flag is set.
1848                    $traceMode = "+$traceMode";
1849                }
1850                # Close the test file.
1851                close TESTTRACE;
1852            } else {
1853                # Here we can't trace to a file. Complain about this.
1854                warn "Could not open trace file $traceFileName: $!\n";
1855                # We trace to the standard output if it's
1856                # okay, and the error log otherwise.
1857                if ($textOKFlag) {
1858                    $traceMode = "TEXT";
1859                } else {
1860                    $traceMode = "WARN";
1861                }
1862            }
1863            # Now set up the tracing.
1864            TSetup("$traceLevel $cats", $traceMode);
1865        }
1866        # Check for background mode.
1867        if ($retOptions->{background}) {
1868            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1869            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1870            # Spool the output.
1871            open STDOUT, ">$outFileName";
1872            # If we have a trace file, trace the errors to the log. Otherwise,
1873            # spool the errors.
1874            if (defined $traceFileName) {
1875                open STDERR, "| Tracer $traceFileName";
1876            } else {
1877                open STDERR, ">$errFileName";
1878            }
1879            # Check for phone support. If we have phone support and a phone number,
1880            # we want to turn it on.
1881            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1882                $retOptions->{phone} = $ENV{PHONE};
1883            }
1884        }
1885        # Check for the "help" option. If it is specified, dump the command-line
1886        # options and exit the program.
1887        if ($retOptions->{help}) {
1888            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
1889            print "$1 [options] $parmHelp\n";
1890            for my $key (sort keys %{$options}) {
1891                my $name = Pad($key, $longestName, 0, ' ');
1892                my $desc = $options->{$key}->[1];
1893                if ($options->{$key}->[0]) {
1894                    $desc .= " (default " . $options->{$key}->[0] . ")";
1895                }
1896                print "  $name $desc\n";
1897            }
1898            exit(0);
1899        }
1900        # Trace the options, if applicable.
1901        if (T(3)) {
1902            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
1903            Trace("Selected options: " . join(", ", sort @parms) . ".");
1904        }
1905        # Return the parsed parameters.
1906        return ($retOptions, @retParameters);
1907    }
1908    
1909    =head3 ReadOptions
1910    
1911        my %options = Tracer::ReadOptions($fileName);
1912    
1913    Read a set of options from a file. Each option is encoded in a line of text that has the
1914    format
1915    
1916    I<optionName>C<=>I<optionValue>C<; >I<comment>
1917    
1918    The option name must consist entirely of letters, digits, and the punctuation characters
1919    C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank
1920    character is a semi-colon will be ignored. The return hash will map each option name to
1921    the corresponding option value.
1922    
1923    =over 4
1924    
1925    =item fileName
1926    
1927    Name of the file containing the option data.
1928    
1929    =item RETURN
1930    
1931    Returns a hash mapping the option names specified in the file to their corresponding option
1932    value.
1933    
1934    =back
1935    
1936    =cut
1937    
1938    sub ReadOptions {
1939        # Get the parameters.
1940        my ($fileName) = @_;
1941        # Open the file.
1942        (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");
1943        # Count the number of records read.
1944        my ($records, $comments) = 0;
1945        # Create the return hash.
1946        my %retVal = ();
1947        # Loop through the file, accumulating key-value pairs.
1948        while (my $line = <CONFIGFILE>) {
1949            # Denote we've read a line.
1950            $records++;
1951            # Determine the line type.
1952            if ($line =~ /^\s*[\n\r]/) {
1953                # A blank line is a comment.
1954                $comments++;
1955            } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {
1956                # Here we have an option assignment.
1957                retVal{$1} = $2;
1958            } elsif ($line =~ /^\s*;/) {
1959                # Here we have a text comment.
1960                $comments++;
1961            } else {
1962                # Here we have an invalid line.
1963                Trace("Invalid option statement in record $records.") if T(0);
1964            }
1965        }
1966        # Return the hash created.
1967        return %retVal;
1968    }
1969    
1970    =head3 GetOptions
1971    
1972        Tracer::GetOptions(\%defaults, \%options);
1973    
1974    Merge a specified set of options into a table of defaults. This method takes two hash references
1975    as input and uses the data from the second to update the first. If the second does not exist,
1976    there will be no effect. An error will be thrown if one of the entries in the second hash does not
1977    exist in the first.
1978    
1979    Consider the following example.
1980    
1981        my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options);
1982    
1983    In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and
1984    B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of
1985    B<$options> is C<< {dbType => 'Oracle'} >>, then the database type will be changed to C<Oracle> and
1986    the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level
1987    will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as
1988    
1989        {databaseType => 'Oracle'}
1990    
1991    an error will occur because the B<databaseType> option does not exist.
1992    
1993    =over 4
1994    
1995    =item defaults
1996    
1997    Table of default option values.
1998    
1999    =item options
2000    
2001    Table of overrides, if any.
2002    
2003    =item RETURN
2004    
2005    Returns a reference to the default table passed in as the first parameter.
2006    
2007    =back
2008    
2009    =cut
2010    
2011    sub GetOptions {
2012        # Get the parameters.
2013        my ($defaults, $options) = @_;
2014        # Check for overrides.
2015        if ($options) {
2016            # Loop through the overrides.
2017            while (my ($option, $setting) = each %{$options}) {
2018                # Insure this override exists.
2019                if (!exists $defaults->{$option}) {
2020                    croak "Unrecognized option $option encountered.";
2021                } else {
2022                    # Apply the override.
2023                    $defaults->{$option} = $setting;
2024                }
2025      }      }
     # 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";  
2026      }      }
2027      # Now we want to set up tracing. First, we need to know if SQL is to      # Return the merged table.
2028      # be traced.      return $defaults;
     my @cats = @{$categories};  
     if ($retOptions->{sql}) {  
         push @cats, "SQL";  
2029      }      }
2030      # Add the default categories.  
2031      push @cats, "Tracer", "FIG";  =head3 MergeOptions
2032      # Next, we create the category string by joining the categories.  
2033      my $cats = join(" ", @cats);      Tracer::MergeOptions(\%table, \%defaults);
2034      # Check to determine whether or not the caller wants to turn off tracing  
2035      # to the standard output.  Merge default values into a hash table. This method looks at the key-value pairs in the
2036      my $traceLevel = $retOptions->{trace};  second (default) hash, and if a matching key is not found in the first hash, the default
2037      my $textOKFlag = 1;  pair is copied in. The process is similar to L</GetOptions>, but there is no error-
2038      if ($traceLevel =~ /^(.)-/) {  checking and no return value.
2039          $traceLevel = $1;  
2040          $textOKFlag = 0;  =over 4
2041    
2042    =item table
2043    
2044    Hash table to be updated with the default values.
2045    
2046    =item defaults
2047    
2048    Default values to be merged into the first hash table if they are not already present.
2049    
2050    =back
2051    
2052    =cut
2053    
2054    sub MergeOptions {
2055        # Get the parameters.
2056        my ($table, $defaults) = @_;
2057        # Loop through the defaults.
2058        while (my ($key, $value) = each %{$defaults}) {
2059            if (!exists $table->{$key}) {
2060                $table->{$key} = $value;
2061      }      }
     # 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";  
2062          }          }
2063          # Close the test file.  }
2064          close TESTTRACE;  
2065    =head3 UnparseOptions
2066    
2067        my $optionString = Tracer::UnparseOptions(\%options);
2068    
2069    Convert an option hash into a command-line string. This will not
2070    necessarily be the same text that came in, but it will nonetheless
2071    produce the same ultimate result when parsed by L</StandardSetup>.
2072    
2073    =over 4
2074    
2075    =item options
2076    
2077    Reference to a hash of options to convert into an option string.
2078    
2079    =item RETURN
2080    
2081    Returns a string that will parse to the same set of options when
2082    parsed by L</StandardSetup>.
2083    
2084    =back
2085    
2086    =cut
2087    
2088    sub UnparseOptions {
2089        # Get the parameters.
2090        my ($options) = @_;
2091        # The option segments will be put in here.
2092        my @retVal = ();
2093        # Loop through the options.
2094        for my $key (keys %$options) {
2095            # Get the option value.
2096            my $value = $options->{$key};
2097            # Only use it if it's nonempty.
2098            if (defined $value && $value ne "") {
2099                my $segment = "--$key=$value";
2100                # Quote it if necessary.
2101                if ($segment =~ /[ |<>*]/) {
2102                    $segment = '"' . $segment . '"';
2103                }
2104                # Add it to the return list.
2105                push @retVal, $segment;
2106            }
2107        }
2108        # Return the result.
2109        return join(" ", @retVal);
2110    }
2111    
2112    =head3 ParseCommand
2113    
2114        my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
2115    
2116    Parse a command line consisting of a list of parameters. The initial parameters may be option
2117    specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped
2118    off and merged into a table of default options. The remainder of the command line is
2119    returned as a list of positional arguments. For example, consider the following invocation.
2120    
2121        my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words);
2122    
2123    In this case, the list @words will be treated as a command line and there are two options available,
2124    B<errors> and B<logFile>. If @words has the following format
2125    
2126        -logFile=error.log apple orange rutabaga
2127    
2128    then at the end of the invocation, C<$options> will be
2129    
2130        { errors => 0, logFile => 'error.log' }
2131    
2132    and C<@arguments> will contain
2133    
2134        apple orange rutabaga
2135    
2136    The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
2137    support for quote characters. Options can be specified with single or double hyphens.
2138    
2139    =over 4
2140    
2141    =item optionTable
2142    
2143    Table of default options.
2144    
2145    =item inputList
2146    
2147    List of words on the command line.
2148    
2149    =item RETURN
2150    
2151    Returns a reference to the option table and a list of the positional arguments.
2152    
2153    =back
2154    
2155    =cut
2156    
2157    sub ParseCommand {
2158        # Get the parameters.
2159        my ($optionTable, @inputList) = @_;
2160        # Process any options in the input list.
2161        my %overrides = ();
2162        while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
2163            # Get the current option.
2164            my $arg = shift @inputList;
2165            # Pull out the option name.
2166            $arg =~ /^--?([^=]*)/g;
2167            my $name = $1;
2168            # Check for an option value.
2169            if ($arg =~ /\G=(.*)$/g) {
2170                # Here we have a value for the option.
2171                $overrides{$name} = UnEscape($1);
2172      } else {      } else {
2173          # 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.
2174          # okay, and the error log otherwise.              $overrides{$name} = 1;
2175          if ($textOKFlag) {          }
2176              $traceMode = "TEXT";      }
2177        # Merge the options into the defaults.
2178        GetOptions($optionTable, \%overrides);
2179        # Translate the remaining parameters.
2180        my @retVal = ();
2181        for my $inputParm (@inputList) {
2182            push @retVal, UnEscape($inputParm);
2183        }
2184        # Return the results.
2185        return ($optionTable, @retVal);
2186    }
2187    
2188    
2189    =head2 File Utility Methods
2190    
2191    =head3 GetFile
2192    
2193        my @fileContents = Tracer::GetFile($fileName);
2194    
2195        or
2196    
2197        my $fileContents = Tracer::GetFile($fileName);
2198    
2199    Return the entire contents of a file. In list context, line-ends are removed and
2200    each line is a list element. In scalar context, line-ends are replaced by C<\n>.
2201    
2202    =over 4
2203    
2204    =item fileName
2205    
2206    Name of the file to read.
2207    
2208    =item RETURN
2209    
2210    In a list context, returns the entire file as a list with the line terminators removed.
2211    In a scalar context, returns the entire file as a string. If an error occurs opening
2212    the file, an empty list will be returned.
2213    
2214    =back
2215    
2216    =cut
2217    
2218    sub GetFile {
2219        # Get the parameters.
2220        my ($fileName) = @_;
2221        # Declare the return variable.
2222        my @retVal = ();
2223        # Open the file for input.
2224        my $handle = Open(undef, "<$fileName");
2225        # Read the whole file into the return variable, stripping off any terminator
2226        # characters.
2227        my $lineCount = 0;
2228        while (my $line = <$handle>) {
2229            $lineCount++;
2230            $line = Strip($line);
2231            push @retVal, $line;
2232        }
2233        # Close it.
2234        close $handle;
2235        my $actualLines = @retVal;
2236        Trace("$actualLines lines read from file $fileName.") if T(File => 2);
2237        # Return the file's contents in the desired format.
2238        if (wantarray) {
2239            return @retVal;
2240          } else {          } else {
2241              $traceMode = "WARN";          return join "\n", @retVal;
2242          }          }
2243      }      }
2244      # Now set up the tracing.  
2245      TSetup("$traceLevel $cats", $traceMode);  =head3 PutFile
2246      # Check for the "h" option. If it is specified, dump the command-line  
2247      # options and exit the program.      Tracer::PutFile($fileName, \@lines);
2248      if ($retOptions->{h}) {  
2249          $0 =~ m#[/\\](\w+)(\.pl)?$#i;  Write out a file from a list of lines of text.
2250          Trace("$1 [options] $parmHelp") if T(0);  
2251          for my $key (sort keys %{$options}) {  =over 4
2252              my $name = Pad($key, $longestName, 0, ' ');  
2253              my $desc = $options->{$key}->[1];  =item fileName
2254              if ($options->{$key}->[0]) {  
2255                  $desc .= " (default " . $options->{$key}->[0] . ")";  Name of the output file.
2256    
2257    =item lines
2258    
2259    Reference to a list of text lines. The lines will be written to the file in order, with trailing
2260    new-line characters. Alternatively, may be a string, in which case the string will be written without
2261    modification.
2262    
2263    =back
2264    
2265    =cut
2266    
2267    sub PutFile {
2268        # Get the parameters.
2269        my ($fileName, $lines) = @_;
2270        # Open the output file.
2271        my $handle = Open(undef, ">$fileName");
2272        # Count the lines written.
2273        if (ref $lines ne 'ARRAY') {
2274            # Here we have a scalar, so we write it raw.
2275            print $handle $lines;
2276            Trace("Scalar put to file $fileName.") if T(File => 3);
2277        } else {
2278            # Write the lines one at a time.
2279            my $count = 0;
2280            for my $line (@{$lines}) {
2281                print $handle "$line\n";
2282                $count++;
2283              }              }
2284              Trace("  $name $desc") if T(0);          Trace("$count lines put to file $fileName.") if T(File => 3);
2285          }          }
2286          exit(0);      # Close the output file.
2287        close $handle;
2288    }
2289    
2290    =head3 ParseRecord
2291    
2292        my @fields = Tracer::ParseRecord($line);
2293    
2294    Parse a tab-delimited data line. The data line is split into field values. Embedded tab
2295    and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.
2296    These will automatically be converted.
2297    
2298    =over 4
2299    
2300    =item line
2301    
2302    Line of data containing the tab-delimited fields.
2303    
2304    =item RETURN
2305    
2306    Returns a list of the fields found in the data line.
2307    
2308    =back
2309    
2310    =cut
2311    
2312    sub ParseRecord {
2313        # Get the parameter.
2314        my ($line) = @_;
2315        # Remove the trailing new-line, if any.
2316        chomp $line;
2317        # Split the line read into pieces using the tab character.
2318        my @retVal = split /\t/, $line;
2319        # Trim and fix the escapes in each piece.
2320        for my $value (@retVal) {
2321            # Trim leading whitespace.
2322            $value =~ s/^\s+//;
2323            # Trim trailing whitespace.
2324            $value =~ s/\s+$//;
2325            # Delete the carriage returns.
2326            $value =~ s/\r//g;
2327            # Convert the escapes into their real values.
2328            $value =~ s/\\t/"\t"/ge;
2329            $value =~ s/\\n/"\n"/ge;
2330      }      }
2331      # Return the parsed parameters.      # Return the result.
2332      return ($retOptions, @retParameters);      return @retVal;
2333  }  }
2334    
2335  =head3 Setups  =head3 Merge
2336    
2337  C<< my $count = Tracer::Setups(); >>      my @mergedList = Tracer::Merge(@inputList);
2338    
2339  Return the number of times L</TSetup> has been called.  Sort a list of strings and remove duplicates.
2340    
2341  This method allows for the creation of conditional tracing setups where, for example, we  =over 4
2342  may want to set up tracing if nobody else has done it before us.  
2343    =item inputList
2344    
2345    List of scalars to sort and merge.
2346    
2347    =item RETURN
2348    
2349    Returns a list containing the same elements sorted in ascending order with duplicates
2350    removed.
2351    
2352    =back
2353    
2354  =cut  =cut
2355    
2356  sub Setups {  sub Merge {
2357      return $SetupCount;      # Get the input list in sort order.
2358        my @inputList = sort @_;
2359        # Only proceed if the list has at least two elements.
2360        if (@inputList > 1) {
2361            # Now we want to move through the list splicing out duplicates.
2362            my $i = 0;
2363            while ($i < @inputList) {
2364                # Get the current entry.
2365                my $thisEntry = $inputList[$i];
2366                # Find out how many elements duplicate the current entry.
2367                my $j = $i + 1;
2368                my $dup1 = $i + 1;
2369                while ($j < @inputList && $inputList[$j] eq $thisEntry) { $j++; };
2370                # If the number is nonzero, splice out the duplicates found.
2371                if ($j > $dup1) {
2372                    splice @inputList, $dup1, $j - $dup1;
2373                }
2374                # Now the element at position $dup1 is different from the element before it
2375                # at position $i. We push $i forward one position and start again.
2376                $i++;
2377            }
2378        }
2379        # Return the merged list.
2380        return @inputList;
2381  }  }
2382    
2383  =head3 Open  =head3 Open
2384    
2385  C<< my $handle = Open($fileHandle, $fileSpec, $message); >>      my $handle = Open($fileHandle, $fileSpec, $message);
2386    
2387  Open a file.  Open a file.
2388    
# Line 608  Line 2474 
2474    
2475  =head3 FindNamePart  =head3 FindNamePart
2476    
2477  C<< my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec); >>      my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec);
2478    
2479  Extract the portion of a file specification that contains the file name.  Extract the portion of a file specification that contains the file name.
2480    
# Line 659  Line 2525 
2525    
2526  =head3 OpenDir  =head3 OpenDir
2527    
2528  C<< my @files = OpenDir($dirName, $filtered, $flag); >>      my @files = OpenDir($dirName, $filtered, $flag);
2529    
2530  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
2531  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 2581 
2581          } else {          } else {
2582              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2583          }          }
2584            closedir $dirHandle;
2585      } elsif (! $flag) {      } elsif (! $flag) {
2586          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2587          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 723  Line 2590 
2590      return @retVal;      return @retVal;
2591  }  }
2592    
 =head3 SetLevel  
2593    
2594  C<< Tracer::SetLevel($newLevel); >>  =head3 Insure
2595    
2596        Insure($dirName, $chmod);
2597    
2598  Modify the trace level. A higher trace level will cause more messages to appear.  Insure a directory is present.
2599    
2600  =over 4  =over 4
2601    
2602  =item newLevel  =item dirName
2603    
2604  Proposed new trace level.  Name of the directory to check. If it does not exist, it will be created.
2605    
2606    =item chmod (optional)
2607    
2608    Security privileges to be given to the directory if it is created.
2609    
2610  =back  =back
2611    
2612  =cut  =cut
2613    
2614  sub SetLevel {  sub Insure {
2615      $TraceLevel = $_[0];      my ($dirName, $chmod) = @_;
2616        if (! -d $dirName) {
2617            Trace("Creating $dirName directory.") if T(2);
2618            eval {
2619                mkpath $dirName;
2620                # If we have permissions specified, set them here.
2621                if (defined($chmod)) {
2622                    chmod $chmod, $dirName;
2623                }
2624            };
2625            if ($@) {
2626                Confess("Error creating $dirName: $@");
2627            }
2628        }
2629  }  }
2630    
2631  =head3 Now  =head3 ChDir
2632    
2633        ChDir($dirName);
2634    
2635    Change to the specified directory.
2636    
2637    =over 4
2638    
2639    =item dirName
2640    
2641  C<< my $string = Tracer::Now(); >>  Name of the directory to which we want to change.
2642    
2643  Return a displayable time stamp containing the local time.  =back
2644    
2645  =cut  =cut
2646    
2647  sub Now {  sub ChDir {
2648      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      my ($dirName) = @_;
2649      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .      if (! -d $dirName) {
2650                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);          Confess("Cannot change to directory $dirName: no such directory.");
2651      return $retVal;      } else {
2652            Trace("Changing to directory $dirName.") if T(File => 4);
2653            my $okFlag = chdir $dirName;
2654            if (! $okFlag) {
2655                Confess("Error switching to directory $dirName.");
2656            }
2657  }  }
   
 # Pad a number to 2 digits.  
 sub _p2 {  
     my ($value) = @_;  
     $value = "0$value" if ($value < 10);  
     return $value;  
2658  }  }
2659    
2660  =head3 LogErrors  =head3 SetPermissions
2661    
2662  C<< Tracer::LogErrors($fileName); >>      Tracer::SetPermissions($dirName, $group, $mask, %otherMasks);
2663    
2664  Route the standard error output to a log file.  Set the permissions for a directory and all the files and folders inside it.
2665    In addition, the group ownership will be changed to the specified value.
2666    
2667    This method is more vulnerable than most to permission and compatability
2668    problems, so it does internal error recovery.
2669    
2670  =over 4  =over 4
2671    
2672  =item fileName  =item dirName
2673    
2674  Name of the file to receive the error output.  Name of the directory to process.
2675    
2676    =item group
2677    
2678    Name of the group to be assigned.
2679    
2680    =item mask
2681    
2682    Permission mask. Bits that are C<1> in this mask will be ORed into the
2683    permission bits of any file or directory that does not already have them
2684    set to 1.
2685    
2686    =item otherMasks
2687    
2688    Map of search patterns to permission masks. If a directory name matches
2689    one of the patterns, that directory and all its members and subdirectories
2690    will be assigned the new pattern. For example, the following would
2691    assign 0664 to most files, but would use 0777 for directories named C<tmp>.
2692    
2693        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2694    
2695    The list is ordered, so the following would use 0777 for C<tmp1> and
2696    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2697    
2698        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2699                                                       '^tmp' => 0666);
2700    
2701    Note that the pattern matches are all case-insensitive, and only directory
2702    names are matched, not file names.
2703    
2704  =back  =back
2705    
2706  =cut  =cut
2707    
2708  sub LogErrors {  sub SetPermissions {
2709      # Get the file name.      # Get the parameters.
2710      my ($fileName) = @_;      my ($dirName, $group, $mask, @otherMasks) = @_;
2711      # Open the file as the standard error output.      # Set up for error recovery.
2712      open STDERR, '>', $fileName;      eval {
2713            # Switch to the specified directory.
2714            ChDir($dirName);
2715            # Get the group ID.
2716            my $gid = getgrnam($group);
2717            # Get the mask for tracing.
2718            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2719            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2720            my $fixCount = 0;
2721            my $lookCount = 0;
2722            # @dirs will be a stack of directories to be processed.
2723            my @dirs = (getcwd());
2724            while (scalar(@dirs) > 0) {
2725                # Get the current directory.
2726                my $dir = pop @dirs;
2727                # Check for a match to one of the specified directory names. To do
2728                # that, we need to pull the individual part of the name off of the
2729                # whole path.
2730                my $simpleName = $dir;
2731                if ($dir =~ m!/([^/]+)$!) {
2732                    $simpleName = $1;
2733                }
2734                Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2735                # Search for a match.
2736                my $match = 0;
2737                my $i;
2738                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2739                    my $pattern = $otherMasks[$i];
2740                    if ($simpleName =~ /$pattern/i) {
2741                        $match = 1;
2742                    }
2743                }
2744                # Find out if we have a match. Note we use $i-1 because the loop added 2
2745                # before terminating due to the match.
2746                if ($match && $otherMasks[$i-1] != $mask) {
2747                    # This directory matches one of the incoming patterns, and it's
2748                    # a different mask, so we process it recursively with that mask.
2749                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2750                } else {
2751                    # Here we can process normally. Get all of the non-hidden members.
2752                    my @submems = OpenDir($dir, 1);
2753                    for my $submem (@submems) {
2754                        # Get the full name.
2755                        my $thisMem = "$dir/$submem";
2756                        Trace("Checking member $thisMem.") if T(4);
2757                        $lookCount++;
2758                        if ($lookCount % 1000 == 0) {
2759                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2760                        }
2761                        # Fix the group.
2762                        chown -1, $gid, $thisMem;
2763                        # Insure this member is not a symlink.
2764                        if (! -l $thisMem) {
2765                            # Get its info.
2766                            my $fileInfo = stat $thisMem;
2767                            # Only proceed if we got the info. Otherwise, it's a hard link
2768                            # and we want to skip it anyway.
2769                            if ($fileInfo) {
2770                                my $fileMode = $fileInfo->mode;
2771                                if (($fileMode & $mask) != $mask) {
2772                                    # Fix this member.
2773                                    $fileMode |= $mask;
2774                                    chmod $fileMode, $thisMem;
2775                                    $fixCount++;
2776                                }
2777                                # If it's a subdirectory, stack it.
2778                                if (-d $thisMem) {
2779                                    push @dirs, $thisMem;
2780                                }
2781                            }
2782                        }
2783                    }
2784                }
2785            }
2786            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2787        };
2788        # Check for an error.
2789        if ($@) {
2790            Confess("SetPermissions error: $@");
2791        }
2792  }  }
2793    
2794  =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  
2795    
2796  I<optionName>C<=>I<optionValue>C<; >I<comment>      my @data = Tracer::GetLine($handle);
2797    
2798  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.  
2799    
2800  =over 4  =over 4
2801    
2802  =item fileName  =item handle
2803    
2804  Name of the file containing the option data.  Open file handle from which to read.
2805    
2806  =item RETURN  =item RETURN
2807    
2808  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
2809  value.  tab-delimited. If we are at the end of the file, then an empty list will be
2810    returned. If an empty line is read, a single list item consisting of a null
2811    string will be returned.
2812    
2813  =back  =back
2814    
2815  =cut  =cut
2816    
2817  sub ReadOptions {  sub GetLine {
2818      # Get the parameters.      # Get the parameters.
2819      my ($fileName) = @_;      my ($handle) = @_;
2820      # Open the file.      # Declare the return variable.
2821      (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");      my @retVal = ();
2822      # Count the number of records read.      Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2823      my ($records, $comments) = 0;      # Read from the file.
2824      # Create the return hash.      my $line = <$handle>;
2825      my %retVal = ();      # Only proceed if we found something.
2826      # Loop through the file, accumulating key-value pairs.      if (defined $line) {
2827      while (my $line = <CONFIGFILE>) {          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2828          # Denote we've read a line.          # upload control and have a nonstandard EOL combination.
2829          $records++;          $line =~ s/(\r|\n)+$//;
2830          # Determine the line type.          # Here we do some fancy tracing to help in debugging complicated EOL marks.
2831          if ($line =~ /^\s*[\n\r]/) {          if (T(File => 4)) {
2832              # A blank line is a comment.              my $escapedLine = $line;
2833              $comments++;              $escapedLine =~ s/\n/\\n/g;
2834          } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {              $escapedLine =~ s/\r/\\r/g;
2835              # Here we have an option assignment.              $escapedLine =~ s/\t/\\t/g;
2836              retVal{$1} = $2;              Trace("Line read: -->$escapedLine<--");
2837          } elsif ($line =~ /^\s*;/) {          }
2838              # Here we have a text comment.          # If the line is empty, return a single empty string; otherwise, parse
2839              $comments++;          # it into fields.
2840            if ($line eq "") {
2841                push @retVal, "";
2842          } else {          } else {
2843              # Here we have an invalid line.              push @retVal, split /\t/,$line;
             Trace("Invalid option statement in record $records.") if T(0);  
2844          }          }
2845        } else {
2846            # Trace the reason the read failed.
2847            Trace("End of file: $!") if T(File => 3);
2848      }      }
2849      # Return the hash created.      # Return the result.
2850      return %retVal;      return @retVal;
2851  }  }
2852    
2853  =head3 GetOptions  =head3 PutLine
2854    
2855  C<< Tracer::GetOptions(\%defaults, \%options); >>      Tracer::PutLine($handle, \@fields, $eol);
2856    
2857  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
2858  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.  
2859    
2860  Consider the following example.  =over 4
2861    
2862  C<< my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options); >>  =item handle
2863    
2864  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  
2865    
2866  C<< {databaseType => 'Oracle'} >>  =item fields
2867    
2868  an error will occur because the B<databaseType> option does not exist.  List of field values.
2869    
2870  =over 4  =item eol (optional)
2871    
2872  =item defaults  End-of-line character (default is "\n").
2873    
2874  Table of default option values.  =back
2875    
2876  =item options  =cut
2877    
2878  Table of overrides, if any.  sub PutLine {
2879        # Get the parameters.
2880        my ($handle, $fields, $eol) = @_;
2881        # Write the data.
2882        print $handle join("\t", @{$fields}) . ($eol || "\n");
2883    }
2884    
 =item RETURN  
2885    
2886  Returns a reference to the default table passed in as the first parameter.  =head3 PrintLine
2887    
2888        Tracer::PrintLine($line);
2889    
2890    Print a line of text with a trailing new-line.
2891    
2892    =over 4
2893    
2894    =item line
2895    
2896    Line of text to print.
2897    
2898  =back  =back
2899    
2900  =cut  =cut
2901    
2902  sub GetOptions {  sub PrintLine {
2903      # Get the parameters.      # Get the parameters.
2904      my ($defaults, $options) = @_;      my ($line) = @_;
2905      # Check for overrides.      # Print the line.
2906      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;  
             }  
         }  
2907      }      }
2908      # Return the merged table.  
2909      return $defaults;  
2910    =head2 Other Useful Methods
2911    
2912    =head3 IDHASH
2913    
2914        my $hash = SHTargetSearch::IDHASH(@keys);
2915    
2916    This is a dinky little method that converts a list of values to a reference
2917    to hash of values to labels. The values and labels are the same.
2918    
2919    =cut
2920    
2921    sub IDHASH {
2922        my %retVal = map { $_ => $_ } @_;
2923        return \%retVal;
2924  }  }
2925    
2926  =head3 MergeOptions  =head3 Pluralize
2927    
2928  C<< Tracer::MergeOptions(\%table, \%defaults); >>      my $plural = Tracer::Pluralize($word);
2929    
2930  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
2931  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
2932  pair is copied in. The process is similar to L</GetOptions>, but there is no error-  adds C<es>.
 checking and no return value.  
2933    
2934  =over 4  =over 4
2935    
2936  =item table  =item word
2937    
2938  Hash table to be updated with the default values.  Singular word to pluralize.
2939    
2940  =item defaults  =item RETURN
2941    
2942  Default values to be merged into the first hash table if they are not already present.  Returns the probable plural form of the word.
2943    
2944  =back  =back
2945    
2946  =cut  =cut
2947    
2948  sub MergeOptions {  sub Pluralize {
2949      # Get the parameters.      # Get the parameters.
2950      my ($table, $defaults) = @_;      my ($word) = @_;
2951      # Loop through the defaults.      # Declare the return variable.
2952      while (my ($key, $value) = each %{$defaults}) {      my $retVal;
2953          if (!exists $table->{$key}) {      if ($word =~ /s$/) {
2954              $table->{$key} = $value;          $retVal = $word . 'es';
2955          }      } else {
2956            $retVal = $word . 's';
2957      }      }
2958        # Return the result.
2959        return $retVal;
2960  }  }
2961    
2962  =head3 Trace  =head3 Numeric
2963    
2964  C<< Trace($message); >>      my $okFlag = Tracer::Numeric($string);
2965    
2966  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
2967  any prior call to B<TSetup>.  if it is not numeric.
2968    
2969  =over 4  =over 4
2970    
2971  =item message  =item string
2972    
2973  Message to write.  String to check.
2974    
2975    =item RETURN
2976    
2977    Returns the numeric value of the string if successful, or C<undef> if the string
2978    is not numeric.
2979    
2980  =back  =back
2981    
2982  =cut  =cut
2983    
2984  sub Trace {  sub Numeric {
2985      # Get the parameters.      # Get the parameters.
2986      my ($message) = @_;      my ($string) = @_;
2987      # Get the timestamp.      # We'll put the value in here if we succeed.
2988      my $timeStamp = Now();      my $retVal;
2989      # Format the message. Note we strip off any line terminators at the end.      # Get a working copy of the string.
2990      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $copy = $string;
2991      # Process according to the destination.      # Trim leading and trailing spaces.
2992      if ($Destination eq "TEXT") {      $copy =~ s/^\s+//;
2993          # Write the message to the standard output.      $copy =~ s/\s+$//;
2994          print "$formatted\n";      # Check the result.
2995      } elsif ($Destination eq "ERROR") {      if ($copy =~ /^[+-]?\d+$/) {
2996          # Write the message to the error output.          $retVal = $copy;
2997          print STDERR "$formatted\n";      } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2998      } elsif ($Destination eq "QUEUE") {          $retVal = $copy;
2999          # Push the message into the queue.      } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
3000          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";  
         }  
3001      }      }
3002        # Return the result.
3003        return $retVal;
3004  }  }
3005    
 =head3 T  
   
 C<< my $switch = T($category, $traceLevel); >>  
3006    
3007      or  =head3 ParseParm
3008    
3009  C<< my $switch = T($traceLevel); >>      my $listValue = Tracer::ParseParm($string);
3010    
3011  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,
3012  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
3013    comma-separated list of values.
3014    
3015  =over 4  =over 4
3016    
3017  =item category  =item string
   
 Category to which the message belongs. If not specified, the caller's package name is  
 used.  
   
 =item traceLevel  
3018    
3019  Relevant tracing level.  Incoming string.
3020    
3021  =item RETURN  =item RETURN
3022    
3023  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
3024    was undefined.
3025    
3026  =back  =back
3027    
3028  =cut  =cut
3029    
3030  sub T {  sub ParseParm {
     # Declare the return variable.  
     my $retVal = 0;  
     # Only proceed if tracing is turned on.  
     if ($Destination ne "NONE") {  
3031          # Get the parameters.          # Get the parameters.
3032          my ($category, $traceLevel) = @_;      my ($string) = @_;
3033          if (!defined $traceLevel) {      # Declare the return variable.
3034              # Here we have no category, so we need to get the calling package.      my $retVal;
3035              # The calling package is normally the first parameter. If it is      # Check for data.
3036              # omitted, the first parameter will be the tracelevel. So, the      if (defined $string) {
3037              # first thing we do is shift the so-called category into the          # We have some, so split it into a list.
3038              # $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}));  
3039      }      }
3040      # Return the computed result.      # Return the result.
3041      return $retVal;      return $retVal;
3042  }  }
3043    
3044  =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); >>  
3045    
3046  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  
3047    
3048  C<< -logFile=error.log apple orange rutabaga >>  Return a displayable time stamp containing the local time. Whatever format this
3049    method produces must be parseable by L</ParseDate>.
3050    
3051  then at the end of the invocation, C<$options> will be  =cut
3052    
3053  C<< { errors => 0, logFile => 'error.log' } >>  sub Now {
3054        return DisplayTime(time);
3055    }
3056    
3057  and C<@arguments> will contain  =head3 DisplayTime
3058    
3059  C<< apple orange rutabaga >>      my $string = Tracer::DisplayTime($time);
3060    
3061  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
3062  support for quote characters.  method produces must be parseable by L</ParseDate>.
3063    
3064  =over 4  =over 4
3065    
3066  =item optionTable  =item time
   
 Table of default options.  
   
 =item inputList  
3067    
3068  List of words on the command line.  Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
3069    
3070  =item RETURN  =item RETURN
3071    
3072  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  
3073    
3074  sub ParseCommand {  =back
3075      # Get the parameters.  
3076      my ($optionTable, @inputList) = @_;  =cut
3077      # Process any options in the input list.  
3078      my %overrides = ();  sub DisplayTime {
3079      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      my ($time) = @_;
3080          # Get the current option.      my $retVal = "(n/a)";
3081          my $arg = shift @inputList;      if (defined $time) {
3082          # Pull out the option name.          my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
3083          $arg =~ /^-([^=]*)/g;          $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
3084          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;  
         }  
3085      }      }
3086      # 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);  
3087      }      }
3088      # Return the results.  
3089      return ($optionTable, @retVal);  # Pad a number to 2 digits.
3090    sub _p2 {
3091        my ($value) = @_;
3092        $value = "0$value" if ($value < 10);
3093        return $value;
3094  }  }
3095    
3096  =head3 Escape  =head3 Escape
3097    
3098  C<< my $codedString = Tracer::Escape($realString); >>      my $codedString = Tracer::Escape($realString);
3099    
3100  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
3101  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
3102  result is to reverse the effect of L</UnEscape>.  result is to reverse the effect of L</UnEscape>.
3103    
# Line 1198  Line 3150 
3150    
3151  =head3 UnEscape  =head3 UnEscape
3152    
3153  C<< my $realString = Tracer::UnEscape($codedString); >>      my $realString = Tracer::UnEscape($codedString);
3154    
3155  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
3156  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 3208 
3208      return $retVal;      return $retVal;
3209  }  }
3210    
 =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;  
 }  
   
3211  =head3 Percent  =head3 Percent
3212    
3213  C<< my $percent = Tracer::Percent($number, $base); >>      my $percent = Tracer::Percent($number, $base);
3214    
3215  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
3216  is zero, returns zero.  is zero, returns zero.
# Line 1377  Line 3236 
3236  sub Percent {  sub Percent {
3237      # Get the parameters.      # Get the parameters.
3238      my ($number, $base) = @_;      my ($number, $base) = @_;
3239      # Declare the return variable.      # Declare the return variable.
3240      my $retVal = 0;      my $retVal = 0;
3241      # Compute the percent.      # Compute the percent.
3242      if ($base != 0) {      if ($base != 0) {
3243          $retVal = $number * 100 / $base;          $retVal = $number * 100 / $base;
3244      }      }
3245      # Return the result.      # Return the result.
3246      return $retVal;      return $retVal;
3247  }  }
   
 =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  
3248    
3249  =item message  =head3 In
3250    
3251  Message to include in the trace.      my $flag = Tracer::In($value, $min, $max);
3252    
3253  =back  Return TRUE if the value is between the minimum and the maximum, else FALSE.
3254    
3255  =cut  =cut
3256    
3257  sub Confess {  sub In {
3258      # Get the parameters.      return ($_[0] <= $_[2] && $_[0] >= $_[1]);
     my ($message) = @_;  
     # Trace the call stack.  
     Cluck($message);  
     # Abort the program.  
     croak(">>> $message");  
3259  }  }
3260    
 =head3 Assert  
   
 C<< Assert($condition1, $condition2, ... $conditionN); >>  
3261    
3262  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  
3263    
3264  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>      my $constrained = Constrain($value, $min, $max);
3265    
3266  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.
3267    
3268  =cut  =over 4
 sub Assert {  
     my $retVal = 1;  
     LOOP: for my $condition (@_) {  
         if (! $condition) {  
             $retVal = 0;  
             last LOOP;  
         }  
     }  
     return $retVal;  
 }  
3269    
3270  =head3 Cluck  =item value
3271    
3272  C<< Cluck($message); >>  Value to constrain.
3273    
3274  Trace the call stack. Note that for best results, you should qualify the call with a  =item min (optional)
 trace condition. For example,  
3275    
3276  C<< Cluck("Starting record parse.") if T(3); >>  Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3277    
3278  will only trace the stack if the trace level for the package is 3 or more.  =item max (optional)
3279    
3280  =over 4  Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3281    
3282  =item message  =item RETURN
3283    
3284  Message to include in the trace.  Returns the incoming value, constrained according to the other parameters.
3285    
3286  =back  =back
3287    
3288  =cut  =cut
3289    
3290  sub Cluck {  sub Constrain {
3291      # Get the parameters.      # Get the parameters.
3292      my ($message) = @_;      my ($value, $min, $max) = @_;
3293      # Trace what's happening.      # Declare the return variable.
3294      Trace("Stack trace for event: $message");      my $retVal = $value;
3295      my $confession = longmess($message);      # Apply the minimum constraint.
3296      # Convert the confession to a series of trace messages. Note we skip any      if (defined $min && $retVal < $min) {
3297      # messages relating to calls into Tracer.          $retVal = $min;
3298      for my $line (split /\s*\n/, $confession) {      }
3299          Trace($line) if ($line !~ /Tracer\.pm/);      # Apply the maximum constraint.
3300        if (defined $max && $retVal > $max) {
3301            $retVal = $max;
3302      }      }
3303        # Return the result.
3304        return $retVal;
3305  }  }
3306    
3307  =head3 Min  =head3 Min
3308    
3309  C<< my $min = Min($value1, $value2, ... $valueN); >>      my $min = Min($value1, $value2, ... $valueN);
3310    
3311  Return the minimum argument. The arguments are treated as numbers.  Return the minimum argument. The arguments are treated as numbers.
3312    
# Line 1641  Line 3339 
3339    
3340  =head3 Max  =head3 Max
3341    
3342  C<< my $max = Max($value1, $value2, ... $valueN); >>      my $max = Max($value1, $value2, ... $valueN);
3343    
3344  Return the maximum argument. The arguments are treated as numbers.  Return the maximum argument. The arguments are treated as numbers.
3345    
# Line 1672  Line 3370 
3370      return $retVal;      return $retVal;
3371  }  }
3372    
3373  =head3 AddToListMap  =head3 Strip
3374    
3375  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>      my $string = Tracer::Strip($line);
3376    
3377  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
3378  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
3379    operating environments.
3380    
3381  =over 4  =over 4
3382    
3383  =item hash  =item line
   
 Reference to the target hash.  
   
 =item key  
3384    
3385  Key for which the value is to be added.  Line of text to be stripped.
3386    
3387  =item value1, value2, ... valueN  =item RETURN
3388    
3389  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.
3390    
3391  =back  =back
3392    
3393  =cut  =cut
3394    
3395  sub AddToListMap {  sub Strip {
3396      # Get the parameters.      # Get a copy of the parameter string.
3397      my ($hash, $key, @values) = @_;      my ($string) = @_;
3398      # Process according to whether or not the key already has a value.      my $retVal = (defined $string ? $string : "");
3399      if (! exists $hash->{$key}) {      # Strip the line terminator characters.
3400          $hash->{$key} = [@values];      $retVal =~ s/(\r|\n)+$//g;
3401      } 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.  
3402      return $retVal;      return $retVal;
3403  }  }
3404    
3405  =head3 Strip  =head3 Trim
3406    
3407  C<< my $string = Tracer::Strip($line); >>      my $string = Tracer::Trim($line);
3408    
3409  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.  
3410    
3411  =over 4  =over 4
3412    
3413  =item line  =item line
3414    
3415  Line of text to be stripped.  Line of text to be trimmed.
3416    
3417  =item RETURN  =item RETURN
3418    
3419  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.
3420    
3421  =back  =back
3422    
3423  =cut  =cut
3424    
3425  sub Strip {  sub Trim {
3426      # Get a copy of the parameter string.      # Get a copy of the parameter string.
3427      my ($string) = @_;      my ($string) = @_;
3428      my $retVal = (defined $string ? $string : "");      my $retVal = (defined $string ? $string : "");
3429      # Strip the line terminator characters.      # Strip the front spaces.
3430      $retVal =~ s/(\r|\n)+$//g;      $retVal =~ s/^\s+//;
3431        # Strip the back spaces.
3432        $retVal =~ s/\s+$//;
3433      # Return the result.      # Return the result.
3434      return $retVal;      return $retVal;
3435  }  }
3436    
3437  =head3 Pad  =head3 Pad
3438    
3439  C<< my $paddedString = Tracer::Pad($string, $len, $left, $padChar); >>      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
3440    
3441  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
3442  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 3495 
3495      return $retVal;      return $retVal;
3496  }  }
3497    
3498    =head3 Quoted
3499    
3500        my $string = Tracer::Quoted($var);
3501    
3502    Convert the specified value to a string and enclose it in single quotes.
3503    If it's undefined, the string C<undef> in angle brackets will be used
3504    instead.
3505    
3506    =over 4
3507    
3508    =item var
3509    
3510    Value to quote.
3511    
3512    =item RETURN
3513    
3514    Returns a string enclosed in quotes, or an indication the value is undefined.
3515    
3516    =back
3517    
3518    =cut
3519    
3520    sub Quoted {
3521        # Get the parameters.
3522        my ($var) = @_;
3523        # Declare the return variable.
3524        my $retVal;
3525        # Are we undefined?
3526        if (! defined $var) {
3527            $retVal = "<undef>";
3528        } else {
3529            # No, so convert to a string and enclose in quotes.
3530            $retVal = $var;
3531            $retVal =~ s/'/\\'/;
3532            $retVal = "'$retVal'";
3533        }
3534        # Return the result.
3535        return $retVal;
3536    }
3537    
3538  =head3 EOF  =head3 EOF
3539    
3540  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 3547 
3547    
3548  =head3 TICK  =head3 TICK
3549    
3550  C<< my @results = TICK($commandString); >>      my @results = TICK($commandString);
3551    
3552  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
3553  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 3586 
3586      return `$commandString`;      return `$commandString`;
3587  }  }
3588    
 =head3 ScriptSetup  
3589    
3590  C<< my ($query, $varHash) = ScriptSetup(); >>  =head3 CommaFormat
3591    
3592        my $formatted = Tracer::CommaFormat($number);
3593    
3594  Perform standard tracing and debugging setup for scripts. The value returned is  Insert commas into a number.
3595  the CGI object followed by a pre-built variable hash.  
3596    =over 4
3597    
3598    =item number
3599    
3600    A sequence of digits.
3601    
3602    =item RETURN
3603    
3604    Returns the same digits with commas strategically inserted.
3605    
3606  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.  
3607    
3608  =cut  =cut
3609    
3610  sub ScriptSetup {  sub CommaFormat {
3611      # Get the CGI query object.      # Get the parameters.
3612      my $query = CGI->new();      my ($number) = @_;
3613      # Check for tracing. Set it up if the user asked for it.      # Pad the length up to a multiple of three.
3614      if ($query->param('Trace')) {      my $padded = "$number";
3615          # Set up tracing to be queued for display at the bottom of the web page.      $padded = " " . $padded while length($padded) % 3 != 0;
3616          TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");      # This is a fancy PERL trick. The parentheses in the SPLIT pattern
3617          # Trace the parameter and environment data.      # cause the delimiters to be included in the output stream. The
3618          if (T(CGI => 3)) {      # GREP removes the empty strings in between the delimiters.
3619              # Here we want to trace the parameter data.      my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
3620              my @names = $query->param;      # Clean out the spaces.
3621              for my $parmName (sort @names) {      $retVal =~ s/ //g;
3622                  # Note we skip "Trace", which is for our use only.      # Return the result.
3623                  if ($parmName ne 'Trace') {      return $retVal;
                     my @values = $query->param($parmName);  
                     Trace("CGI: $parmName = " . join(", ", @values));  
3624                  }                  }
3625    
3626    
3627    =head3 GetMemorySize
3628    
3629        my $string = Tracer::GetMemorySize();
3630    
3631    Return a memory size string for the current process. The string will be
3632    in comma format, with a size indicator (K, M, G) at the end.
3633    
3634    =cut
3635    
3636    sub GetMemorySize {
3637        # Get the memory size from Unix.
3638        my ($retVal) = `ps h -o vsz $$`;
3639        # Remove the ending new-line.
3640        chomp $retVal;
3641        # Format and return the result.
3642        return CommaFormat($retVal) . "K";
3643              }              }
3644    
3645    =head3 CompareLists
3646    
3647        my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
3648    
3649    Compare two lists of tuples, and return a hash analyzing the differences. The lists
3650    are presumed to be sorted alphabetically by the value in the $keyIndex column.
3651    The return value contains a list of items that are only in the new list
3652    (inserted) and only in the old list (deleted).
3653    
3654    =over 4
3655    
3656    =item newList
3657    
3658    Reference to a list of new tuples.
3659    
3660    =item oldList
3661    
3662    Reference to a list of old tuples.
3663    
3664    =item keyIndex (optional)
3665    
3666    Index into each tuple of its key field. The default is 0.
3667    
3668    =item RETURN
3669    
3670    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
3671    list (inserted) followed by a reference to the list of items that are only in the old
3672    list (deleted).
3673    
3674    =back
3675    
3676    =cut
3677    
3678    sub CompareLists {
3679        # Get the parameters.
3680        my ($newList, $oldList, $keyIndex) = @_;
3681        if (! defined $keyIndex) {
3682            $keyIndex = 0;
3683        }
3684        # Declare the return variables.
3685        my ($inserted, $deleted) = ([], []);
3686        # Loop through the two lists simultaneously.
3687        my ($newI, $oldI) = (0, 0);
3688        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
3689        while ($newI < $newN || $oldI < $oldN) {
3690            # Get the current object in each list. Note that if one
3691            # of the lists is past the end, we'll get undef.
3692            my $newItem = $newList->[$newI];
3693            my $oldItem = $oldList->[$oldI];
3694            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
3695                # The old item is not in the new list, so mark it deleted.
3696                push @{$deleted}, $oldItem;
3697                $oldI++;
3698            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
3699                # The new item is not in the old list, so mark it inserted.
3700                push @{$inserted}, $newItem;
3701                $newI++;
3702            } else {
3703                # The item is in both lists, so push forward.
3704                $oldI++;
3705                $newI++;
3706          }          }
         if (T(CGI => 4)) {  
             # Here we want the environment data too.  
             for my $envName (sort keys %ENV) {  
                 Trace("ENV: $envName = $ENV{$envName}");  
3707              }              }
3708        # Return the result.
3709        return ($inserted, $deleted);
3710          }          }
3711    
3712    =head3 Cmp
3713    
3714        my $cmp = Tracer::Cmp($a, $b);
3715    
3716    This method performs a universal sort comparison. Each value coming in is
3717    separated into a text parts and number parts. The text
3718    part is string compared, and if both parts are equal, then the number
3719    parts are compared numerically. A stream of just numbers or a stream of
3720    just strings will sort correctly, and a mixed stream will sort with the
3721    numbers first. Strings with a label and a number will sort in the
3722    expected manner instead of lexically. Undefined values sort last.
3723    
3724    =over 4
3725    
3726    =item a
3727    
3728    First item to compare.
3729    
3730    =item b
3731    
3732    Second item to compare.
3733    
3734    =item RETURN
3735    
3736    Returns a negative number if the first item should sort first (is less), a positive
3737    number if the first item should sort second (is greater), and a zero if the items are
3738    equal.
3739    
3740    =back
3741    
3742    =cut
3743    
3744    sub Cmp {
3745        # Get the parameters.
3746        my ($a, $b) = @_;
3747        # Declare the return value.
3748        my $retVal;
3749        # Check for nulls.
3750        if (! defined($a)) {
3751            $retVal = (! defined($b) ? 0 : -1);
3752        } elsif (! defined($b)) {
3753            $retVal = 1;
3754      } else {      } else {
3755          # 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.
3756          # error log.          my @aParsed = _Parse($a);
3757          TSetup("0", "WARN");          my @bParsed = _Parse($b);
3758            # Loop through the first string.
3759            while (! $retVal && @aParsed) {
3760                # Extract the string parts.
3761                my $aPiece = shift(@aParsed);
3762                my $bPiece = shift(@bParsed) || '';
3763                # Extract the number parts.
3764                my $aNum = shift(@aParsed);
3765                my $bNum = shift(@bParsed) || 0;
3766                # Compare the string parts insensitively.
3767                $retVal = (lc($aPiece) cmp lc($bPiece));
3768                # If they're equal, compare them sensitively.
3769                if (! $retVal) {
3770                    $retVal = ($aPiece cmp $bPiece);
3771                    # If they're STILL equal, compare the number parts.
3772                    if (! $retVal) {
3773                        $retVal = $aNum <=> $bNum;
3774                    }
3775                }
3776            }
3777        }
3778        # Return the result.
3779        return $retVal;
3780    }
3781    
3782    # This method parses an input string into a string parts alternating with
3783    # number parts.
3784    sub _Parse {
3785        # Get the incoming string.
3786        my ($string) = @_;
3787        # The pieces will be put in here.
3788        my @retVal;
3789        # Loop through as many alpha/num sets as we can.
3790        while ($string =~ /^(\D*)(\d+)(.*)/) {
3791            # Push the alpha and number parts into the return string.
3792            push @retVal, $1, $2;
3793            # Save the residual.
3794            $string = $3;
3795        }
3796        # If there's still stuff left, add it to the end with a trailing
3797        # zero.
3798        if ($string) {
3799            push @retVal, $string, 0;
3800        }
3801        # Return the list.
3802        return @retVal;
3803    }
3804    
3805    =head3 ListEQ
3806    
3807        my $flag = Tracer::ListEQ(\@a, \@b);
3808    
3809    Return TRUE if the specified lists contain the same strings in the same
3810    order, else FALSE.
3811    
3812    =over 4
3813    
3814    =item a
3815    
3816    Reference to the first list.
3817    
3818    =item b
3819    
3820    Reference to the second list.
3821    
3822    =item RETURN
3823    
3824    Returns TRUE if the two parameters are identical string lists, else FALSE.
3825    
3826    =back
3827    
3828    =cut
3829    
3830    sub ListEQ {
3831        # Get the parameters.
3832        my ($a, $b) = @_;
3833        # Declare the return variable. Start by checking the lengths.
3834        my $n = scalar(@$a);
3835        my $retVal = ($n == scalar(@$b));
3836        # Now compare the list elements.
3837        for (my $i = 0; $retVal && $i < $n; $i++) {
3838            $retVal = ($a->[$i] eq $b->[$i]);
3839        }
3840        # Return the result.
3841        return $retVal;
3842      }      }
3843    
3844    =head2 CGI Script Utilities
3845    
3846    =head3 ScriptSetup (deprecated)
3847    
3848        my ($cgi, $varHash) = ScriptSetup($noTrace);
3849    
3850    Perform standard tracing and debugging setup for scripts. The value returned is
3851    the CGI object followed by a pre-built variable hash. At the end of the script,
3852    the client should call L</ScriptFinish> to output the web page.
3853    
3854    This method calls L</ETracing> to configure tracing, which allows the tracing
3855    to be configured via the emergency tracing form on the debugging control panel.
38