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