[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.69, Mon Oct 2 02:59:47 2006 UTC revision 1.101, Thu May 8 18:03:10 2008 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    
21      require Exporter;      require Exporter;
22      @ISA = ('Exporter');      @ISA = ('Exporter');
23      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyIP ScriptSetup ScriptFinish Insure ChDir Emergency);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency Warn);
24      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
25      use strict;      use strict;
26      use Carp qw(longmess croak);      use Carp qw(longmess croak carp);
27      use CGI;      use CGI;
28      use Cwd;      use Cwd;
29      use FIG_Config;      use FIG_Config;
# Line 34  Line 35 
35      use LWP::UserAgent;      use LWP::UserAgent;
36      use Time::HiRes 'gettimeofday';      use Time::HiRes 'gettimeofday';
37      use URI::Escape;      use URI::Escape;
38        use Time::Local;
39        use POSIX qw(strftime);
40        use Time::Zone;
41    
42    
43  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
44    
45  =head2 Introduction  =head2 Tracing
46    
47  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
48  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.
49  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,
50  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
51  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
52  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
53  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
54  appear. To generate a trace message, use the following syntax.  appear.
55    
56    =head3 Putting Trace Messages in Your Code
57    
58  C<< Trace($message) if T(errors => 4); >>  To generate a trace message, use the following syntax.
59    
60        Trace($message) if T(errors => 4);
61    
62  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>
63  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
64    
65  C<< Trace($message) if T(main => 4); >>      Trace($message) if T(main => 4);
66    
67  will trace if the trace level is 4 or more.  will trace if the trace level is 4 or more.
68    
# Line 61  Line 70 
70  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
71  active and the trace level is 2 or more.  active and the trace level is 2 or more.
72    
73  C<< Trace($message) if T(2); >>      Trace($message) if T(2);
74    
75    In scripts, where no package name is available, the category defaults to C<main>.
76    
77    =head3 Custom Tracing
78    
79    Many programs have customized tracing configured using the L</TSetup> method. This is no longer
80    the preferred method, but a knowledge of how custom tracing works can make the more modern
81    L</Emergency Tracing> easier to understand.
82    
83  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,
84  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
85  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
86    
87  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
88    
89  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
90  specifies that messages should be output as HTML paragraphs.  specifies that messages should be sent to the standard output.
91    
92  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
93  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
94  useful in a CGI environment.  useful in a CGI environment.
95    
96  C<< TSetup('3 *', 'WARN'); >>      TSetup('3 *', 'WARN');
97    
98  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
99  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
100  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
101  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
102  it easier to debug page formatting problems.  it easier to debug page formatting problems.
103    
104  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
105    a file at the same time. To trace to a file, specify the filename with an output character in front
106    of it.
107    
108        TSetup('4 SQL', ">$fileName");
109    
110    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
111    bracket.
112    
113        TSetup('3 *', "+>$fileName");
114    
115  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>.
116  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.
117  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
118  being used out in the field.  being used out in the field.
119    
120    =head3 Trace Levels
121    
122  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
123  a suggestion.  a suggestion.
124    
# Line 122  Line 150 
150  =back  =back
151    
152  The format of trace messages is important because some utilities analyze trace files.  The format of trace messages is important because some utilities analyze trace files.
153  The time stamp is between square brackets, the module name between angle brackets,  There are three fields-- the time stamp, the category name, and the text.
154  a colon (C<:>), and the message text after that. If the square brackets or angle  The time stamp is between square brackets and the category name between angle brackets.
155  brackets are missing, then the trace management utilities assume that they  After the category name there is a colon (C<:>) followed by the message text.
156  are encountering a set of pre-formatted lines.  If the square brackets or angle brackets are missing, then the trace management
157    utilities assume that they are encountering a set of pre-formatted lines.
158    
159    Note, however, that this formatting is done automatically by the tracing functions. You
160    only need to know about it if you want to parse a trace file.
161    
162    =head3 Emergency Tracing
163    
164    Sometimes, you need a way for tracing to happen automatically without putting parameters
165    in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
166    from the debug form, which is accessed from the [[DebugConsole]]. Emergency tracing requires
167    that you specify a tracing key. For command-line tools, the key is
168    taken from the C<TRACING> environment variable. For web services, the key is taken from
169    a cookie. Either way, the key tells the tracing facility who you are, so that you control
170    the tracing in your environment without stepping on other users.
171    
172    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
173    generate one for you.
174    
175    You can activate and de-activate emergency tracing from the debugging control panel, as
176    well as display the trace file itself.
177    
178    To enable emergency tracing in your code, call
179    
180        ETracing($cgi)
181    
182    from a web script and
183    
184        ETracing()
185    
186    from a command-line script.
187    
188    The web script will look for the tracing key in the cookies, and the command-line
189    script will look for it in the C<TRACING> environment variable. If you are
190    using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
191    will be configured automatically.
192    
193  =cut  =cut
194    
195  # Declare the configuration variables.  # Declare the configuration variables.
196    
197  my $Destination = "NONE";   # Description of where to send the trace output.  my $Destination = "WARN";   # Description of where to send the trace output.
198  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
199                              # standard output                              # standard output
200  my %Categories = ( main => 1 );  my %Categories = ( main => 1 );
201                              # hash of active category names                              # hash of active category names
202    my @LevelNames = qw(error warn notice info detail);
203  my $TraceLevel = 0;         # trace level; a higher trace level produces more  my $TraceLevel = 0;         # trace level; a higher trace level produces more
204                              # messages                              # messages
205  my @Queue = ();             # queued list of trace messages.  my @Queue = ();             # queued list of trace messages.
206  my $LastCategory = "main";  # name of the last category interrogated  my $LastCategory = "main";  # name of the last category interrogated
207    my $LastLevel = 0;          # level of the last test call
208  my $SetupCount = 0;         # number of times TSetup called  my $SetupCount = 0;         # number of times TSetup called
209  my $AllTrace = 0;           # TRUE if we are tracing all categories.  my $AllTrace = 0;           # TRUE if we are tracing all categories.
210    my $SavedCGI;               # CGI object passed to ETracing
211    umask 2;                    # Fix the damn umask so everything is group-writable.
212    
213    =head2 Tracing Methods
214    
215    =head3 Setups
216    
217        my $count = Tracer::Setups();
218    
219    Return the number of times L</TSetup> has been called.
220    
221    This method allows for the creation of conditional tracing setups where, for example, we
222    may want to set up tracing if nobody else has done it before us.
223    
224  =head2 Public Methods  =cut
225    
226    sub Setups {
227        return $SetupCount;
228    }
229    
230  =head3 TSetup  =head3 TSetup
231    
232  C<< TSetup($categoryList, $target); >>      TSetup($categoryList, $target);
233    
234  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
235  and interrogated by the L</Trace> and L</T> methods.  and interrogated by the L</Trace> and L</T> methods.
# Line 197  Line 279 
279          }          }
280      }      }
281      # Now we need to process the destination information. The most important special      # Now we need to process the destination information. The most important special
282      # 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
283      # "+" prefix which indicates a double echo.      # ">>" (append). A leading "+" for either indicates that we are also writing to
284        # the standard output (tee mode).
285      if ($target =~ m/^\+?>>?/) {      if ($target =~ m/^\+?>>?/) {
286          if ($target =~ m/^\+/) {          if ($target =~ m/^\+/) {
287              $TeeFlag = 1;              $TeeFlag = 1;
288              $target = substr($target, 1);              $target = substr($target, 1);
289          }          }
290          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
291                # We need to initialize the file (which clears it).
292              open TRACEFILE, $target;              open TRACEFILE, $target;
293              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] [notice] [Tracer] Tracing initialized.\n";
294              close TRACEFILE;              close TRACEFILE;
295                # Set to append mode now that the file has been cleared.
296              $Destination = ">$target";              $Destination = ">$target";
297          } else {          } else {
298              $Destination = $target;              $Destination = $target;
# Line 219  Line 304 
304      $SetupCount++;      $SetupCount++;
305  }  }
306    
307  =head3 StandardSetup  =head3 SetLevel
308    
309  C<< my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV); >>      Tracer::SetLevel($newLevel);
310    
311  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.  
312    
313  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.  
314    
315  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  
316    
317      ["Sprout", "SproutLoad", "ERDB"]  Proposed new trace level.
318    
319  This would cause trace messages in the specified three packages to appear in  =back
 the output. There are two 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.  
320    
321  =over 4  =cut
322    
323  =item SQL  sub SetLevel {
324        $TraceLevel = $_[0];
325    }
326    
327  Traces SQL commands and activity.  =head3 ParseDate
328    
329  =item Tracer      my $time = Tracer::ParseDate($dateString);
330    
331  Traces error messages and call stacks.  Convert a date into a PERL time number. This method expects a date-like string
332    and parses it into a number. The string must be vaguely date-like or it will
333    return an undefined value. Our requirement is that a month and day be
334    present and that three pieces of the date string (time of day, month and day,
335    year) be separated by likely delimiters, such as spaces, commas, and such-like.
336    
337  =back  If a time of day is present, it must be in military time with two digits for
338    everything but the hour.
339    
340  C<SQL> is only turned on if the C<-sql> option is specified in the command line.  The year must be exactly four digits.
 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.  
341    
342      TransactFeatures -trace=3 -sql register ../xacts IDs.tbl  Additional stuff can be in the string. We presume it's time zones or weekdays or something
343    equally innocuous. This means, however, that a sufficiently long sentence with date-like
344    parts in it may be interpreted as a date. Hopefully this will not be a problem.
345    
346  Standard tracing is output to the standard output and echoed to the file  It should be guaranteed that this method will parse the output of the L</Now> function.
 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  
347    
348  The default trace level is 2. To get all messages, specify a trace level of 4.  The parameters are as follows.
 For a genome-by-genome update, use 3.  
349    
350      TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl  =over 4
351    
352  would send the trace output to C<traceBruce.log> in the temporary directory.  =item dateString
353    
354  The I<options> parameter is a reference to a hash containing the command-line  The date string to convert.
 options, their default values, and an explanation of what they mean. Command-line  
 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.  
355    
356  You can specify a different default trace level by setting C<$options->{trace}>  =item RETURN
 prior to calling this method.  
357    
358  An example at this point would help. Consider, for example, the command-line utility  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
359  C<TransactFeatures>. It accepts a list of positional parameters plus the options  the date string is invalid. A valid date string must contain a month and day.
 C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute  
 the following code.  
360    
361      my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],  =back
                         { safe => [0, "use database transactions"],  
                           noAlias => [0, "do not expect aliases in CHANGE transactions"],  
                           start => [' ', "start with this genome"],  
                           tblFiles => [0, "output TBL files containing the corrected IDs"] },  
                         "command transactionDirectory IDfile",  
                       @ARGV);  
362    
363    =cut
364    
365  The call to C<ParseCommand> specifies the default values for the options and  # Universal month conversion table.
366  stores the actual options in a hash that is returned as C<$options>. The  use constant MONTHS => {    Jan =>  0, January   =>  0, '01' =>  0,  '1' =>  0,
367  positional parameters are returned in C<@parameters>.                              Feb =>  1, February  =>  1, '02' =>  1,  '2' =>  1,
368                                Mar =>  2, March     =>  2, '03' =>  2,  '3' =>  2,
369                                Apr =>  3, April     =>  3, '04' =>  3,  '4' =>  3,
370                                May =>  4, May       =>  4, '05' =>  4,  '5' =>  4,
371                                Jun =>  5, June      =>  5, '06' =>  5,  '6' =>  5,
372                                Jul =>  6, July      =>  6, '07' =>  6,  '7' =>  6,
373                                Aug =>  7, August    =>  7, '08' =>  7,  '8' =>  7,
374                                Sep =>  8, September =>  8, '09' =>  8,  '9' =>  8,
375                                Oct =>  9, October  =>   9, '10' =>  9,
376                                Nov => 10, November =>  10, '11' => 10,
377                                Dec => 11, December =>  11, '12' => 11
378                            };
379    
380  The following is a sample command line for C<TransactFeatures>.  sub ParseDate {
381        # Get the parameters.
382        my ($dateString) = @_;
383        # Declare the return variable.
384        my $retVal;
385        # Find the month and day of month. There are two ways that can happen. We check for the
386        # numeric style first. That way, if the user's done something like "Sun 12/22", then we
387        # won't be fooled into thinking the month is Sunday.
388        if ($dateString =~ m#\b(\d{1,2})/(\d{1,2})\b# || $dateString =~ m#\b(\w+)\s(\d{1,2})\b#) {
389            my ($mon, $mday) = (MONTHS->{$1}, $2);
390            # Insist that the month and day are valid.
391            if (defined($mon) && $2 >= 1 && $2 <= 31) {
392                # Find the time.
393                my ($hour, $min, $sec) = (0, 0, 0);
394                if ($dateString =~ /\b(\d{1,2}):(\d{2}):(\d{2})\b/) {
395                    ($hour, $min, $sec) = ($1, $2, $3);
396                }
397                # Find the year.
398                my $year;
399                if ($dateString =~ /\b(\d{4})\b/) {
400                    $year = $1;
401                } else {
402                    # Get the default year, which is this one. Note we must convert it to
403                    # the four-digit value expected by "timelocal".
404                    (undef, undef, undef, undef, undef, $year) = localtime();
405                    $year += 1900;
406                }
407                $retVal = timelocal($sec, $min, $hour, $mday, $mon, $year);
408            }
409        }
410        # Return the result.
411        return $retVal;
412    }
413    
414      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl  =head3 LogErrors
415    
416  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional      Tracer::LogErrors($fileName);
 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<Tracer>, and <DocUtils>. C<Tracer> is standard,  
 and C<DocUtils> was included because it came in within the first parameter  
 to this method. The I<$options> hash would be  
417    
418      { trace => 2, sql => 0, safe => 0,  Route the standard error output to a log file.
       noAlias => 1, start => ' ', tblFiles => 0 }  
419    
420  Use of C<StandardSetup> in this way provides a simple way of performing  =over 4
 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.  
421    
422  If the C<background> option is specified on the command line, then the  =item fileName
 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  
423    
424      -user=Bruce -background  Name of the file to receive the error output.
425    
426  then the trace output would go to C<traceBruce.log>, the standard output to  =back
 C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to  
 simplify starting a command in the background.  
427    
428  Finally, if the special option C<-h> is specified, the option names will  =cut
 be traced at level 0 and the program will exit without processing.  
 This provides a limited help capability. For example, if the user enters  
429    
430      TransactFeatures -h  sub LogErrors {
431        # Get the file name.
432        my ($fileName) = @_;
433        # Open the file as the standard error output.
434        open STDERR, '>', $fileName;
435    }
436    
437  he would see the following output.  =head3 Trace
438    
439      TransactFeatures [options] command transactionDirectory IDfile      Trace($message);
         -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  
440    
441  The caller has the option of modifying the tracing scheme by placing a value  Write a trace message to the target location specified in L</TSetup>. If there has not been
442  for C<trace> in the incoming options hash. The default value can be overridden,  any prior call to B<TSetup>.
 or the tracing to the standard output can be turned off by suffixing a minus  
 sign to the trace level. So, for example,  
443    
444      { trace => [0, "tracing level (default 0)"],  =over 4
        ...  
445    
446  would set the default trace level to 0 instead of 2, while  =item message
447    
448      { trace => ["2-", "tracing level (default 2)"],  Message to write.
        ...  
449    
450  would leave the default at 2, but trace only to the log file, not to the  =back
 standard output.  
451    
452  The parameters to this method are as follows.  =cut
453    
454  =over 4  sub Trace {
455        # Get the parameters.
456        my ($message) = @_;
457        # Strip off any line terminators at the end of the message. We will add
458        # new-line stuff ourselves.
459        my $stripped = Strip($message);
460        # Compute the caller information.
461        my ($callPackage, $callFile, $callLine) = caller();
462        my $callFileTitle = basename($callFile);
463        # Check the caller.
464        my $callerInfo = ($callFileTitle ne "Tracer.pm" ? " [$callFileTitle $callLine]" : "");
465        # Get the timestamp.
466        my $timeStamp = Now();
467        # Build the prefix.
468        my $level = $LevelNames[$LastLevel] || "($LastLevel)";
469        my $prefix = "[$timeStamp] [$level] [$LastCategory]$callerInfo";
470        # Format the message.
471        my $formatted = "$prefix $stripped";
472        # Process according to the destination.
473        if ($Destination eq "TEXT") {
474            # Write the message to the standard output.
475            print "$formatted\n";
476        } elsif ($Destination eq "ERROR") {
477            # Write the message to the error output. Here, we want our prefix fields.
478            print STDERR "$formatted\n";
479        } elsif ($Destination eq "WARN") {
480            # Emit the message to the standard error output. It is presumed that the
481            # error logger will add its own prefix fields, the notable exception being
482            # the caller info.
483            print STDERR "$callerInfo$stripped\n";
484        } elsif ($Destination eq "QUEUE") {
485            # Push the message into the queue.
486            push @Queue, "$formatted";
487        } elsif ($Destination eq "HTML") {
488            # Convert the message to HTML and write it to the standard output.
489            my $escapedMessage = CGI::escapeHTML($stripped);
490            print "<p>$timeStamp $LastCategory $LastLevel: $escapedMessage</p>\n";
491        } elsif ($Destination =~ m/^>>/) {
492            # Write the trace message to an output file.
493            open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
494            print TRACING "$formatted\n";
495            close TRACING;
496            # If the Tee flag is on, echo it to the standard output.
497            if ($TeeFlag) {
498                print "$formatted\n";
499            }
500        }
501    }
502    
503  =item categories  =head3 T
504    
505  Reference to a list of tracing category names. These should be names of      my $switch = T($category, $traceLevel);
 packages whose internal workings will need to be debugged to get the  
 command working.  
506    
507  =item options      or
508    
509  Reference to a hash containing the legal options for the current command mapped      my $switch = T($traceLevel);
 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).  
510    
511  =item parmHelp  Return TRUE if the trace level is at or above a specified value and the specified category
512    is active, else FALSE. If no category is specified, the caller's package name is used.
513    
514  A string that vaguely describes the positional parameters. This is used  =over 4
 if the user specifies the C<-h> option.  
515    
516  =item argv  =item category
517    
518  List of command line parameters, including the option switches, which must  Category to which the message belongs. If not specified, the caller's package name is
519  precede the positional parameters and be prefixed by a hyphen.  used.
520    
521    =item traceLevel
522    
523    Relevant tracing level.
524    
525  =item RETURN  =item RETURN
526    
527  Returns a list. The first element of the list is the reference to a hash that  TRUE if a message at the specified trace level would appear in the trace, else FALSE.
 maps the command-line option switches to their values. These will either be the  
 default values or overrides specified on the command line. The remaining  
 elements of the list are the position parameters, in order.  
528    
529  =back  =back
530    
531  =cut  =cut
532    
533  sub StandardSetup {  sub T {
534        # Declare the return variable.
535        my $retVal = 0;
536        # Only proceed if tracing is turned on.
537        if ($Destination ne "NONE") {
538      # Get the parameters.      # Get the parameters.
539      my ($categories, $options, $parmHelp, @argv) = @_;          my ($category, $traceLevel) = @_;
540      # Add the tracing options.          if (!defined $traceLevel) {
541      if (! exists $options->{trace}) {              # Here we have no category, so we need to get the calling package.
542          $options->{trace} = [2, "tracing level"];              # The calling package is normally the first parameter. If it is
543      }              # omitted, the first parameter will be the tracelevel. So, the
544      $options->{sql} = [0, "turn on SQL tracing"];              # first thing we do is shift the so-called category into the
545      $options->{h} = [0, "display command-line options"];              # $traceLevel variable where it belongs.
546      $options->{user} = [$$, "trace log file name suffix"];              $traceLevel = $category;
547      $options->{background} = [0, "spool standard and error output"];              my ($package, $fileName, $line) = caller;
548      # Create a parsing hash from the options hash. The parsing hash              # If there is no calling package, we default to "main".
549      # contains the default values rather than the default value              if (!$package) {
550      # and the description. While we're at it, we'll memorize the                  $category = "main";
     # length of the longest option name.  
     my $longestName = 0;  
     my %parseOptions = ();  
     for my $key (keys %{$options}) {  
         if (length $key > $longestName) {  
             $longestName = length $key;  
         }  
         $parseOptions{$key} = $options->{$key}->[0];  
     }  
     # 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";  
     }  
     # Now we want to set up tracing. First, we need to know if SQL is to  
     # be traced.  
     my @cats = @{$categories};  
     if ($retOptions->{sql}) {  
         push @cats, "SQL";  
     }  
     # Add the default categories.  
     push @cats, "Tracer";  
     # Next, we create the category string by joining the categories.  
     my $cats = join(" ", @cats);  
     # Check to determine whether or not the caller wants to turn off tracing  
     # to the standard output.  
     my $traceLevel = $retOptions->{trace};  
     my $textOKFlag = 1;  
     if ($traceLevel =~ /^(.)-/) {  
         $traceLevel = $1;  
         $textOKFlag = 0;  
     }  
     # 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";  
         }  
         # Close the test file.  
         close TESTTRACE;  
     } else {  
         # Here we can't trace to a file. We trace to the standard output if it's  
         # okay, and the error log otherwise.  
         if ($textOKFlag) {  
             $traceMode = "TEXT";  
551          } else {          } else {
552              $traceMode = "WARN";                  my @cats = split /::/, $package;
553                    $category = $cats[$#cats];
554          }          }
555      }      }
556      # Now set up the tracing.          # Save the category name and level.
557      TSetup("$traceLevel $cats", $traceMode);          $LastCategory = $category;
558      # Check for the "h" option. If it is specified, dump the command-line          $LastLevel = $traceLevel;
559      # options and exit the program.          # Convert it to lower case before we hash it.
560      if ($retOptions->{h}) {          $category = lc $category;
561          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          # Validate the trace level.
562          print "$1 [options] $parmHelp\n";          if (ref $traceLevel) {
563          for my $key (sort keys %{$options}) {              Confess("Bad trace level.");
564              my $name = Pad($key, $longestName, 0, ' ');          } elsif (ref $TraceLevel) {
565              my $desc = $options->{$key}->[1];              Confess("Bad trace config.");
             if ($options->{$key}->[0]) {  
                 $desc .= " (default " . $options->{$key}->[0] . ")";  
             }  
             print "  $name $desc\n";  
566          }          }
567          exit(0);          # Make the check. Note that level 0 shows even if the category is turned off.
568            $retVal = ($traceLevel <= $TraceLevel && ($traceLevel == 0 || $AllTrace || exists $Categories{$category}));
569      }      }
570      # Return the parsed parameters.      # Return the computed result.
571      return ($retOptions, @retParameters);      return $retVal;
572  }  }
573    
574  =head3 Setups  =head3 QTrace
   
 C<< my $count = Tracer::Setups(); >>  
   
 Return the number of times L</TSetup> has been called.  
   
 This method allows for the creation of conditional tracing setups where, for example, we  
 may want to set up tracing if nobody else has done it before us.  
   
 =cut  
575    
576  sub Setups {      my $data = QTrace($format);
     return $SetupCount;  
 }  
577    
578  =head3 Open  Return the queued trace data in the specified format.
579    
580  C<< my $handle = Open($fileHandle, $fileSpec, $message); >>  =over 4
581    
582  Open a file.  =item format
583    
584  The I<$fileSpec> is essentially the second argument of the PERL C<open>  C<html> to format the data as an HTML list, C<text> to format it as straight text.
 function. The mode is specified using Unix-like shell information. So, for  
 example,  
585    
586      Open(\*LOGFILE, '>>/usr/spool/news/twitlog', "Could not open twit log.");  =back
587    
588  would open for output appended to the specified file, and  =cut
589    
590      Open(\*DATASTREAM, "| sort -u >$outputFile", "Could not open $outputFile.");  sub QTrace {
591        # Get the parameter.
592        my ($format) = @_;
593        # Create the return variable.
594        my $retVal = "";
595        # Only proceed if there is an actual queue.
596        if (@Queue) {
597            # Process according to the format.
598            if ($format =~ m/^HTML$/i) {
599                # Convert the queue into an HTML list.
600                $retVal = "<ul>\n";
601                for my $line (@Queue) {
602                    my $escapedLine = CGI::escapeHTML($line);
603                    $retVal .= "<li>$escapedLine</li>\n";
604                }
605                $retVal .= "</ul>\n";
606            } elsif ($format =~ m/^TEXT$/i) {
607                # Convert the queue into a list of text lines.
608                $retVal = join("\n", @Queue) . "\n";
609            }
610            # Clear the queue.
611            @Queue = ();
612        }
613        # Return the formatted list.
614        return $retVal;
615    }
616    
617  would open a pipe that sorts the records written and removes duplicates. Note  =head3 Confess
 the use of file handle syntax in the Open call. To use anonymous file handles,  
 code as follows.  
618    
619      my $logFile = Open(undef, '>>/usr/spool/news/twitlog', "Could not open twit log.");      Confess($message);
620    
621  The I<$message> parameter is used if the open fails. If it is set to C<0>, then  Trace the call stack and abort the program with the specified message. When used with
622  the open returns TRUE if successful and FALSE if an error occurred. Otherwise, a  the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.
623  failed open will throw an exception and the third parameter will be used to construct  So, for example
 an error message. If the parameter is omitted, a standard message is constructed  
 using the file spec.  
624    
625      Could not open "/usr/spool/news/twitlog"      Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
626    
627  Note that the mode characters are automatically cleaned from the file name.  Will abort the program with a stack trace if the value of C<$recNum> is negative.
 The actual error message from the file system will be captured and appended to the  
 message in any case.  
628    
629      Could not open "/usr/spool/news/twitlog": file not found.  =over 4
630    
631  In some versions of PERL the only error message we get is a number, which  =item message
 corresponds to the C++ C<errno> value.  
632    
633      Could not open "/usr/spool/news/twitlog": 6.  Message to include in the trace.
634    
635  =over 4  =back
636    
637  =item fileHandle  =cut
638    
639  File handle. If this parameter is C<undef>, a file handle will be generated  sub Confess {
640  and returned as the value of this method.      # Get the parameters.
641        my ($message) = @_;
642        # Set up the category and level.
643        $LastCategory = "(confess)";
644        $LastLevel = 0;
645        if (! defined($FIG_Config::no_tool_hdr)) {
646            # Here we have a tool header. Display its length so that the user can adjust the line numbers.
647            my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
648            # Only proceed if the tool header file is actually present.
649            if (-f $toolHeaderFile) {
650                my $fh;
651                if (open $fh, "<$toolHeaderFile") {
652                    my @lines = <$fh>;
653                    Trace("Tool header has " . scalar(@lines) . " lines.");
654                }
655            }
656        }
657        # Trace the call stack.
658        Cluck($message);
659        # Abort the program.
660        croak(">>> $message");
661    }
662    
663  =item fileSpec  =head3 Warn
664    
665  File name and mode, as per the PERL C<open> function.      Warn($message);
666    
667  =item message (optional)  This method traces an important message. If an RSS feed is configured
668    (via I<FIG_Config::error_feed>) and the tracing destination is C<WARN>,
669    then the message will be echoed to the feed. In general, a tracing
670    destination of C<WARN> indicates that the caller is running as a web
671    service in a production environment; however, this is not a requirement.
672    
673    The L</Cluck> method calls this one for its final message. Since
674    L</Confess> calls L</Cluck>, this means that any error which is caught
675    and confessed will put something in the feed. This insures that someone
676    will be alerted relatively quickly when a failure occurs.
677    
678  Error message to use if the open fails. If omitted, a standard error message  =over 4
 will be generated. In either case, the error information from the file system  
 is appended to the message. To specify a conditional open that does not throw  
 an error if it fails, use C<0>.  
679    
680  =item RETURN  =item message
681    
682  Returns the name of the file handle assigned to the file, or C<undef> if the  Message to be traced.
 open failed.  
683    
684  =back  =back
685    
686  =cut  =cut
687    
688  sub Open {  sub Warn {
689      # Get the parameters.      # Get the parameters.
690      my ($fileHandle, $fileSpec, $message) = @_;      my ($message) = @_;
691      # Attempt to open the file.      # Trace the message.
692      my $rv = open $fileHandle, $fileSpec;      Trace($message);
693      # If the open failed, generate an error message.      # An error here would be disastrous. Note, however, that we aren't too worried
694      if (! $rv) {      # about losing events. The error log is always available for the occasions where
695          # Save the system error message.      # we mess up.
696          my $sysMessage = $!;      eval {
697          # See if we need a default message.          # Do we need to put this in the RSS feed?
698          if (!$message) {          if ($FIG_Config::error_feed && $Destination eq 'WARN') {
699              # Clean any obvious mode characters and leading spaces from the              # Yes. We now need to compute the date, the link, and the title.
700              # filename.              # First, the date, in a very specific format.
701              my ($fileName) = FindNamePart($fileSpec);              my $date = strftime("%a, %02e %b %H:%M:%S %Y ", localtime) .
702              $message = "Could not open \"$fileName\"";                  (tz_local_offset() / 30);
703                # Environment data goes in here.
704                my $environment;
705                # HTML-escape the message and remove excess space.
706                my $title = CGI::escapeHTML($message);
707                $title =~ s/\s+/ /gs;
708                # Compute the title from the message. If it's too long, we have to
709                # split it up.
710                if (length $title > 60) {
711                    $title = substr($title, 0, 50) . "...";
712                }
713                # We'll put the link in here.
714                my $link;
715                # If we have a CGI object, then this is a web error. Otherwise, it's
716                # command-line.
717                if (defined $SavedCGI) {
718                    # We're in a web service. The environment is the user's IP, and the link
719                    # is the URL that got us here.
720                    my $key = $ENV{HTTP_X_FORWARDED_FOR} || $ENV{REMOTE_ADDR};
721                    $environment = "Event Reported at IP address $key.";
722                    $link = $SavedCGI->url(-full => 1, -query => 1);
723                    # We need the user agent string and (if available) the referrer.
724                    $environment .= "User Agent $ENV{HTTP_USER_AGENT}";
725                    if ($ENV{HTTP_REFERER}) {
726                        $environment .= " referred from $ENV{HTTP_REFERER}"
727                    }
728                    # Close off the sentence.
729                    $environment .= ". ";
730                } else {
731                    # No CGI object, so we're a command-line tool. Use the tracing
732                    # key and the PID as the user identifier, and add the command.
733                    my $key = EmergencyKey();
734                    $environment = "Event Reported by $key Process $$. Command $ENV{_}.";
735                    # Set the link to the development NMPDR. There is really no good
736                    # choice here.
737                    $link = "http://$FIG_Config::dev_server";
738                }
739                # Build a GUID. We use the current time, the title, and the process ID,
740                # then digest the result.
741                my $guid = Digest::MD5::md5_base64(gettimeofday(), $title, $$);
742                # Finally, the description. This is a stack trace plus various environmental stuff.
743                # We have a goofy thing here in that we need to HTML-escape some sections of the description
744                # twice. They will be unescaped once when processed by the RSS reader. First, the stack
745                # trace.
746                my $stackTrace = "";
747                my @trace = LongMess();
748                # Only proceed if we got something back.
749                if (scalar(@trace) > 0) {
750                    $trace[0] =~ s/Tracer::Warn.+?called/Event occurred/;
751                    $stackTrace = "Stack trace:<pre>" . join("\n", @trace, "</pre>");
752                }
753                my $basicDescription = CGI::escapeHTML($message) . "<br /><br />" .
754                        CGI::escapeHTML($environment) . $stackTrace;
755                # Okay, we have all the pieces. Create a hash of the new event.
756                my $newItem = { title => $title,
757                                description => CGI::escapeHTML($basicDescription),
758                                link => $link,
759                                category => $LastCategory,
760                                pubDate => $date,
761                                guid => $guid,
762                               };
763                # We need XML capability for this.
764                require XML::Simple;
765                # The RSS document goes in here.
766                my $rss;
767                # Get the name of the RSS file. It's in the FIG temporary directory.
768                my $fileName = "$FIG_Config::temp/$FIG_Config::error_feed";
769                # Does it exist?
770                if (-s $fileName) {
771                    # Slurp it in.
772                    $rss = XML::Simple::XMLin($fileName, ForceArray => ['item']);
773                } else {
774                    my $size = -s $fileName;
775                    # Create an empty channel.
776                    $rss = {
777                        channel => {
778                            title => 'NMPDR Warning Feed',
779                            link => "$FIG_Config::temp_url/$FIG_Config::error_feed",
780                            description => "Important messages regarding the status of the NMPDR.",
781                            generator => "NMPDR Trace Facility",
782                            docs => "http://blogs.law.harvard.edu/tech/rss",
783                            item => []
784                        },
785                    };
786          }          }
787          # Terminate with an error using the supplied message and the              # Get the channel object.
788          # error message from the file system.              my $channel = $rss->{channel};
789          Confess("$message: $!");              # Update the last-build date.
790                $channel->{lastBuildDate} = $date;
791                # Get the item array.
792                my $items = $channel->{item};
793                # Insure it has only 100 entries.
794                while (scalar @{$items} > 100) {
795                    pop @{$items};
796                }
797                # Add our new item at the front.
798                unshift @{$items}, $newItem;
799                # Replace the file.
800                my $xml = XML::Simple::XMLout($rss, NoAttr => 1, RootName => 'rss version="2.0"', XmlDecl => '<?xml version="1.0" encoding="utf-8"?>',
801                                              NoEscape => 1);
802                # We don't use Open here because we can't afford an error.
803                if (open XMLOUT, ">$fileName") {
804                    print XMLOUT $xml;
805                    close XMLOUT;
806      }      }
807      # Return the file handle.          }
808      return $fileHandle;      };
809        # There's no "if ($@)" here, because putting an error message in the log
810        # saying that we missed putting an error message in the feed of messages
811        # in the log is not going to help anybody.
812  }  }
813    
814  =head3 FindNamePart  =head3 Assert
815    
816  C<< my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec); >>      Assert($condition1, $condition2, ... $conditionN);
817    
818  Extract the portion of a file specification that contains the file name.  Return TRUE if all the conditions are true. This method can be used in conjunction with
819    the OR operator and the L</Confess> method as a debugging assert.
820    So, for example
821    
822  A file specification is the string passed to an C<open> call. It specifies the file      Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
 mode and name. In a truly complex situation, it can specify a pipe sequence. This  
 method assumes that the file name is whatever follows the first angle bracket  
 sequence.  So, for example, in the following strings the file name is  
 C</usr/fig/myfile.txt>.  
823    
824      >>/usr/fig/myfile.txt  Will abort the program with a stack trace if the value of C<$recNum> is negative.
     </usr/fig/myfile.txt  
     | sort -u > /usr/fig/myfile.txt  
825    
826  If the method cannot find a file name using its normal methods, it will return the  =cut
827  whole incoming string.  sub Assert {
828        my $retVal = 1;
829        LOOP: for my $condition (@_) {
830            if (! $condition) {
831                $retVal = 0;
832                last LOOP;
833            }
834        }
835        return $retVal;
836    }
837    
838  =over 4  =head3 Cluck
839    
840  =item fileSpec      Cluck($message);
841    
842  File specification string from which the file name is to be extracted.  Trace the call stack. Note that for best results, you should qualify the call with a
843    trace condition. For example,
844    
845  =item RETURN      Cluck("Starting record parse.") if T(3);
846    
847  Returns a three-element list. The first element contains the file name portion of  will only trace the stack if the trace level for the package is 3 or more.
848  the specified string, or the whole string if a file name cannot be found via normal  
849  methods. The second element contains the start position of the file name portion and  =over 4
850  the third element contains the length.  
851    =item message
852    
853    Message to include in the trace.
854    
855  =back  =back
856    
857  =cut  =cut
858  #: Return Type $;  
859  sub FindNamePart {  sub Cluck {
860      # Get the parameters.      # Get the parameters.
861      my ($fileSpec) = @_;      my ($message) = @_;
862      # Default to the whole input string.      # Trace what's happening.
863      my ($retVal, $pos, $len) = ($fileSpec, 0, length $fileSpec);      Trace("Stack trace for event: $message");
864      # Parse out the file name if we can.      # Get the stack trace.
865      if ($fileSpec =~ m/(<|>>?)(.+?)(\s*)$/) {      my @trace = LongMess();
866          $retVal = $2;      # Convert the trace to a series of messages.
867          $len = length $retVal;      for my $line (@trace) {
868          $pos = (length $fileSpec) - (length $3) - $len;          # Replace the tab at the beginning with spaces.
869            $line =~ s/^\t/    /;
870            # Trace the line.
871            Trace($line);
872      }      }
873      # Return the result.      # Issue a warning. This displays the event message and inserts it into the RSS error feed.
874      return ($retVal, $pos, $len);      Warn($message);
875  }  }
876    
877  =head3 OpenDir  =head3 LongMess
878    
879  C<< my @files = OpenDir($dirName, $filtered, $flag); >>      my @lines = Tracer::LongMess();
880    
881  Open a directory and return all the file names. This function essentially performs  Return a stack trace with all tracing methods removed. The return will be in the form of a list
882  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is  of message strings.
 set to TRUE, all filenames beginning with a period (C<.>), dollar sign (C<$>),  
 or pound sign (C<#>) and all filenames ending with a tilde C<~>) will be  
 filtered out of the return list. If the directory does not open and I<$flag> is not  
 set, an exception is thrown. So, for example,  
883    
884      my @files = OpenDir("/Volumes/fig/contigs", 1);  =cut
885    
886  is effectively the same as  sub LongMess {
887        # Declare the return variable.
888        my @retVal = ();
889        my $confession = longmess("");
890        for my $line (split /\s*\n/, $confession) {
891            unless ($line =~ /Tracer\.pm/) {
892                # Here we have a line worth keeping. Push it onto the result list.
893                push @retVal, $line;
894            }
895        }
896        # Return the result.
897        return @retVal;
898    }
899    
900      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");  =head3 ScriptSetup (deprecated)
     my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);  
901    
902  Similarly, the following code      my ($cgi, $varHash) = ScriptSetup($noTrace);
903    
904      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);  Perform standard tracing and debugging setup for scripts. The value returned is
905    the CGI object followed by a pre-built variable hash. At the end of the script,
906    the client should call L</ScriptFinish> to output the web page.
907    
908  Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and  This method calls L</ETracing> to configure tracing, which allows the tracing
909  automatically returns an empty list if the directory fails to open.  to be configured via the emergency tracing form on the debugging control panel.
910    Tracing will then be turned on automatically for all programs that use the L</ETracing>
911    method, which includes every program that uses this method or L</StandardSetup>.
912    
913  =over 4  =over 4
914    
915  =item dirName  =item noTrace (optional)
   
 Name of the directory to open.  
   
 =item filtered  
916    
917  TRUE if files whose names begin with a period (C<.>) should be automatically removed  If specified, tracing will be suppressed. This is useful if the script wants to set up
918  from the list, else FALSE.  tracing manually.
919    
920  =item flag  =item RETURN
921    
922  TRUE if a failure to open is okay, else FALSE  Returns a two-element list consisting of a CGI query object and a variable hash for
923    the output page.
924    
925  =back  =back
926    
927  =cut  =cut
928  #: Return Type @;  
929  sub OpenDir {  sub ScriptSetup {
930      # Get the parameters.      # Get the parameters.
931      my ($dirName, $filtered, $flag) = @_;      my ($noTrace) = @_;
932      # Declare the return variable.      # Get the CGI query object.
933      my @retVal = ();      my $cgi = CGI->new();
934      # Open the directory.      # Set up tracing if it's not suppressed.
935      if (opendir(my $dirHandle, $dirName)) {      ETracing($cgi) unless $noTrace;
936          # The directory opened successfully. Get the appropriate list according to the      # Create the variable hash.
937          # strictures of the filter parameter.      my $varHash = { results => '' };
938          if ($filtered) {      # Return the query object and variable hash.
939              @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;      return ($cgi, $varHash);
         } else {  
             @retVal = readdir $dirHandle;  
         }  
     } elsif (! $flag) {  
         # Here the directory would not open and it's considered an error.  
         Confess("Could not open directory $dirName.");  
     }  
     # Return the result.  
     return @retVal;  
940  }  }
941    
942  =head3 SetLevel  =head3 ETracing
943    
944  C<< Tracer::SetLevel($newLevel); >>      ETracing($parameter);
945    
946  Modify the trace level. A higher trace level will cause more messages to appear.  Set up emergency tracing. Emergency tracing is tracing that is turned
947    on automatically for any program that calls this method. The emergency
948    tracing parameters are stored in a a file identified by a tracing key.
949    If this method is called with a CGI object, then the tracing key is
950    taken from a cookie. If it is called with no parameters, then the tracing
951    key is taken from an environment variable. If it is called with a string,
952    the tracing key is that string.
953    
954  =over 4  =over 4
955    
956  =item newLevel  =item parameter
957    
958  Proposed new trace level.  A parameter from which the tracing key is computed. If it is a scalar,
959    that scalar is used as the tracing key. If it is a CGI object, the
960    tracing key is taken from the C<IP> cookie. If it is omitted, the
961    tracing key is taken from the C<TRACING> environment variable. If it
962    is a CGI object and emergency tracing is not on, the C<Trace> and
963    C<TF> parameters will be used to determine the type of tracing.
964    
965  =back  =back
966    
967  =cut  =cut
968    
969  sub SetLevel {  sub ETracing {
970      $TraceLevel = $_[0];      # Get the parameter.
971        my ($parameter) = @_;
972        # Check for CGI mode.
973        if (defined $parameter && ref $parameter eq 'CGI') {
974            $SavedCGI = $parameter;
975        } else {
976            $SavedCGI = undef;
977        }
978        # Default to no tracing except errors.
979        my ($tracing, $dest) = ("0", "WARN");
980        # Check for emergency tracing.
981        my $tkey = EmergencyKey($parameter);
982        my $emergencyFile = EmergencyFileName($tkey);
983        if (-e $emergencyFile) {
984            # We have the file. Read in the data.
985            my @tracing = GetFile($emergencyFile);
986            # Pull off the time limit.
987            my $expire = shift @tracing;
988            # Convert it to seconds.
989            $expire *= 3600;
990            # Check the file data.
991            my $stat = stat($emergencyFile);
992            my ($now) = gettimeofday;
993            if ($now - $stat->mtime > $expire) {
994                # Delete the expired file.
995                unlink $emergencyFile;
996            } else {
997                # Emergency tracing is on. Pull off the destination and
998                # the trace level;
999                $dest = shift @tracing;
1000                my $level = shift @tracing;
1001                # Convert the destination to a real tracing destination.
1002                # temp directory.
1003                $dest = EmergencyTracingDest($tkey, $dest);
1004                # Insure Tracer is specified.
1005                my %moduleHash = map { $_ => 1 } @tracing;
1006                $moduleHash{Tracer} = 1;
1007                # Set the trace parameter.
1008                $tracing = join(" ", $level, sort keys %moduleHash);
1009            }
1010        } elsif (defined $SavedCGI) {
1011            # There's no emergency tracing, but we have a CGI object, so check
1012            # for tracing from the form parameters.
1013            if ($SavedCGI->param('Trace')) {
1014                # Here the user has requested tracing via a form.
1015                $dest = ($SavedCGI->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
1016                $tracing = $SavedCGI->param('Trace') . " Tracer";
1017            }
1018        }
1019        # Setup the tracing we've determined from all the stuff above.
1020        TSetup($tracing, $dest);
1021        # Check to see if we're a web script.
1022        if (defined $SavedCGI) {
1023            # Yes we are. Trace the form and environment data.
1024            TraceParms($SavedCGI);
1025            # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1026            # emitted by the script in its raw form.
1027            if (T(Raw => 3)) {
1028                print CGI::header(-type => 'text/plain', -tracing => 'Raw');
1029  }  }
   
 =head3 Now  
   
 C<< my $string = Tracer::Now(); >>  
   
 Return a displayable time stamp containing the local time.  
   
 =cut  
   
 sub Now {  
     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);  
     my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .  
                  _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);  
     return $retVal;  
1030  }  }
   
 # Pad a number to 2 digits.  
 sub _p2 {  
     my ($value) = @_;  
     $value = "0$value" if ($value < 10);  
     return $value;  
1031  }  }
1032    
1033  =head3 LogErrors  =head3 EmergencyFileName
1034    
1035  C<< Tracer::LogErrors($fileName); >>      my $fileName = Tracer::EmergencyFileName($tkey);
1036    
1037  Route the standard error output to a log file.  Return the emergency tracing file name. This is the file that specifies
1038    the tracing information.
1039    
1040  =over 4  =over 4
1041    
1042  =item fileName  =item tkey
1043    
1044  Name of the file to receive the error output.  Tracing key for the current program.
1045    
1046    =item RETURN
1047    
1048    Returns the name of the file to contain the emergency tracing information.
1049    
1050  =back  =back
1051    
1052  =cut  =cut
1053    
1054  sub LogErrors {  sub EmergencyFileName {
1055      # Get the file name.      # Get the parameters.
1056      my ($fileName) = @_;      my ($tkey) = @_;
1057      # Open the file as the standard error output.      # Compute the emergency tracing file name.
1058      open STDERR, '>', $fileName;      return "$FIG_Config::temp/Emergency$tkey.txt";
1059  }  }
1060    
1061  =head3 ReadOptions  =head3 EmergencyFileTarget
   
 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  
1062    
1063  I<optionName>C<=>I<optionValue>C<; >I<comment>      my $fileName = Tracer::EmergencyFileTarget($tkey);
1064    
1065  The option name must consist entirely of letters, digits, and the punctuation characters  Return the emergency tracing target file name. This is the file that receives
1066  C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank  the tracing output for file-based tracing.
 character is a semi-colon will be ignored. The return hash will map each option name to  
 the corresponding option value.  
1067    
1068  =over 4  =over 4
1069    
1070  =item fileName  =item tkey
1071    
1072  Name of the file containing the option data.  Tracing key for the current program.
1073    
1074  =item RETURN  =item RETURN
1075    
1076  Returns a hash mapping the option names specified in the file to their corresponding option  Returns the name of the file to contain the trace output.
 value.  
1077    
1078  =back  =back
1079    
1080  =cut  =cut
1081    
1082  sub ReadOptions {  sub EmergencyFileTarget {
1083      # Get the parameters.      # Get the parameters.
1084      my ($fileName) = @_;      my ($tkey) = @_;
1085      # Open the file.      # Compute the emergency tracing file name.
1086      (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");      return "$FIG_Config::temp/trace$tkey.log";
     # Count the number of records read.  
     my ($records, $comments) = 0;  
     # Create the return hash.  
     my %retVal = ();  
     # Loop through the file, accumulating key-value pairs.  
     while (my $line = <CONFIGFILE>) {  
         # Denote we've read a line.  
         $records++;  
         # Determine the line type.  
         if ($line =~ /^\s*[\n\r]/) {  
             # A blank line is a comment.  
             $comments++;  
         } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {  
             # Here we have an option assignment.  
             retVal{$1} = $2;  
         } elsif ($line =~ /^\s*;/) {  
             # Here we have a text comment.  
             $comments++;  
         } else {  
             # Here we have an invalid line.  
             Trace("Invalid option statement in record $records.") if T(0);  
         }  
     }  
     # Return the hash created.  
     return %retVal;  
1087  }  }
1088    
1089  =head3 GetOptions  =head3 EmergencyTracingDest
1090    
1091  C<< Tracer::GetOptions(\%defaults, \%options); >>      my $dest = Tracer::EmergencyTracingDest($tkey, $myDest);
1092    
1093  Merge a specified set of options into a table of defaults. This method takes two hash references  This method converts an emergency tracing destination to a real
1094  as input and uses the data from the second to update the first. If the second does not exist,  tracing destination. The main difference is that if the
1095  there will be no effect. An error will be thrown if one of the entries in the second hash does not  destination is C<FILE> or C<APPEND>, we convert it to file
1096  exist in the first.  output. If the destination is C<DUAL>, we convert it to file
1097    and standard output.
1098    
1099  Consider the following example.  =over 4
1100    
1101  C<< my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options); >>  =item tkey
1102    
1103  In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and  Tracing key for this environment.
 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  
1104    
1105  C<< {databaseType => 'Oracle'} >>  =item myDest
1106    
1107  an error will occur because the B<databaseType> option does not exist.  Destination from the emergency tracing file.
1108    
1109  =over 4  =item RETURN
1110    
1111  =item defaults  Returns a destination that can be passed into L</TSetup>.
1112    
1113  Table of default option values.  =back
1114    
1115  =item options  =cut
1116    
1117  Table of overrides, if any.  sub EmergencyTracingDest {
1118        # Get the parameters.
1119        my ($tkey, $myDest) = @_;
1120        # Declare the return variable.
1121        my $retVal = $myDest;
1122        # Process according to the destination value.
1123        if ($myDest eq 'FILE') {
1124            $retVal = ">" . EmergencyFileTarget($tkey);
1125        } elsif ($myDest eq 'APPEND') {
1126            $retVal = ">>" . EmergencyFileTarget($tkey);
1127        } elsif ($myDest eq 'DUAL') {
1128            $retVal = "+>" . EmergencyFileTarget($tkey);
1129        } elsif ($myDest eq 'WARN') {
1130            $retVal = "WARN";
1131        }
1132        # Return the result.
1133        return $retVal;
1134    }
1135    
1136  =item RETURN  =head3 Emergency
1137    
1138  Returns a reference to the default table passed in as the first parameter.      Emergency($key, $hours, $dest, $level, @modules);
1139    
1140    Turn on emergency tracing. This method is normally invoked over the web from
1141    a debugging console, but it can also be called by the C<trace.pl> script.
1142    The caller specifies the duration of the emergency in hours, the desired tracing
1143    destination, the trace level, and a list of the trace modules to activate.
1144    For the length of the duration, when a program in an environment with the
1145    specified tracing key active invokes a Sprout CGI script, tracing will be
1146    turned on automatically. See L</TSetup> for more about tracing setup and
1147    L</ETracing> for more about emergency tracing.
1148    
1149    =over 4
1150    
1151    =item tkey
1152    
1153    The tracing key. This is used to identify the control file and the trace file.
1154    
1155    =item hours
1156    
1157    Number of hours to keep emergency tracing alive.
1158    
1159    =item dest
1160    
1161    Tracing destination. If no path information is specified for a file
1162    destination, it is put in the FIG temporary directory.
1163    
1164    =item level
1165    
1166    Tracing level. A higher level means more trace messages.
1167    
1168    =item modules
1169    
1170    A list of the tracing modules to activate.
1171    
1172  =back  =back
1173    
1174  =cut  =cut
1175    
1176  sub GetOptions {  sub Emergency {
1177      # Get the parameters.      # Get the parameters.
1178      my ($defaults, $options) = @_;      my ($tkey, $hours, $dest, $level, @modules) = @_;
1179      # Check for overrides.      # Create the emergency file.
1180      if ($options) {      my $specFile = EmergencyFileName($tkey);
1181          # Loop through the overrides.      my $outHandle = Open(undef, ">$specFile");
1182          while (my ($option, $setting) = each %{$options}) {      print $outHandle join("\n", $hours, $dest, $level, @modules, "");
             # Insure this override exists.  
             if (!exists $defaults->{$option}) {  
                 croak "Unrecognized option $option encountered.";  
             } else {  
                 # Apply the override.  
                 $defaults->{$option} = $setting;  
             }  
         }  
     }  
     # Return the merged table.  
     return $defaults;  
1183  }  }
1184    
1185  =head3 MergeOptions  =head3 EmergencyKey
1186    
1187  C<< Tracer::MergeOptions(\%table, \%defaults); >>      my $tkey = EmergencyKey($parameter);
1188    
1189  Merge default values into a hash table. This method looks at the key-value pairs in the  Return the Key to be used for emergency tracing. This could be an IP address,
1190  second (default) hash, and if a matching key is not found in the first hash, the default   a session ID, or a user name, depending on the environment.
 pair is copied in. The process is similar to L</GetOptions>, but there is no error-  
 checking and no return value.  
1191    
1192  =over 4  =over 4
1193    
1194  =item table  =item parameter
1195    
1196  Hash table to be updated with the default values.  Parameter defining the method for finding the tracing key. If it is a scalar,
1197    then it is presumed to be the tracing key itself. If it is a CGI object, then
1198    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
1199    taken from the C<TRACING> environment variable.
1200    
1201  =item defaults  =item RETURN
1202    
1203  Default values to be merged into the first hash table if they are not already present.  Returns the key to be used for labels in emergency tracing.
1204    
1205  =back  =back
1206    
1207  =cut  =cut
1208    
1209  sub MergeOptions {  sub EmergencyKey {
1210      # Get the parameters.      # Get the parameters.
1211      my ($table, $defaults) = @_;      my ($parameter) = @_;
1212      # Loop through the defaults.      # Declare the return variable.
1213      while (my ($key, $value) = each %{$defaults}) {      my $retVal;
1214          if (!exists $table->{$key}) {      # Determine the parameter type.
1215              $table->{$key} = $value;      if (! defined $parameter) {
1216          }          # Here we're supposed to check the environment. If that fails, we
1217            # get the effective login ID.
1218            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1219        } else {
1220            my $ptype = ref $parameter;
1221            if ($ptype eq 'CGI') {
1222                # Here we were invoked from a web page. Look for a cookie.
1223                $retVal = $parameter->cookie('IP');
1224            } elsif (! $ptype) {
1225                # Here the key was passed in.
1226                $retVal = $parameter;
1227            }
1228        }
1229        # If no luck finding a key, use the PID.
1230        if (! defined $retVal) {
1231            $retVal = $$;
1232      }      }
1233        # Return the result.
1234        return $retVal;
1235  }  }
1236    
 =head3 Trace  
1237    
1238  C<< Trace($message); >>  =head3 TraceParms
1239    
1240        Tracer::TraceParms($cgi);
1241    
1242  Write a trace message to the target location specified in L</TSetup>. If there has not been  Trace the CGI parameters at trace level CGI => 3 and the environment variables
1243  any prior call to B<TSetup>.  at level CGI => 4. A self-referencing URL is traced at level CGI => 2.
1244    
1245  =over 4  =over 4
1246    
1247  =item message  =item cgi
1248    
1249  Message to write.  CGI query object containing the parameters to trace.
1250    
1251  =back  =back
1252    
1253  =cut  =cut
1254    
1255  sub Trace {  sub TraceParms {
1256      # Get the parameters.      # Get the parameters.
1257      my ($message) = @_;      my ($cgi) = @_;
1258      # Get the timestamp.      if (T(CGI => 2)) {
1259      my $timeStamp = Now();          # Here we trace the GET-style URL for the script.
1260      # Format the message. Note we strip off any line terminators at the end.          Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));
1261      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);      }
1262      # Process according to the destination.      if (T(CGI => 3)) {
1263      if ($Destination eq "TEXT") {          # Here we want to trace the parameter data.
1264          # Write the message to the standard output.          my @names = $cgi->param;
1265          print "$formatted\n";          for my $parmName (sort @names) {
1266      } elsif ($Destination eq "ERROR") {              # Note we skip the Trace parameters, which are for our use only.
1267          # Write the message to the error output.              if ($parmName ne 'Trace' && $parmName ne 'TF') {
1268          print STDERR "$formatted\n";                  my @values = $cgi->param($parmName);
1269      } elsif ($Destination eq "QUEUE") {                  Trace("[CGI] $parmName = " . join(", ", @values));
1270          # Push the message into the queue.              }
1271          push @Queue, "$formatted";          }
1272      } elsif ($Destination eq "HTML") {          # Display the request method.
1273          # Convert the message to HTML and write it to the standard output.          my $method = $cgi->request_method();
1274          my $escapedMessage = CGI::escapeHTML($message);          Trace("Method: $method");
1275          print "<p>$formatted</p>\n";      }
1276      } elsif ($Destination eq "WARN") {      if (T(CGI => 4)) {
1277         # Emit the message as a warning.          # Here we want the environment data too.
1278         warn $message;          for my $envName (sort keys %ENV) {
1279      } elsif ($Destination =~ m/^>>/) {              Trace("[ENV] $envName = $ENV{$envName}");
         # 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";  
1280          }          }
1281      }      }
1282  }  }
1283    
1284  =head3 T  =head3 TraceImages
1285    
1286  C<< my $switch = T($category, $traceLevel); >>      Tracer::TraceImages($htmlString);
1287    
1288      or  Trace information about all of an html document's images. The tracing
1289    will be for type "IMG" at level 3. The image's source string
1290    will be displayed. This is generally either the URL of the image or
1291    raw data for the image itself. If the source is too long, only the first 300
1292    characters will be shown at trace level 3. The entire source will be shown,
1293    however, at trace level 4. This method is not very smart, and might catch
1294    Javascript code, but it is still useful when debugging the arcane
1295    behavior of images in multiple browser environments.
1296    
1297  C<< my $switch = T($traceLevel); >>  =over 4
1298    
1299  Return TRUE if the trace level is at or above a specified value and the specified category  =item htmlString
 is active, else FALSE. If no category is specified, the caller's package name is used.  
1300    
1301  =over 4  HTML text for an outgoing web page.
1302    
1303  =item category  =back
1304    
1305  Category to which the message belongs. If not specified, the caller's package name is  =cut
 used.  
1306    
1307  =item traceLevel  sub TraceImages {
1308        # Only proceed if we're at the proper trace level.
1309        if (T(IMG => 3)) {
1310            # For performance reasons we're manipulating $_[0] instead of retrieving the string
1311            # into a variable called "$htmlString". This is because we expect html strings to be
1312            # long, and don't want to copy them any more than we have to.
1313            Trace(length($_[0]) . " characters in web page.");
1314            # Loop through the HTML, culling image tags.
1315            while ($_[0] =~ /<img\s+[^>]+?src="([^"]+)"/sgi) {
1316                # Extract the source string and determine whether or not it's too long.
1317                my $srcString = $1;
1318                my $pos = pos($_[0]) - length($srcString);
1319                my $excess = length($srcString) - 300;
1320                # We'll put the display string in here.
1321                my $srcDisplay = $srcString;
1322                # If it's a data string, split it at the comma.
1323                $srcDisplay =~ s/^(data[^,]+,)/$1\n/;
1324                # If there's no excess or we're at trace level 4, we're done. At level 3 with
1325                # a long string, however, we only show the first 300 characters.
1326                if ($excess > 0 && ! T(IMG => 4)) {
1327                    $srcDisplay = substr($srcDisplay,0,300) . "\nplus $excess characters.";
1328                }
1329                # Output the trace message.
1330                Trace("Image tag at position $pos:\n$srcDisplay");
1331            }
1332        }
1333    }
1334    
 Relevant tracing level.  
1335    
1336  =item RETURN  =head3 ScriptFinish (deprecated)
1337    
1338  TRUE if a message at the specified trace level would appear in the trace, else FALSE.      ScriptFinish($webData, $varHash);
1339    
1340    Output a web page at the end of a script. Either the string to be output or the
1341    name of a template file can be specified. If the second parameter is omitted,
1342    it is assumed we have a string to be output; otherwise, it is assumed we have the
1343    name of a template file. The template should have the variable C<DebugData>
1344    specified in any form that invokes a standard script. If debugging mode is turned
1345    on, a form field will be put in that allows the user to enter tracing data.
1346    Trace messages will be placed immediately before the terminal C<BODY> tag in
1347    the output, formatted as a list.
1348    
1349    A typical standard script would loook like the following.
1350    
1351        BEGIN {
1352            # Print the HTML header.
1353            print "CONTENT-TYPE: text/html\n\n";
1354        }
1355        use Tracer;
1356        use CGI;
1357        use FIG;
1358        # ... more uses ...
1359    
1360        my ($cgi, $varHash) = ScriptSetup();
1361        eval {
1362            # ... get data from $cgi, put it in $varHash ...
1363        };
1364        if ($@) {
1365            Trace("Script Error: $@") if T(0);
1366        }
1367        ScriptFinish("Html/MyTemplate.html", $varHash);
1368    
1369    The idea here is that even if the script fails, you'll see trace messages and
1370    useful output.
1371    
1372    =over 4
1373    
1374    =item webData
1375    
1376    A string containing either the full web page to be written to the output or the
1377    name of a template file from which the page is to be constructed. If the name
1378    of a template file is specified, then the second parameter must be present;
1379    otherwise, it must be absent.
1380    
1381    =item varHash (optional)
1382    
1383    If specified, then a reference to a hash mapping variable names for a template
1384    to their values. The template file will be read into memory, and variable markers
1385    will be replaced by data in this hash reference.
1386    
1387  =back  =back
1388    
1389  =cut  =cut
1390    
1391  sub T {  sub ScriptFinish {
     # Declare the return variable.  
     my $retVal = 0;  
     # Only proceed if tracing is turned on.  
     if ($Destination ne "NONE") {  
1392          # Get the parameters.          # Get the parameters.
1393          my ($category, $traceLevel) = @_;      my ($webData, $varHash) = @_;
1394          if (!defined $traceLevel) {      # Check for a template file situation.
1395              # Here we have no category, so we need to get the calling package.      my $outputString;
1396              # The calling package is normally the first parameter. If it is      if (defined $varHash) {
1397              # omitted, the first parameter will be the tracelevel. So, the          # Here we have a template file. We need to determine the template type.
1398              # first thing we do is shift the so-called category into the          my $template;
1399              # $traceLevel variable where it belongs.          if ($FIG_Config::template_url && $webData =~ /\.php$/) {
1400              $traceLevel = $category;              $template = "$FIG_Config::template_url/$webData";
1401              my ($package, $fileName, $line) = caller;          } else {
1402              # If there is no calling package, we default to "main".              $template = "<<$webData";
1403              if (!$package) {          }
1404                  $category = "main";          $outputString = PageBuilder::Build($template, $varHash, "Html");
1405              } else {              } else {
1406                  $category = $package;          # Here the user gave us a raw string.
1407            $outputString = $webData;
1408              }              }
1409        # Check for trace messages.
1410        if ($Destination ne "NONE" && $TraceLevel > 0) {
1411            # We have trace messages, so we want to put them at the end of the body. This
1412            # is either at the end of the whole string or at the beginning of the BODY
1413            # end-tag.
1414            my $pos = length $outputString;
1415            if ($outputString =~ m#</body>#gi) {
1416                $pos = (pos $outputString) - 7;
1417          }          }
1418          # Save the category name.          # If the trace messages were queued, we unroll them. Otherwise, we display the
1419          $LastCategory = $category;          # destination.
1420          # Convert it to lower case before we hash it.          my $traceHtml;
1421          $category = lc $category;          if ($Destination eq "QUEUE") {
1422          # Use the category and tracelevel to compute the result.              $traceHtml = QTrace('Html');
1423          if (ref $traceLevel) {          } elsif ($Destination =~ /^>>(.+)$/) {
1424              Confess("Bad trace level.");              # Here the tracing output it to a file. We code it as a hyperlink so the user
1425          } elsif (ref $TraceLevel) {              # can copy the file name into the clipboard easily.
1426              Confess("Bad trace config.");              my $actualDest = $1;
1427                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
1428            } else {
1429                # Here we have one of the special destinations.
1430                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
1431            }
1432            substr $outputString, $pos, 0, $traceHtml;
1433        }
1434        # Write the output string.
1435        print $outputString;
1436    }
1437    
1438    =head2 Command-Line Utility Methods
1439    
1440    =head3 SendSMS
1441    
1442        my $msgID = Tracer::SendSMS($phoneNumber, $msg);
1443    
1444    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1445    user name, password, and API ID for the relevant account in the hash reference variable
1446    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1447    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1448    is C<2561022>, then the FIG_Config file must contain
1449    
1450        $phone =  { user => 'BruceTheHumanPet',
1451                    password => 'silly',
1452                    api_id => '2561022' };
1453    
1454    The original purpose of this method was to insure Bruce would be notified immediately when the
1455    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1456    when you call this method.
1457    
1458    The message ID will be returned if successful, and C<undef> if an error occurs.
1459    
1460    =over 4
1461    
1462    =item phoneNumber
1463    
1464    Phone number to receive the message, in international format. A United States phone number
1465    would be prefixed by "1". A British phone number would be prefixed by "44".
1466    
1467    =item msg
1468    
1469    Message to send to the specified phone.
1470    
1471    =item RETURN
1472    
1473    Returns the message ID if successful, and C<undef> if the message could not be sent.
1474    
1475    =back
1476    
1477    =cut
1478    
1479    sub SendSMS {
1480        # Get the parameters.
1481        my ($phoneNumber, $msg) = @_;
1482        # Declare the return variable. If we do not change it, C<undef> will be returned.
1483        my $retVal;
1484        # Only proceed if we have phone support.
1485        if (! defined $FIG_Config::phone) {
1486            Trace("Phone support not present in FIG_Config.") if T(1);
1487        } else {
1488            # Get the phone data.
1489            my $parms = $FIG_Config::phone;
1490            # Get the Clickatell URL.
1491            my $url = "http://api.clickatell.com/http/";
1492            # Create the user agent.
1493            my $ua = LWP::UserAgent->new;
1494            # Request a Clickatell session.
1495            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
1496                                         password => $parms->{password},
1497                                         api_id => $parms->{api_id},
1498                                         to => $phoneNumber,
1499                                         text => $msg});
1500            # Check for an error.
1501            if (! $resp->is_success) {
1502                Trace("Alert failed.") if T(1);
1503            } else {
1504                # Get the message ID.
1505                my $rstring = $resp->content;
1506                if ($rstring =~ /^ID:\s+(.*)$/) {
1507                    $retVal = $1;
1508                } else {
1509                    Trace("Phone attempt failed with $rstring") if T(1);
1510                }
1511            }
1512        }
1513        # Return the result.
1514        return $retVal;
1515    }
1516    
1517    =head3 StandardSetup
1518    
1519        my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV);
1520    
1521    This method performs standard command-line parsing and tracing setup. The return
1522    values are a hash of the command-line options and a list of the positional
1523    parameters. Tracing is automatically set up and the command-line options are
1524    validated.
1525    
1526    This is a complex method that does a lot of grunt work. The parameters can
1527    be more easily understood, however, once they are examined individually.
1528    
1529    The I<categories> parameter is the most obtuse. It is a reference to a list of
1530    special-purpose tracing categories. Most tracing categories are PERL package
1531    names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
1532    B<ERDB>, and B<SproutLoad> packages, you would specify the categories
1533    
1534        ["Sprout", "SproutLoad", "ERDB"]
1535    
1536    This would cause trace messages in the specified three packages to appear in
1537    the output. There are two special tracing categories that are automatically
1538    handled by this method. In other words, if you used L</TSetup> you would need
1539    to include these categories manually, but if you use this method they are turned
1540    on automatically.
1541    
1542    =over 4
1543    
1544    =item SQL
1545    
1546    Traces SQL commands and activity.
1547    
1548    =item Tracer
1549    
1550    Traces error messages and call stacks.
1551    
1552    =back
1553    
1554    C<SQL> is only turned on if the C<-sql> option is specified in the command line.
1555    The trace level is specified using the C<-trace> command-line option. For example,
1556    the following command line for C<TransactFeatures> turns on SQL tracing and runs
1557    all tracing at level 3.
1558    
1559        TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
1560    
1561    Standard tracing is output to the standard output and echoed to the file
1562    C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
1563    process ID. You can also specify the C<user> parameter to put a user ID
1564    instead of a process ID in the trace file name. So, for example
1565    
1566    The default trace level is 2. To get all messages, specify a trace level of 4.
1567    For a genome-by-genome update, use 3.
1568    
1569        TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
1570    
1571    would send the trace output to C<traceBruce.log> in the temporary directory.
1572    
1573    The I<options> parameter is a reference to a hash containing the command-line
1574    options, their default values, and an explanation of what they mean. Command-line
1575    options may be in the form of switches or keywords. In the case of a switch, the
1576    option value is 1 if it is specified and 0 if it is not specified. In the case
1577    of a keyword, the value is separated from the option name by an equal sign. You
1578    can see this last in the command-line example above.
1579    
1580    You can specify a different default trace level by setting C<$options->{trace}>
1581    prior to calling this method.
1582    
1583    An example at this point would help. Consider, for example, the command-line utility
1584    C<TransactFeatures>. It accepts a list of positional parameters plus the options
1585    C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
1586    the following code.
1587    
1588        my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
1589                            { safe => [0, "use database transactions"],
1590                              noAlias => [0, "do not expect aliases in CHANGE transactions"],
1591                              start => [' ', "start with this genome"],
1592                              tblFiles => [0, "output TBL files containing the corrected IDs"] },
1593                            "<command> <transactionDirectory> <IDfile>",
1594                          @ARGV);
1595    
1596    
1597    The call to C<ParseCommand> specifies the default values for the options and
1598    stores the actual options in a hash that is returned as C<$options>. The
1599    positional parameters are returned in C<@parameters>.
1600    
1601    The following is a sample command line for C<TransactFeatures>.
1602    
1603        TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
1604    
1605    Single and double hyphens are equivalent. So, you could also code the
1606    above command as
1607    
1608        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
1609    
1610    In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
1611    parameters, and would find themselves in I<@parameters> after executing the
1612    above code fragment. The tracing would be set to level 2, and the categories
1613    would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
1614    and C<DocUtils> was included because it came in within the first parameter
1615    to this method. The I<$options> hash would be
1616    
1617        { trace => 2, sql => 0, safe => 0,
1618          noAlias => 1, start => ' ', tblFiles => 0 }
1619    
1620    Use of C<StandardSetup> in this way provides a simple way of performing
1621    standard tracing setup and command-line parsing. Note that the caller is
1622    not even aware of the command-line switches C<-trace> and C<-sql>, which
1623    are used by this method to control the tracing. If additional tracing features
1624    need to be added in the future, they can be processed by this method without
1625    upsetting the command-line utilities.
1626    
1627    If the C<background> option is specified on the command line, then the
1628    standard and error outputs will be directed to files in the temporary
1629    directory, using the same suffix as the trace file. So, if the command
1630    line specified
1631    
1632        -user=Bruce -background
1633    
1634    then the trace output would go to C<traceBruce.log>, the standard output to
1635    C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
1636    simplify starting a command in the background.
1637    
1638    The user name is also used as the tracing key for L</Emergency Tracing>.
1639    Specifying a value of C<E> for the trace level causes emergency tracing to
1640    be used instead of custom tracing. If the user name is not specified,
1641    the tracing key is taken from the C<Tracing> environment variable. If there
1642    is no value for that variable, the tracing key will be computed from the PID.
1643    
1644    Finally, if the special option C<-help> is specified, the option
1645    names will be traced at level 0 and the program will exit without processing.
1646    This provides a limited help capability. For example, if the user enters
1647    
1648        TransactFeatures -help
1649    
1650    he would see the following output.
1651    
1652        TransactFeatures [options] <command> <transactionDirectory> <IDfile>
1653            -trace    tracing level (default E)
1654            -sql      trace SQL commands
1655            -safe     use database transactions
1656            -noAlias  do not expect aliases in CHANGE transactions
1657            -start    start with this genome
1658            -tblFiles output TBL files containing the corrected IDs
1659    
1660    The caller has the option of modifying the tracing scheme by placing a value
1661    for C<trace> in the incoming options hash. The default value can be overridden,
1662    or the tracing to the standard output can be turned off by suffixing a minus
1663    sign to the trace level. So, for example,
1664    
1665        { trace => [0, "tracing level (default 0)"],
1666           ...
1667    
1668    would set the default trace level to 0 instead of E, while
1669    
1670        { trace => ["2-", "tracing level (default 2)"],
1671           ...
1672    
1673    would set the default to 2, but trace only to the log file, not to the
1674    standard output.
1675    
1676    The parameters to this method are as follows.
1677    
1678    =over 4
1679    
1680    =item categories
1681    
1682    Reference to a list of tracing category names. These should be names of
1683    packages whose internal workings will need to be debugged to get the
1684    command working.
1685    
1686    =item options
1687    
1688    Reference to a hash containing the legal options for the current command mapped
1689    to their default values and descriptions. The user can override the defaults
1690    by specifying the options as command-line switches prefixed by a hyphen.
1691    Tracing-related options may be added to this hash. If the C<-h> option is
1692    specified on the command line, the option descriptions will be used to
1693    explain the options. To turn off tracing to the standard output, add a
1694    minus sign to the value for C<trace> (see above).
1695    
1696    =item parmHelp
1697    
1698    A string that vaguely describes the positional parameters. This is used
1699    if the user specifies the C<-h> option.
1700    
1701    =item argv
1702    
1703    List of command line parameters, including the option switches, which must
1704    precede the positional parameters and be prefixed by a hyphen.
1705    
1706    =item RETURN
1707    
1708    Returns a list. The first element of the list is the reference to a hash that
1709    maps the command-line option switches to their values. These will either be the
1710    default values or overrides specified on the command line. The remaining
1711    elements of the list are the position parameters, in order.
1712    
1713    =back
1714    
1715    =cut
1716    
1717    sub StandardSetup {
1718        # Get the parameters.
1719        my ($categories, $options, $parmHelp, @argv) = @_;
1720        # Get the default tracing key.
1721        my $tkey = EmergencyKey();
1722        # Add the tracing options.
1723        if (! exists $options->{trace}) {
1724            $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1725        }
1726        $options->{sql} = [0, "turn on SQL tracing"];
1727        $options->{help} = [0, "display command-line options"];
1728        $options->{user} = [$tkey, "tracing key"];
1729        $options->{background} = [0, "spool standard and error output"];
1730        # Create a parsing hash from the options hash. The parsing hash
1731        # contains the default values rather than the default value
1732        # and the description. While we're at it, we'll memorize the
1733        # length of the longest option name.
1734        my $longestName = 0;
1735        my %parseOptions = ();
1736        for my $key (keys %{$options}) {
1737            if (length $key > $longestName) {
1738                $longestName = length $key;
1739            }
1740            $parseOptions{$key} = $options->{$key}->[0];
1741        }
1742        # Parse the command line.
1743        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1744        # Get the logfile suffix.
1745        my $suffix = $retOptions->{user};
1746        # Check for background mode.
1747        if ($retOptions->{background}) {
1748            my $outFileName = "$FIG_Config::temp/out$suffix.log";
1749            my $errFileName = "$FIG_Config::temp/err$suffix.log";
1750            open STDOUT, ">$outFileName";
1751            open STDERR, ">$errFileName";
1752            # Check for phone support. If we have phone support and a phone number,
1753            # we want to turn it on.
1754            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1755                $retOptions->{phone} = $ENV{PHONE};
1756            }
1757        }
1758        # Now we want to set up tracing. First, we need to know if the user
1759        # wants emergency tracing.
1760        if ($retOptions->{trace} eq 'E') {
1761            ETracing($retOptions->{user});
1762        } else {
1763            # Here the tracing is controlled from the command line.
1764            my @cats = @{$categories};
1765            if ($retOptions->{sql}) {
1766                push @cats, "SQL";
1767            }
1768            # Add the default categories.
1769            push @cats, "Tracer";
1770            # Next, we create the category string by joining the categories.
1771            my $cats = join(" ", @cats);
1772            # Check to determine whether or not the caller wants to turn off tracing
1773            # to the standard output.
1774            my $traceLevel = $retOptions->{trace};
1775            my $textOKFlag = 1;
1776            if ($traceLevel =~ /^(.)-/) {
1777                $traceLevel = $1;
1778                $textOKFlag = 0;
1779            }
1780            # Now we set up the trace mode.
1781            my $traceMode;
1782            # Verify that we can open a file in the FIG temporary directory.
1783            my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1784            if (open TESTTRACE, ">$traceFileName") {
1785                # Here we can trace to a file.
1786                $traceMode = ">$traceFileName";
1787                if ($textOKFlag) {
1788                    # Echo to standard output if the text-OK flag is set.
1789                    $traceMode = "+$traceMode";
1790                }
1791                # Close the test file.
1792                close TESTTRACE;
1793            } else {
1794                # Here we can't trace to a file. Complain about this.
1795                warn "Could not open trace file $traceFileName: $!\n";
1796                # We trace to the standard output if it's
1797                # okay, and the error log otherwise.
1798                if ($textOKFlag) {
1799                    $traceMode = "TEXT";
1800                } else {
1801                    $traceMode = "WARN";
1802                }
1803            }
1804            # Now set up the tracing.
1805            TSetup("$traceLevel $cats", $traceMode);
1806        }
1807        # Check for the "help" option. If it is specified, dump the command-line
1808        # options and exit the program.
1809        if ($retOptions->{help}) {
1810            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
1811            print "$1 [options] $parmHelp\n";
1812            for my $key (sort keys %{$options}) {
1813                my $name = Pad($key, $longestName, 0, ' ');
1814                my $desc = $options->{$key}->[1];
1815                if ($options->{$key}->[0]) {
1816                    $desc .= " (default " . $options->{$key}->[0] . ")";
1817                }
1818                print "  $name $desc\n";
1819            }
1820            exit(0);
1821          }          }
1822          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));      # Trace the options, if applicable.
1823        if (T(3)) {
1824            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
1825            Trace("Selected options: " . join(", ", sort @parms) . ".");
1826      }      }
1827      # Return the computed result.      # Return the parsed parameters.
1828      return $retVal;      return ($retOptions, @retParameters);
1829  }  }
1830    
1831  =head3 ParseCommand  =head3 ReadOptions
   
 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); >>  
   
 In this case, the list @words will be treated as a command line. There are two options available,  
 B<errors> and B<logFile>. If @words has the following format  
   
 C<< -logFile=error.log apple orange rutabaga >>  
   
 then at the end of the invocation, C<$options> will be  
1832    
1833  C<< { errors => 0, logFile => 'error.log' } >>      my %options = Tracer::ReadOptions($fileName);
1834    
1835  and C<@arguments> will contain  Read a set of options from a file. Each option is encoded in a line of text that has the
1836    format
1837    
1838  C<< apple orange rutabaga >>  I<optionName>C<=>I<optionValue>C<; >I<comment>
1839    
1840  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no  The option name must consist entirely of letters, digits, and the punctuation characters
1841  support for quote characters.  C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank
1842    character is a semi-colon will be ignored. The return hash will map each option name to
1843    the corresponding option value.
1844    
1845  =over 4  =over 4
1846    
1847  =item optionTable  =item fileName
   
 Table of default options.  
   
 =item inputList  
1848    
1849  List of words on the command line.  Name of the file containing the option data.
1850    
1851  =item RETURN  =item RETURN
1852    
1853  Returns a reference to the option table and a list of the positional arguments.  Returns a hash mapping the option names specified in the file to their corresponding option
1854    value.
1855    
1856  =back  =back
1857    
1858  =cut  =cut
1859    
1860  sub ParseCommand {  sub ReadOptions {
1861      # Get the parameters.      # Get the parameters.
1862      my ($optionTable, @inputList) = @_;      my ($fileName) = @_;
1863      # Process any options in the input list.      # Open the file.
1864      my %overrides = ();      (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");
1865      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      # Count the number of records read.
1866          # Get the current option.      my ($records, $comments) = 0;
1867          my $arg = shift @inputList;      # Create the return hash.
1868          # Pull out the option name.      my %retVal = ();
1869          $arg =~ /^-([^=]*)/g;      # Loop through the file, accumulating key-value pairs.
1870          my $name = $1;      while (my $line = <CONFIGFILE>) {
1871          # Check for an option value.          # Denote we've read a line.
1872          if ($arg =~ /\G=(.*)$/g) {          $records++;
1873              # Here we have a value for the option.          # Determine the line type.
1874              $overrides{$name} = UnEscape($1);          if ($line =~ /^\s*[\n\r]/) {
1875                # A blank line is a comment.
1876                $comments++;
1877            } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {
1878                # Here we have an option assignment.
1879                retVal{$1} = $2;
1880            } elsif ($line =~ /^\s*;/) {
1881                # Here we have a text comment.
1882                $comments++;
1883          } else {          } else {
1884              # Here there is no value, so we use 1.              # Here we have an invalid line.
1885              $overrides{$name} = 1;              Trace("Invalid option statement in record $records.") if T(0);
         }  
1886      }      }
     # Merge the options into the defaults.  
     GetOptions($optionTable, \%overrides);  
     # Translate the remaining parameters.  
     my @retVal = ();  
     for my $inputParm (@inputList) {  
         push @retVal, UnEscape($inputParm);  
1887      }      }
1888      # Return the results.      # Return the hash created.
1889      return ($optionTable, @retVal);      return %retVal;
1890  }  }
1891    
1892  =head3 Escape  =head3 GetOptions
   
 C<< my $codedString = Tracer::Escape($realString); >>  
   
 Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines  
 replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The  
 result is to reverse the effect of L</UnEscape>.  
   
 =over 4  
   
 =item realString  
1893    
1894  String to escape.      Tracer::GetOptions(\%defaults, \%options);
1895    
1896  =item RETURN  Merge a specified set of options into a table of defaults. This method takes two hash references
1897    as input and uses the data from the second to update the first. If the second does not exist,
1898    there will be no effect. An error will be thrown if one of the entries in the second hash does not
1899    exist in the first.
1900    
1901  Escaped equivalent of the real string.  Consider the following example.
1902    
1903  =back      my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options);
1904    
1905  =cut  In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and
1906    B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of
1907    B<$options> is C<< {dbType => 'Oracle'} >>, then the database type will be changed to C<Oracle> and
1908    the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level
1909    will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as
1910    
1911  sub Escape {      {databaseType => 'Oracle'}
     # Get the parameter.  
     my ($realString) = @_;  
     # Initialize the return variable.  
     my $retVal = "";  
     # Loop through the parameter string, looking for sequences to escape.  
     while (length $realString > 0) {  
         # Look for the first sequence to escape.  
         if ($realString =~ /^(.*?)([\n\t\r\\])/) {  
             # Here we found it. The text preceding the sequence is in $1. The sequence  
             # itself is in $2. First, move the clear text to the return variable.  
             $retVal .= $1;  
             # Strip the processed section off the real string.  
             $realString = substr $realString, (length $2) + (length $1);  
             # Get the matched character.  
             my $char = $2;  
             # If we have a CR, we are done.  
             if ($char ne "\r") {  
                 # It's not a CR, so encode the escape sequence.  
                 $char =~ tr/\t\n/tn/;  
                 $retVal .= "\\" . $char;  
             }  
         } else {  
             # Here there are no more escape sequences. The rest of the string is  
             # transferred unmodified.  
             $retVal .= $realString;  
             $realString = "";  
         }  
     }  
     # Return the result.  
     return $retVal;  
 }  
1912    
1913  =head3 UnEscape  an error will occur because the B<databaseType> option does not exist.
1914    
1915  C<< my $realString = Tracer::UnEscape($codedString); >>  =over 4
1916    
1917  Replace escape sequences with their actual equivalents. C<\t> will be replaced by  =item defaults
 a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will  
 be deleted.  
1918    
1919  =over 4  Table of default option values.
1920    
1921  =item codedString  =item options
1922    
1923  String to un-escape.  Table of overrides, if any.
1924    
1925  =item RETURN  =item RETURN
1926    
1927  Returns a copy of the original string with the escape sequences converted to their actual  Returns a reference to the default table passed in as the first parameter.
 values.  
1928    
1929  =back  =back
1930    
1931  =cut  =cut
1932    
1933  sub UnEscape {  sub GetOptions {
1934      # Get the parameter.      # Get the parameters.
1935      my ($codedString) = @_;      my ($defaults, $options) = @_;
1936      # Initialize the return variable.      # Check for overrides.
1937      my $retVal = "";      if ($options) {
1938      # Only proceed if the incoming string is nonempty.          # Loop through the overrides.
1939      if (defined $codedString) {          while (my ($option, $setting) = each %{$options}) {
1940          # Loop through the parameter string, looking for escape sequences. We can't do              # Insure this override exists.
1941          # translating because it causes problems with the escaped slash. ("\\t" becomes              if (!exists $defaults->{$option}) {
1942          # "\<tab>" no matter what we do.)                  croak "Unrecognized option $option encountered.";
         while (length $codedString > 0) {  
             # Look for the first escape sequence.  
             if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {  
                 # Here we found it. The text preceding the sequence is in $1. The sequence  
                 # itself is in $2. First, move the clear text to the return variable.  
                 $retVal .= $1;  
                 $codedString = substr $codedString, (2 + length $1);  
                 # Get the escape value.  
                 my $char = $2;  
                 # If we have a "\r", we are done.  
                 if ($char ne 'r') {  
                     # Here it's not an 'r', so we convert it.  
                     $char =~ tr/\\tn/\\\t\n/;  
                     $retVal .= $char;  
                 }  
1943              } else {              } else {
1944                  # Here there are no more escape sequences. The rest of the string is                  # Apply the override.
1945                  # transferred unmodified.                  $defaults->{$option} = $setting;
                 $retVal .= $codedString;  
                 $codedString = "";  
1946              }              }
1947          }          }
1948      }      }
1949      # Return the result.      # Return the merged table.
1950      return $retVal;      return $defaults;
1951  }  }
1952    
1953  =head3 ParseRecord  =head3 MergeOptions
1954    
1955  C<< my @fields = Tracer::ParseRecord($line); >>      Tracer::MergeOptions(\%table, \%defaults);
1956    
1957  Parse a tab-delimited data line. The data line is split into field values. Embedded tab  Merge default values into a hash table. This method looks at the key-value pairs in the
1958  and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.  second (default) hash, and if a matching key is not found in the first hash, the default
1959  These will automatically be converted.  pair is copied in. The process is similar to L</GetOptions>, but there is no error-
1960    checking and no return value.
1961    
1962  =over 4  =over 4
1963    
1964  =item line  =item table
1965    
1966  Line of data containing the tab-delimited fields.  Hash table to be updated with the default values.
1967    
1968  =item RETURN  =item defaults
1969    
1970  Returns a list of the fields found in the data line.  Default values to be merged into the first hash table if they are not already present.
1971    
1972  =back  =back
1973    
1974  =cut  =cut
1975    
1976  sub ParseRecord {  sub MergeOptions {
1977      # Get the parameter.      # Get the parameters.
1978      my ($line) = @_;      my ($table, $defaults) = @_;
1979      # Remove the trailing new-line, if any.      # Loop through the defaults.
1980      chomp $line;      while (my ($key, $value) = each %{$defaults}) {
1981      # Split the line read into pieces using the tab character.          if (!exists $table->{$key}) {
1982      my @retVal = split /\t/, $line;              $table->{$key} = $value;
1983      # Trim and fix the escapes in each piece.          }
1984      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;  
1985  }  }
1986    
1987  =head3 Merge  =head3 ParseCommand
   
 C<< my @mergedList = Tracer::Merge(@inputList); >>  
   
 Sort a list of strings and remove duplicates.  
   
 =over 4  
1988    
1989  =item inputList      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
1990    
1991  List of scalars to sort and merge.  Parse a command line consisting of a list of parameters. The initial parameters may be option
1992    specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped
1993    off and merged into a table of default options. The remainder of the command line is
1994    returned as a list of positional arguments. For example, consider the following invocation.
1995    
1996  =item RETURN      my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words);
1997    
1998  Returns a list containing the same elements sorted in ascending order with duplicates  In this case, the list @words will be treated as a command line and there are two options available,
1999  removed.  B<errors> and B<logFile>. If @words has the following format
2000    
2001  =back      -logFile=error.log apple orange rutabaga
2002    
2003  =cut  then at the end of the invocation, C<$options> will be
2004    
2005  sub Merge {      { errors => 0, logFile => 'error.log' }
     # 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;  
 }  
2006    
2007  =head3 Percent  and C<@arguments> will contain
2008    
2009  C<< my $percent = Tracer::Percent($number, $base); >>      apple orange rutabaga
2010    
2011  Returns the percent of the base represented by the given number. If the base  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
2012  is zero, returns zero.  support for quote characters. Options can be specified with single or double hyphens.
2013    
2014  =over 4  =over 4
2015    
2016  =item number  =item optionTable
2017    
2018  Percent numerator.  Table of default options.
2019    
2020  =item base  =item inputList
2021    
2022  Percent base.  List of words on the command line.
2023    
2024  =item RETURN  =item RETURN
2025    
2026  Returns the percentage of the base represented by the numerator.  Returns a reference to the option table and a list of the positional arguments.
2027    
2028  =back  =back
2029    
2030  =cut  =cut
2031    
2032  sub Percent {  sub ParseCommand {
2033      # Get the parameters.      # Get the parameters.
2034      my ($number, $base) = @_;      my ($optionTable, @inputList) = @_;
2035      # Declare the return variable.      # Process any options in the input list.
2036      my $retVal = 0;      my %overrides = ();
2037      # Compute the percent.      while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
2038      if ($base != 0) {          # Get the current option.
2039          $retVal = $number * 100 / $base;          my $arg = shift @inputList;
2040            # Pull out the option name.
2041            $arg =~ /^--?([^=]*)/g;
2042            my $name = $1;
2043            # Check for an option value.
2044            if ($arg =~ /\G=(.*)$/g) {
2045                # Here we have a value for the option.
2046                $overrides{$name} = UnEscape($1);
2047            } else {
2048                # Here there is no value, so we use 1.
2049                $overrides{$name} = 1;
2050      }      }
2051      # Return the result.      }
2052      return $retVal;      # Merge the options into the defaults.
2053        GetOptions($optionTable, \%overrides);
2054        # Translate the remaining parameters.
2055        my @retVal = ();
2056        for my $inputParm (@inputList) {
2057            push @retVal, UnEscape($inputParm);
2058        }
2059        # Return the results.
2060        return ($optionTable, @retVal);
2061  }  }
2062    
2063    
2064    =head2 File Utility Methods
2065    
2066  =head3 GetFile  =head3 GetFile
2067    
2068  C<< my @fileContents = Tracer::GetFile($fileName); >>      my @fileContents = Tracer::GetFile($fileName);
2069    
2070      or      or
2071    
2072  C<< my $fileContents = Tracer::GetFile($fileName); >>      my $fileContents = Tracer::GetFile($fileName);
2073    
2074  Return the entire contents of a file. In list context, line-ends are removed and  Return the entire contents of a file. In list context, line-ends are removed and
2075  each line is a list element. In scalar context, line-ends are replaced by C<\n>.  each line is a list element. In scalar context, line-ends are replaced by C<\n>.
# Line 1436  Line 2108 
2108      # Close it.      # Close it.
2109      close $handle;      close $handle;
2110      my $actualLines = @retVal;      my $actualLines = @retVal;
2111        Trace("$actualLines lines read from file $fileName.") if T(File => 2);
2112      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
2113      if (wantarray) {      if (wantarray) {
2114          return @retVal;          return @retVal;
# Line 1446  Line 2119 
2119    
2120  =head3 PutFile  =head3 PutFile
2121    
2122  C<< Tracer::PutFile($fileName, \@lines); >>      Tracer::PutFile($fileName, \@lines);
2123    
2124  Write out a file from a list of lines of text.  Write out a file from a list of lines of text.
2125    
# Line 1471  Line 2144 
2144      my ($fileName, $lines) = @_;      my ($fileName, $lines) = @_;
2145      # Open the output file.      # Open the output file.
2146      my $handle = Open(undef, ">$fileName");      my $handle = Open(undef, ">$fileName");
2147        # Count the lines written.
2148      if (ref $lines ne 'ARRAY') {      if (ref $lines ne 'ARRAY') {
2149          # Here we have a scalar, so we write it raw.          # Here we have a scalar, so we write it raw.
2150          print $handle $lines;          print $handle $lines;
2151            Trace("Scalar put to file $fileName.") if T(File => 3);
2152      } else {      } else {
2153          # Write the lines one at a time.          # Write the lines one at a time.
2154            my $count = 0;
2155          for my $line (@{$lines}) {          for my $line (@{$lines}) {
2156              print $handle "$line\n";              print $handle "$line\n";
2157                $count++;
2158          }          }
2159            Trace("$count lines put to file $fileName.") if T(File => 3);
2160      }      }
2161      # Close the output file.      # Close the output file.
2162      close $handle;      close $handle;
2163  }  }
2164    
2165  =head3 QTrace  =head3 ParseRecord
   
 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  
   
 =item message  
   
 Message to include in the trace.  
   
 =back  
   
 =cut  
   
 sub Confess {  
     # Get the parameters.  
     my ($message) = @_;  
     # Trace the call stack.  
     Cluck($message);  
     # Abort the program.  
     croak(">>> $message");  
 }  
   
 =head3 Assert  
   
 C<< Assert($condition1, $condition2, ... $conditionN); >>  
   
 Return TRUE if all the conditions are true. This method can be used in conjunction with  
 the OR operator and the L</Confess> method 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.  
   
 =cut  
 sub Assert {  
     my $retVal = 1;  
     LOOP: for my $condition (@_) {  
         if (! $condition) {  
             $retVal = 0;  
             last LOOP;  
         }  
     }  
     return $retVal;  
 }  
   
 =head3 Cluck  
   
 C<< Cluck($message); >>  
   
 Trace the call stack. Note that for best results, you should qualify the call with a  
 trace condition. For example,  
   
 C<< Cluck("Starting record parse.") if T(3); >>  
   
 will only trace the stack if the trace level for the package is 3 or more.  
   
 =over 4  
   
 =item message  
   
 Message to include in the trace.  
   
 =back  
   
 =cut  
   
 sub Cluck {  
     # Get the parameters.  
     my ($message) = @_;  
     # Trace what's happening.  
     Trace("Stack trace for event: $message");  
     my $confession = longmess($message);  
     # Convert the confession to a series of trace messages. Note we skip any  
     # messages relating to calls into Tracer.  
     for my $line (split /\s*\n/, $confession) {  
         Trace($line) if ($line !~ /Tracer\.pm/);  
     }  
 }  
   
 =head3 Min  
2166    
2167  C<< my $min = Min($value1, $value2, ... $valueN); >>      my @fields = Tracer::ParseRecord($line);
2168    
2169  Return the minimum argument. The arguments are treated as numbers.  Parse a tab-delimited data line. The data line is split into field values. Embedded tab
2170    and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.
2171    These will automatically be converted.
2172    
2173  =over 4  =over 4
2174    
2175  =item $value1, $value2, ... $valueN  =item line
2176    
2177  List of numbers to compare.  Line of data containing the tab-delimited fields.
2178    
2179  =item RETURN  =item RETURN
2180    
2181  Returns the lowest number in the list.  Returns a list of the fields found in the data line.
2182    
2183  =back  =back
2184    
2185  =cut  =cut
2186    
2187  sub Min {  sub ParseRecord {
2188      # Get the parameters. Note that we prime the return value with the first parameter.      # Get the parameter.
2189      my ($retVal, @values) = @_;      my ($line) = @_;
2190      # Loop through the remaining parameters, looking for the lowest.      # Remove the trailing new-line, if any.
2191      for my $value (@values) {      chomp $line;
2192          if ($value < $retVal) {      # Split the line read into pieces using the tab character.
2193              $retVal = $value;      my @retVal = split /\t/, $line;
2194          }      # Trim and fix the escapes in each piece.
2195        for my $value (@retVal) {
2196            # Trim leading whitespace.
2197            $value =~ s/^\s+//;
2198            # Trim trailing whitespace.
2199            $value =~ s/\s+$//;
2200            # Delete the carriage returns.
2201            $value =~ s/\r//g;
2202            # Convert the escapes into their real values.
2203            $value =~ s/\\t/"\t"/ge;
2204            $value =~ s/\\n/"\n"/ge;
2205      }      }
2206      # Return the minimum found.      # Return the result.
2207      return $retVal;      return @retVal;
2208  }  }
2209    
2210  =head3 Max  =head3 Merge
2211    
2212  C<< my $max = Max($value1, $value2, ... $valueN); >>      my @mergedList = Tracer::Merge(@inputList);
2213    
2214  Return the maximum argument. The arguments are treated as numbers.  Sort a list of strings and remove duplicates.
2215    
2216  =over 4  =over 4
2217    
2218  =item $value1, $value2, ... $valueN  =item inputList
2219    
2220  List of numbers to compare.  List of scalars to sort and merge.
2221    
2222  =item RETURN  =item RETURN
2223    
2224  Returns the highest number in the list.  Returns a list containing the same elements sorted in ascending order with duplicates
2225    removed.
2226    
2227  =back  =back
2228    
2229  =cut  =cut
2230    
2231  sub Max {  sub Merge {
2232      # Get the parameters. Note that we prime the return value with the first parameter.      # Get the input list in sort order.
2233      my ($retVal, @values) = @_;      my @inputList = sort @_;
2234      # Loop through the remaining parameters, looking for the highest.      # Only proceed if the list has at least two elements.
2235      for my $value (@values) {      if (@inputList > 1) {
2236          if ($value > $retVal) {          # Now we want to move through the list splicing out duplicates.
2237              $retVal = $value;          my $i = 0;
2238            while ($i < @inputList) {
2239                # Get the current entry.
2240                my $thisEntry = $inputList[$i];
2241                # Find out how many elements duplicate the current entry.
2242                my $j = $i + 1;
2243                my $dup1 = $i + 1;
2244                while ($j < @inputList && $inputList[$j] eq $thisEntry) { $j++; };
2245                # If the number is nonzero, splice out the duplicates found.
2246                if ($j > $dup1) {
2247                    splice @inputList, $dup1, $j - $dup1;
2248          }          }
2249                # Now the element at position $dup1 is different from the element before it
2250                # at position $i. We push $i forward one position and start again.
2251                $i++;
2252      }      }
2253      # Return the maximum found.      }
2254      return $retVal;      # Return the merged list.
2255        return @inputList;
2256  }  }
2257    
2258  =head3 AddToListMap  =head3 Open
2259    
2260  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>      my $handle = Open($fileHandle, $fileSpec, $message);
2261    
2262  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list  Open a file.
 is created for the key. Otherwise, the new value is pushed onto the list.  
2263    
2264  =over 4  The I<$fileSpec> is essentially the second argument of the PERL C<open>
2265    function. The mode is specified using Unix-like shell information. So, for
2266    example,
2267    
2268  =item hash      Open(\*LOGFILE, '>>/usr/spool/news/twitlog', "Could not open twit log.");
2269    
2270  Reference to the target hash.  would open for output appended to the specified file, and
2271    
2272  =item key      Open(\*DATASTREAM, "| sort -u >$outputFile", "Could not open $outputFile.");
2273    
2274  Key for which the value is to be added.  would open a pipe that sorts the records written and removes duplicates. Note
2275    the use of file handle syntax in the Open call. To use anonymous file handles,
2276    code as follows.
2277    
2278  =item value1, value2, ... valueN      my $logFile = Open(undef, '>>/usr/spool/news/twitlog', "Could not open twit log.");
2279    
2280  List of values to add to the key's value list.  The I<$message> parameter is used if the open fails. If it is set to C<0>, then
2281    the open returns TRUE if successful and FALSE if an error occurred. Otherwise, a
2282    failed open will throw an exception and the third parameter will be used to construct
2283    an error message. If the parameter is omitted, a standard message is constructed
2284    using the file spec.
2285    
2286  =back      Could not open "/usr/spool/news/twitlog"
2287    
2288  =cut  Note that the mode characters are automatically cleaned from the file name.
2289    The actual error message from the file system will be captured and appended to the
2290    message in any case.
2291    
2292  sub AddToListMap {      Could not open "/usr/spool/news/twitlog": file not found.
2293      # Get the parameters.  
2294      my ($hash, $key, @values) = @_;  In some versions of PERL the only error message we get is a number, which
2295      # Process according to whether or not the key already has a value.  corresponds to the C++ C<errno> value.
2296      if (! exists $hash->{$key}) {  
2297          $hash->{$key} = [@values];      Could not open "/usr/spool/news/twitlog": 6.
2298      } else {  
2299          push @{$hash->{$key}}, @values;  =over 4
     }  
 }  
2300    
2301  =head3 DebugMode  =item fileHandle
2302    
2303    File handle. If this parameter is C<undef>, a file handle will be generated
2304    and returned as the value of this method.
2305    
2306    =item fileSpec
2307    
2308    File name and mode, as per the PERL C<open> function.
2309    
2310  C<< if (Tracer::DebugMode) { ...code... } >>  =item message (optional)
2311    
2312    Error message to use if the open fails. If omitted, a standard error message
2313    will be generated. In either case, the error information from the file system
2314    is appended to the message. To specify a conditional open that does not throw
2315    an error if it fails, use C<0>.
2316    
2317    =item RETURN
2318    
2319  Return TRUE if debug mode has been turned on, else abort.  Returns the name of the file handle assigned to the file, or C<undef> if the
2320    open failed.
2321    
2322  Certain CGI scripts are too dangerous to exist in the production  =back
 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 will occur.  
2323    
2324  =cut  =cut
2325    
2326  sub DebugMode {  sub Open {
2327      # Declare the return variable.      # Get the parameters.
2328      my $retVal = 0;      my ($fileHandle, $fileSpec, $message) = @_;
2329      # Check the debug configuration.      # Attempt to open the file.
2330      my $password = CGI::cookie("DebugMode");      my $rv = open $fileHandle, $fileSpec;
2331      my $encrypted = Digest::MD5::md5_hex($password);      # If the open failed, generate an error message.
2332      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if (! $rv) {
2333          $retVal = 1;          # Save the system error message.
2334      } else {          my $sysMessage = $!;
2335          # Here debug mode is off, so we generate an error.          # See if we need a default message.
2336          Confess("Cannot use this facility without logging in.");          if (!$message) {
2337                # Clean any obvious mode characters and leading spaces from the
2338                # filename.
2339                my ($fileName) = FindNamePart($fileSpec);
2340                $message = "Could not open \"$fileName\"";
2341      }      }
2342      # Return the determination indicator.          # Terminate with an error using the supplied message and the
2343      return $retVal;          # error message from the file system.
2344            Confess("$message: $!");
2345        }
2346        # Return the file handle.
2347        return $fileHandle;
2348  }  }
2349    
2350  =head3 Strip  =head3 FindNamePart
2351    
2352  C<< my $string = Tracer::Strip($line); >>      my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec);
2353    
2354  Strip all line terminators off a string. This is necessary when dealing with files  Extract the portion of a file specification that contains the file name.
2355  that may have been transferred back and forth several times among different  
2356  operating environments.  A file specification is the string passed to an C<open> call. It specifies the file
2357    mode and name. In a truly complex situation, it can specify a pipe sequence. This
2358    method assumes that the file name is whatever follows the first angle bracket
2359    sequence.  So, for example, in the following strings the file name is
2360    C</usr/fig/myfile.txt>.
2361    
2362        >>/usr/fig/myfile.txt
2363        </usr/fig/myfile.txt
2364        | sort -u > /usr/fig/myfile.txt
2365    
2366    If the method cannot find a file name using its normal methods, it will return the
2367    whole incoming string.
2368    
2369  =over 4  =over 4
2370    
2371  =item line  =item fileSpec
2372    
2373  Line of text to be stripped.  File specification string from which the file name is to be extracted.
2374    
2375  =item RETURN  =item RETURN
2376    
2377  The same line of text with all the line-ending characters chopped from the end.  Returns a three-element list. The first element contains the file name portion of
2378    the specified string, or the whole string if a file name cannot be found via normal
2379    methods. The second element contains the start position of the file name portion and
2380    the third element contains the length.
2381    
2382  =back  =back
2383    
2384  =cut  =cut
2385    #: Return Type $;
2386  sub Strip {  sub FindNamePart {
2387      # Get a copy of the parameter string.      # Get the parameters.
2388      my ($string) = @_;      my ($fileSpec) = @_;
2389      my $retVal = (defined $string ? $string : "");      # Default to the whole input string.
2390      # Strip the line terminator characters.      my ($retVal, $pos, $len) = ($fileSpec, 0, length $fileSpec);
2391      $retVal =~ s/(\r|\n)+$//g;      # Parse out the file name if we can.
2392        if ($fileSpec =~ m/(<|>>?)(.+?)(\s*)$/) {
2393            $retVal = $2;
2394            $len = length $retVal;
2395            $pos = (length $fileSpec) - (length $3) - $len;
2396        }
2397      # Return the result.      # Return the result.
2398      return $retVal;      return ($retVal, $pos, $len);
2399  }  }
2400    
2401  =head3 Pad  =head3 OpenDir
2402    
2403  C<< my $paddedString = Tracer::Pad($string, $len, $left, $padChar); >>      my @files = OpenDir($dirName, $filtered, $flag);
2404    
2405  Pad a string to a specified length. The pad character will be a  Open a directory and return all the file names. This function essentially performs
2406  space, and the padding will be on the right side unless specified  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
2407  in the third parameter.  set to TRUE, all filenames beginning with a period (C<.>), dollar sign (C<$>),
2408    or pound sign (C<#>) and all filenames ending with a tilde C<~>) will be
2409    filtered out of the return list. If the directory does not open and I<$flag> is not
2410    set, an exception is thrown. So, for example,
2411    
2412  =over 4      my @files = OpenDir("/Volumes/fig/contigs", 1);
2413    
2414  =item string  is effectively the same as
2415    
2416  String to be padded.      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");
2417        my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);
2418    
2419  =item len  Similarly, the following code
2420    
2421  Desired length of the padded string.      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);
2422    
2423  =item left (optional)  Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and
2424    automatically returns an empty list if the directory fails to open.
2425    
2426  TRUE if the string is to be left-padded; otherwise it will be padded on the right.  =over 4
2427    
2428  =item padChar (optional)  =item dirName
2429    
2430  Character to use for padding. The default is a space.  Name of the directory to open.
2431    
2432  =item RETURN  =item filtered
2433    
2434  Returns a copy of the original string with the pad character added to the  TRUE if files whose names begin with a period (C<.>) should be automatically removed
2435  specified end so that it achieves the desired length.  from the list, else FALSE.
2436    
2437    =item flag
2438    
2439    TRUE if a failure to open is okay, else FALSE
2440    
2441  =back  =back
2442    
2443  =cut  =cut
2444    #: Return Type @;
2445  sub Pad {  sub OpenDir {
2446      # Get the parameters.      # Get the parameters.
2447      my ($string, $len, $left, $padChar) = @_;      my ($dirName, $filtered, $flag) = @_;
2448      # Compute the padding character.      # Declare the return variable.
2449      if (! defined $padChar) {      my @retVal = ();
2450          $padChar = " ";      # Open the directory.
2451      }      if (opendir(my $dirHandle, $dirName)) {
2452      # Compute the number of spaces needed.          # The directory opened successfully. Get the appropriate list according to the
2453      my $needed = $len - length $string;          # strictures of the filter parameter.
2454      # Copy the string into the return variable.          if ($filtered) {
2455      my $retVal = $string;              @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;
     # Only proceed if padding is needed.  
     if ($needed > 0) {  
         # Create the pad string.  
         my $pad = $padChar x $needed;  
         # Affix it to the return value.  
         if ($left) {  
             $retVal = $pad . $retVal;  
2456          } else {          } else {
2457              $retVal .= $pad;              @retVal = readdir $dirHandle;
2458          }          }
2459        } elsif (! $flag) {
2460            # Here the directory would not open and it's considered an error.
2461            Confess("Could not open directory $dirName.");
2462      }      }
2463      # Return the result.      # Return the result.
2464      return $retVal;      return @retVal;
2465  }  }
2466    
 =head3 EOF  
2467    
2468  This is a constant that is lexically greater than any useful string.  =head3 Insure
2469    
2470        Insure($dirName, $chmod);
2471    
2472    Insure a directory is present.
2473    
2474  =cut  =over 4
2475    
2476  sub EOF {  =item dirName
     return "\xFF\xFF\xFF\xFF\xFF";  
 }  
2477    
2478  =head3 TICK  Name of the directory to check. If it does not exist, it will be created.
2479    
2480  C<< my @results = TICK($commandString); >>  =item chmod (optional)
2481    
2482  Perform a back-tick operation on a command. If this is a Windows environment, any leading  Security privileges to be given to the directory if it is created.
 dot-slash (C<./> will be removed. So, for example, if you were doing  
2483    
2484      `./protein.cgi`  =back
2485    
2486  from inside a CGI script, it would work fine in Unix, but would issue an error message  =cut
 in Windows complaining that C<'.'> is not a valid command. If instead you code  
2487    
2488      TICK("./protein.cgi")  sub Insure {
2489        my ($dirName, $chmod) = @_;
2490        if (! -d $dirName) {
2491            Trace("Creating $dirName directory.") if T(2);
2492            eval {
2493                mkpath $dirName;
2494                # If we have permissions specified, set them here.
2495                if (defined($chmod)) {
2496                    chmod $chmod, $dirName;
2497                }
2498            };
2499            if ($@) {
2500                Confess("Error creating $dirName: $@");
2501            }
2502        }
2503    }
2504    
2505  it will work correctly in both environments.  =head3 ChDir
2506    
2507  =over 4      ChDir($dirName);
2508    
2509  =item commandString  Change to the specified directory.
2510    
2511  The command string to pass to the system.  =over 4
2512    
2513  =item RETURN  =item dirName
2514    
2515  Returns the standard output from the specified command, as a list.  Name of the directory to which we want to change.
2516    
2517  =back  =back
2518    
2519  =cut  =cut
2520  #: Return Type @;  
2521  sub TICK {  sub ChDir {
2522      # Get the parameters.      my ($dirName) = @_;
2523      my ($commandString) = @_;      if (! -d $dirName) {
2524      # Chop off the dot-slash if this is Windows.          Confess("Cannot change to directory $dirName: no such directory.");
2525      if ($FIG_Config::win_mode) {      } else {
2526          $commandString =~ s!^\./!!;          Trace("Changing to directory $dirName.") if T(File => 4);
2527            my $okFlag = chdir $dirName;
2528            if (! $okFlag) {
2529                Confess("Error switching to directory $dirName.");
2530            }
2531      }      }
     # Activate the command and return the result.  
     return `$commandString`;  
2532  }  }
2533    
2534  =head3 ScriptSetup  =head3 SetPermissions
2535    
2536  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>      Tracer::SetPermissions($dirName, $group, $mask, %otherMasks);
2537    
2538  Perform standard tracing and debugging setup for scripts. The value returned is  Set the permissions for a directory and all the files and folders inside it.
2539  the CGI object followed by a pre-built variable hash.  In addition, the group ownership will be changed to the specified value.
2540    
2541  The C<Trace> query parameter is used to determine whether or not tracing is active and  This method is more vulnerable than most to permission and compatability
2542  which trace modules (other than C<Tracer> itself) should be turned on. Specifying  problems, so it does internal error recovery.
 the C<CGI> trace module will trace parameter and environment information. Parameters are  
 traced at level 3 and environment variables at level 4. To trace to a file instead of to  
 the web page, set C<TF> to 1. At the end of the script, the client should call  
 L</ScriptFinish> to output the web page.  
   
 In some situations, it is not practical to invoke tracing via form parameters. For this  
 situation, you can turn on emergency tracing by invoking the L</Emergency> method from  
 a web page. Emergency tracing is detected via a file with the name  
 C<Emergency>I<IPaddr>C<.txt> in the FIG temporary directory, where I<IPaddr> is the  
 IP address of the remote user who wants tracing turned on. The file contains a time  
 limit in hours on the first line, a tracing destination on the second line, a trace  
 level on the third line, and the tracing modules on subsequent lines.  
2543    
2544  =over 4  =over 4
2545    
2546  =item noTrace (optional)  =item dirName
2547    
2548  If specified, tracing will be suppressed. This is useful if the script wants to set up  Name of the directory to process.
 tracing manually.  
2549    
2550  =item RETURN  =item group
2551    
2552  Returns a two-element list consisting of a CGI query object and a variable hash for  Name of the group to be assigned.
2553  the output page.  
2554    =item mask
2555    
2556    Permission mask. Bits that are C<1> in this mask will be ORed into the
2557    permission bits of any file or directory that does not already have them
2558    set to 1.
2559    
2560    =item otherMasks
2561    
2562    Map of search patterns to permission masks. If a directory name matches
2563    one of the patterns, that directory and all its members and subdirectories
2564    will be assigned the new pattern. For example, the following would
2565    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2566    
2567        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2568    
2569    The list is ordered, so the following would use 0777 for C<tmp1> and
2570    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2571    
2572        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2573                                                       '^tmp' => 0666);
2574    
2575    Note that the pattern matches are all case-insensitive, and only directory
2576    names are matched, not file names.
2577    
2578  =back  =back
2579    
2580  =cut  =cut
2581    
2582  sub ScriptSetup {  sub SetPermissions {
2583      # Get the parameters.      # Get the parameters.
2584      my ($noTrace) = @_;      my ($dirName, $group, $mask, @otherMasks) = @_;
2585      # Get the CGI query object.      # Set up for error recovery.
2586      my $cgi = CGI->new();      eval {
2587      # Set up tracing if it's not suppressed.          # Switch to the specified directory.
2588      CGITrace($cgi) unless $noTrace;          ChDir($dirName);
2589      # Create the variable hash.          # Get the group ID.
2590      my $varHash = { results => '' };          my $gid = getgrnam($group);
2591      # Return the query object and variable hash.          # Get the mask for tracing.
2592      return ($cgi, $varHash);          my $traceMask = sprintf("%04o", $mask) . "($mask)";
2593            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2594            my $fixCount = 0;
2595            my $lookCount = 0;
2596            # @dirs will be a stack of directories to be processed.
2597            my @dirs = (getcwd());
2598            while (scalar(@dirs) > 0) {
2599                # Get the current directory.
2600                my $dir = pop @dirs;
2601                # Check for a match to one of the specified directory names. To do
2602                # that, we need to pull the individual part of the name off of the
2603                # whole path.
2604                my $simpleName = $dir;
2605                if ($dir =~ m!/([^/]+)$!) {
2606                    $simpleName = $1;
2607                }
2608                Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2609                # Search for a match.
2610                my $match = 0;
2611                my $i;
2612                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2613                    my $pattern = $otherMasks[$i];
2614                    if ($simpleName =~ /$pattern/i) {
2615                        $match = 1;
2616                    }
2617                }
2618                # Check for a match. Note we use $i-1 because the loop added 2
2619                # before terminating due to the match.
2620                if ($match && $otherMasks[$i-1] != $mask) {
2621                    # This directory matches one of the incoming patterns, and it's
2622                    # a different mask, so we process it recursively with that mask.
2623                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2624                } else {
2625                    # Here we can process normally. Get all of the non-hidden members.
2626                    my @submems = OpenDir($dir, 1);
2627                    for my $submem (@submems) {
2628                        # Get the full name.
2629                        my $thisMem = "$dir/$submem";
2630                        Trace("Checking member $thisMem.") if T(4);
2631                        $lookCount++;
2632                        if ($lookCount % 1000 == 0) {
2633                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2634                        }
2635                        # Fix the group.
2636                        chown -1, $gid, $thisMem;
2637                        # Insure this member is not a symlink.
2638                        if (! -l $thisMem) {
2639                            # Get its info.
2640                            my $fileInfo = stat $thisMem;
2641                            # Only proceed if we got the info. Otherwise, it's a hard link
2642                            # and we want to skip it anyway.
2643                            if ($fileInfo) {
2644                                my $fileMode = $fileInfo->mode;
2645                                if (($fileMode & $mask) != $mask) {
2646                                    # Fix this member.
2647                                    $fileMode |= $mask;
2648                                    chmod $fileMode, $thisMem;
2649                                    $fixCount++;
2650                                }
2651                                # If it's a subdirectory, stack it.
2652                                if (-d $thisMem) {
2653                                    push @dirs, $thisMem;
2654                                }
2655                            }
2656                        }
2657                    }
2658                }
2659            }
2660            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2661        };
2662        # Check for an error.
2663        if ($@) {
2664            Confess("SetPermissions error: $@");
2665        }
2666  }  }
2667    
2668  =head3 CGITrace  =head3 GetLine
2669    
2670  C<< Tracer::CGITrace($cgi); >>      my @data = Tracer::GetLine($handle);
2671    
2672  Set up tracing for a CGI script. See L</ScriptSetup> for more information.  Read a line of data from a tab-delimited file.
2673    
2674  =over 4  =over 4
2675    
2676  =item cgi  =item handle
2677    
2678    Open file handle from which to read.
2679    
2680    =item RETURN
2681    
2682  Ths CGI query object for this script.  Returns a list of the fields in the record read. The fields are presumed to be
2683    tab-delimited. If we are at the end of the file, then an empty list will be
2684    returned. If an empty line is read, a single list item consisting of a null
2685    string will be returned.
2686    
2687  =back  =back
2688    
2689  =cut  =cut
2690    
2691  sub CGITrace {  sub GetLine {
2692      # Get the parameters.      # Get the parameters.
2693      my ($cgi) = @_;      my ($handle) = @_;
2694      # Default to no tracing except errors.      # Declare the return variable.
2695      my ($tracing, $dest) = ("0", "WARN");      my @retVal = ();
2696      # Check for emergency tracing.      Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2697      my $ip = EmergencyIP($cgi);      # Read from the file.
2698      my $emergencyFile = EmergencyFileName($ip);      my $line = <$handle>;
2699      if (-e $emergencyFile) {      # Only proceed if we found something.
2700          # We have the file. Read in the data.      if (defined $line) {
2701          my @tracing = GetFile($emergencyFile);          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2702          # Pull off the time limit.          # upload control and have a nonstandard EOL combination.
2703          my $expire = shift @tracing;          $line =~ s/(\r|\n)+$//;
2704          # Convert it to seconds.          # Here we do some fancy tracing to help in debugging complicated EOL marks.
2705          $expire *= 3600;          if (T(File => 4)) {
2706          # Check the file data.              my $escapedLine = $line;
2707          my $stat = stat($emergencyFile);              $escapedLine =~ s/\n/\\n/g;
2708          my ($now) = gettimeofday;              $escapedLine =~ s/\r/\\r/g;
2709          if ($now - $stat->mtime > $expire) {              $escapedLine =~ s/\t/\\t/g;
2710              # Delete the expired file.              Trace("Line read: -->$escapedLine<--");
2711              unlink $emergencyFile;          }
2712            # If the line is empty, return a single empty string; otherwise, parse
2713            # it into fields.
2714            if ($line eq "") {
2715                push @retVal, "";
2716          } else {          } else {
2717              # Emergency tracing is on. Pull off the destination and              push @retVal, split /\t/,$line;
             # the trace level;  
             $dest = shift @tracing;  
             my $level = shift @tracing;  
             # Convert the destination to a real tracing destination.  
             # temp directory.  
             $dest = EmergencyTracingDest($ip, $dest);  
             # Insure Tracer is specified.  
             my %moduleHash = map { $_ => 1 } @tracing;  
             $moduleHash{Tracer} = 1;  
             # Set the trace parameter.  
             $tracing = join(" ", $level, sort keys %moduleHash);  
             # Make sure the script knows tracing is on.  
             $cgi->param(-name => 'Trace', -value => $tracing);  
             $cgi->param(-name => 'TF', -value => (($dest =~ /^>/) ? 1 : 0));  
2718          }          }
2719      } elsif ($cgi->param('Trace')) {      } else {
2720          # Here the user has requested tracing via a form.          # Trace the reason the read failed.
2721          $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");          Trace("End of file: $!") if T(File => 3);
         $tracing = $cgi->param('Trace') . " Tracer";  
2722      }      }
2723      # Setup the tracing we've determined from all the stuff above.      # Return the result.
2724      TSetup($tracing, $dest);      return @retVal;
     # Trace the parameter and environment data.  
     TraceParms($cgi);  
2725  }  }
2726    
2727  =head3 EmergencyFileName  =head3 PutLine
2728    
2729  C<< my $fileName = Tracer::EmergencyFileName($ip); >>      Tracer::PutLine($handle, \@fields, $eol);
2730    
2731  Return the emergency tracing file name. This is the file that specifies  Write a line of data to a tab-delimited file. The specified field values will be
2732  the tracing information.  output in tab-separated form, with a trailing new-line.
2733    
2734  =over 4  =over 4
2735    
2736  =item ip  =item handle
2737    
2738    Output file handle.
2739    
2740    =item fields
2741    
2742  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  List of field values.
 method.  
2743    
2744  =item RETURN  =item eol (optional)
2745    
2746  Returns the name of the file to contain the emergency tracing information.  End-of-line character (default is "\n").
2747    
2748  =back  =back
2749    
2750  =cut  =cut
2751    
2752  sub EmergencyFileName {  sub PutLine {
2753      # Get the parameters.      # Get the parameters.
2754      my ($ip) = @_;      my ($handle, $fields, $eol) = @_;
2755      # Compute the emergency tracing file name.      # Write the data.
2756      return "$FIG_Config::temp/Emergency$ip.txt";      print $handle join("\t", @{$fields}) . ($eol || "\n");
2757  }  }
2758    
 =head3 EmergencyFileTarget  
   
 C<< my $fileName = Tracer::EmergencyFileTarget($ip); >>  
2759    
2760  Return the emergency tracing target file name. This is the file that receives  =head3 PrintLine
 the tracing output for file-based tracing.  
2761    
2762  =over 4      Tracer::PrintLine($line);
2763    
2764  =item ip  Print a line of text with a trailing new-line.
2765    
2766  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  =over 4
 method.  
2767    
2768  =item RETURN  =item line
2769    
2770  Returns the name of the file to contain the emergency tracing information.  Line of text to print.
2771    
2772  =back  =back
2773    
2774  =cut  =cut
2775    
2776  sub EmergencyFileTarget {  sub PrintLine {
2777      # Get the parameters.      # Get the parameters.
2778      my ($ip) = @_;      my ($line) = @_;
2779      # Compute the emergency tracing file name.      # Print the line.
2780      return "$FIG_Config::temp/Emergency$ip.log";      print "$line\n";
2781  }  }
2782    
 =head3 EmergencyTracingDest  
2783    
2784  C<< my $dest = Tracer::EmergencyTracingDest($ip, $myDest); >>  =head2 Other Useful Methods
2785    
2786  This method converts an emergency tracing destination to a real  =head3 ParseParm
 tracing destination. The main difference is that if the  
 destination is C<FILE> or C<APPEND>, we convert it to file  
 output.  
2787    
2788  =over 4      my $listValue = Tracer::ParseParm($string);
2789    
2790  =item ip  Convert a parameter into a list reference. If the parameter is undefined,
2791    an undefined value will be returned. Otherwise, it will be parsed as a
2792    comma-separated list of values.
2793    
2794  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  =over 4
 method.  
2795    
2796  =item myDest  =item string
2797    
2798  Destination from the emergency tracing file.  Incoming string.
2799    
2800  =item RETURN  =item RETURN
2801    
2802  Returns a destination that can be passed into L</TSetup>.  Returns a reference to a list of values, or C<undef> if the incoming value
2803    was undefined.
2804    
2805  =back  =back
2806    
2807  =cut  =cut
2808    
2809  sub EmergencyTracingDest {  sub ParseParm {
2810      # Get the parameters.      # Get the parameters.
2811      my ($ip, $myDest) = @_;      my ($string) = @_;
2812      # Declare the return variable.      # Declare the return variable.
2813      my $retVal;      my $retVal;
2814      # Process according to the destination value.      # Check for data.
2815      if ($myDest eq 'FILE') {      if (defined $string) {
2816          $retVal = ">" . EmergencyFileTarget($ip);          # We have some, so split it into a list.
2817      } elsif ($myDest eq 'APPEND') {          $retVal = [ split /\s*,\s*/, $string];
         $retVal = ">>" . EmergencyFileTarget($ip);  
     } else {  
         $retVal = $myDest;  
2818      }      }
2819      # Return the result.      # Return the result.
2820      return $retVal;      return $retVal;
2821  }  }
2822    
2823  =head3 Emergency  =head3 Now
   
 C<< Emergency($cgi, $hours, $dest, $level, @modules); >>  
2824    
2825  Turn on emergency tracing. This method can only be invoked over the web and is      my $string = Tracer::Now();
 should not be called if debug mode is off. The caller specifies the duration of the  
 emergency in hours, the desired tracing destination, the trace level,  
 and a list of the trace modules to activate. For the duration, when a user  
 from the specified remote web location invokes a Sprout CGI script, tracing  
 will be turned on automatically. See L</TSetup> for more about tracing  
 setup and L</ScriptSetup> for more about emergency tracing.  
2826    
2827  =over 4  Return a displayable time stamp containing the local time. Whatever format this
2828    method produces must be parseable by L</ParseDate>.
2829    
2830  =item cgi  =cut
2831    
2832  A CGI query object.  sub Now {
2833        return DisplayTime(time);
2834    }
2835    
2836  =item hours  =head3 DisplayTime
2837    
2838  Number of hours to keep emergency tracing alive.      my $string = Tracer::DisplayTime($time);
2839    
2840  =item dest  Convert a time value to a displayable time stamp. Whatever format this
2841    method produces must be parseable by L</ParseDate>.
2842    
2843  Tracing destination. If no path information is specified for a file  =over 4
 destination, it is put in the FIG temporary directory.  
2844    
2845  =item level  =item time
2846    
2847  Tracing level. A higher level means more trace messages.  Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
2848    
2849  =item modules  =item RETURN
2850    
2851  A list of the tracing modules to activate.  Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
2852    
2853  =back  =back
2854    
2855  =cut  =cut
2856    
2857  sub Emergency {  sub DisplayTime {
2858      # Get the parameters.      my ($time) = @_;
2859      my ($cgi, $hours, $dest, $level, @modules) = @_;      my $retVal = "(n/a)";
2860      # Get the IP address.      if (defined $time) {
2861      my $ip = EmergencyIP($cgi);          my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
2862      # Create the emergency file.          $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
2863      my $specFile = EmergencyFileName($ip);                    _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
2864      my $outHandle = Open(undef, ">$specFile");      }
2865      print $outHandle join("\n",$hours, $dest, $level, @modules, "");      return $retVal;
2866  }  }
2867    
2868  =head3 EmergencyIP  # Pad a number to 2 digits.
2869    sub _p2 {
2870        my ($value) = @_;
2871        $value = "0$value" if ($value < 10);
2872        return $value;
2873    }
2874    
2875    =head3 Escape
2876    
2877  C<< my $ip = EmergencyIP($cgi); >>      my $codedString = Tracer::Escape($realString);
2878    
2879  Return the IP address to be used for emergency tracing. If at smoe point we need  Escape a string for use in a command. Tabs will be replaced by C<\t>, new-lines
2880  to change the way we compute the IP address, or we decide to use something else,  replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
2881  all we need to do is change this method.  result is to reverse the effect of L</UnEscape>.
2882    
2883  =over 4  =over 4
2884    
2885  =item cgi  =item realString
2886    
2887  CGI query object.  String to escape.
2888    
2889  =item RETURN  =item RETURN
2890    
2891  Returns the IP address to be used for labelling emergency tracing.  Escaped equivalent of the real string.
2892    
2893  =back  =back
2894    
2895  =cut  =cut
2896    
2897  sub EmergencyIP {  sub Escape {
2898      # Get the parameters.      # Get the parameter.
2899      my ($cgi) = @_;      my ($realString) = @_;
2900        # Initialize the return variable.
2901        my $retVal = "";
2902        # Loop through the parameter string, looking for sequences to escape.
2903        while (length $realString > 0) {
2904            # Look for the first sequence to escape.
2905            if ($realString =~ /^(.*?)([\n\t\r\\])/) {
2906                # Here we found it. The text preceding the sequence is in $1. The sequence
2907                # itself is in $2. First, move the clear text to the return variable.
2908                $retVal .= $1;
2909                # Strip the processed section off the real string.
2910                $realString = substr $realString, (length $2) + (length $1);
2911                # Get the matched character.
2912                my $char = $2;
2913                # If we have a CR, we are done.
2914                if ($char ne "\r") {
2915                    # It's not a CR, so encode the escape sequence.
2916                    $char =~ tr/\t\n/tn/;
2917                    $retVal .= "\\" . $char;
2918                }
2919            } else {
2920                # Here there are no more escape sequences. The rest of the string is
2921                # transferred unmodified.
2922                $retVal .= $realString;
2923                $realString = "";
2924            }
2925        }
2926      # Return the result.      # Return the result.
2927      return $cgi->remote_addr();      return $retVal;
2928  }  }
2929    
2930    =head3 UnEscape
2931    
2932  =head3 TraceParms      my $realString = Tracer::UnEscape($codedString);
   
 C<< Tracer::TraceParms($cgi); >>  
2933    
2934  Trace the CGI parameters at trace level CGI => 3 and the environment variables  Replace escape sequences with their actual equivalents. C<\t> will be replaced by
2935  at level CGI => 4.  a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will
2936    be deleted.
2937    
2938  =over 4  =over 4
2939    
2940  =item cgi  =item codedString
2941    
2942  CGI query object containing the parameters to trace.  String to un-escape.
2943    
2944    =item RETURN
2945    
2946    Returns a copy of the original string with the escape sequences converted to their actual
2947    values.
2948    
2949  =back  =back
2950    
2951  =cut  =cut
2952    
2953  sub TraceParms {  sub UnEscape {
2954      # Get the parameters.      # Get the parameter.
2955      my ($cgi) = @_;      my ($codedString) = @_;
2956      if (T(CGI => 3)) {      # Initialize the return variable.
2957          # Here we want to trace the parameter data.      my $retVal = "";
2958          my @names = $cgi->param;      # Only proceed if the incoming string is nonempty.
2959          for my $parmName (sort @names) {      if (defined $codedString) {
2960              # Note we skip the Trace parameters, which are for our use only.          # Loop through the parameter string, looking for escape sequences. We can't do
2961              if ($parmName ne 'Trace' && $parmName ne 'TF') {          # translating because it causes problems with the escaped slash. ("\\t" becomes
2962                  my @values = $cgi->param($parmName);          # "\<tab>" no matter what we do.)
2963                  Trace("CGI: $parmName = " . join(", ", @values));          while (length $codedString > 0) {
2964              }              # Look for the first escape sequence.
2965                if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {
2966                    # Here we found it. The text preceding the sequence is in $1. The sequence
2967                    # itself is in $2. First, move the clear text to the return variable.
2968                    $retVal .= $1;
2969                    $codedString = substr $codedString, (2 + length $1);
2970                    # Get the escape value.
2971                    my $char = $2;
2972                    # If we have a "\r", we are done.
2973                    if ($char ne 'r') {
2974                        # Here it's not an 'r', so we convert it.
2975                        $char =~ tr/\\tn/\\\t\n/;
2976                        $retVal .= $char;
2977          }          }
2978          # Display the request method.              } else {
2979          my $method = $cgi->request_method();                  # Here there are no more escape sequences. The rest of the string is
2980          Trace("Method: $method");                  # transferred unmodified.
2981                    $retVal .= $codedString;
2982                    $codedString = "";
2983      }      }
     if (T(CGI => 4)) {  
         # Here we want the environment data too.  
         for my $envName (sort keys %ENV) {  
             Trace("ENV: $envName = $ENV{$envName}");  
2984          }          }
2985      }      }
2986        # Return the result.
2987        return $retVal;
2988  }  }
2989    
2990  =head3 ScriptFinish  =head3 Percent
2991    
2992  C<< ScriptFinish($webData, $varHash); >>      my $percent = Tracer::Percent($number, $base);
2993    
2994  Output a web page at the end of a script. Either the string to be output or the  Returns the percent of the base represented by the given number. If the base
2995  name of a template file can be specified. If the second parameter is omitted,  is zero, returns zero.
 it is assumed we have a string to be output; otherwise, it is assumed we have the  
 name of a template file. The template should have the variable C<DebugData>  
 specified in any form that invokes a standard script. If debugging mode is turned  
 on, a form field will be put in that allows the user to enter tracing data.  
 Trace messages will be placed immediately before the terminal C<BODY> tag in  
 the output, formatted as a list.  
2996    
2997  A typical standard script would loook like the following.  =over 4
2998    
2999      BEGIN {  =item number
3000          # Print the HTML header.  
3001          print "CONTENT-TYPE: text/html\n\n";  Percent numerator.
3002    
3003    =item base
3004    
3005    Percent base.
3006    
3007    =item RETURN
3008    
3009    Returns the percentage of the base represented by the numerator.
3010    
3011    =back
3012    
3013    =cut
3014    
3015    sub Percent {
3016        # Get the parameters.
3017        my ($number, $base) = @_;
3018        # Declare the return variable.
3019        my $retVal = 0;
3020        # Compute the percent.
3021        if ($base != 0) {
3022            $retVal = $number * 100 / $base;
3023        }
3024        # Return the result.
3025        return $retVal;
3026      }      }
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
3027    
3028      my ($cgi, $varHash) = ScriptSetup();  =head3 Constrain
3029      eval {  
3030          # ... get data from $cgi, put it in $varHash ...      my $constrained = Constrain($value, $min, $max);
3031      };  
3032      if ($@) {  Modify a numeric value to bring it to a point in between a maximum and a minimum.
3033          Trace("Script Error: $@") if T(0);  
3034    =over 4
3035    
3036    =item value
3037    
3038    Value to constrain.
3039    
3040    =item min (optional)
3041    
3042    Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3043    
3044    =item max (optional)
3045    
3046    Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3047    
3048    =item RETURN
3049    
3050    Returns the incoming value, constrained according to the other parameters.
3051    
3052    =back
3053    
3054    =cut
3055    
3056    sub Constrain {
3057        # Get the parameters.
3058        my ($value, $min, $max) = @_;
3059        # Declare the return variable.
3060        my $retVal = $value;
3061        # Apply the minimum constraint.
3062        if (defined $min && $retVal < $min) {
3063            $retVal = $min;
3064        }
3065        # Apply the maximum constraint.
3066        if (defined $max && $retVal > $max) {
3067            $retVal = $max;
3068        }
3069        # Return the result.
3070        return $retVal;
3071      }      }
     ScriptFinish("Html/MyTemplate.html", $varHash);  
3072    
3073  The idea here is that even if the script fails, you'll see trace messages and  =head3 Min
3074  useful output.  
3075        my $min = Min($value1, $value2, ... $valueN);
3076    
3077    Return the minimum argument. The arguments are treated as numbers.
3078    
3079  =over 4  =over 4
3080    
3081  =item webData  =item $value1, $value2, ... $valueN
3082    
3083  A string containing either the full web page to be written to the output or the  List of numbers to compare.
 name of a template file from which the page is to be constructed. If the name  
 of a template file is specified, then the second parameter must be present;  
 otherwise, it must be absent.  
3084    
3085  =item varHash (optional)  =item RETURN
3086    
3087  If specified, then a reference to a hash mapping variable names for a template  Returns the lowest number in the list.
 to their values. The template file will be read into memory, and variable markers  
 will be replaced by data in this hash reference.  
3088    
3089  =back  =back
3090    
3091  =cut  =cut
3092    
3093  sub ScriptFinish {  sub Min {
3094      # Get the parameters.      # Get the parameters. Note that we prime the return value with the first parameter.
3095      my ($webData, $varHash) = @_;      my ($retVal, @values) = @_;
3096      # Check for a template file situation.      # Loop through the remaining parameters, looking for the lowest.
3097      my $outputString;      for my $value (@values) {
3098      if (defined $varHash) {          if ($value < $retVal) {
3099          # Here we have a template file. We need to determine the template type.              $retVal = $value;
         my $template;  
         if ($FIG_Config::template_url && $webData =~ /\.php$/) {  
             $template = "$FIG_Config::template_url/$webData";  
         } else {  
             $template = "<<$webData";  
         }  
         $outputString = PageBuilder::Build($template, $varHash, "Html");  
     } else {  
         # Here the user gave us a raw string.  
         $outputString = $webData;  
     }  
     # Check for trace messages.  
     if ($Destination ne "NONE" && $TraceLevel > 0) {  
         # We have trace messages, so we want to put them at the end of the body. This  
         # is either at the end of the whole string or at the beginning of the BODY  
         # end-tag.  
         my $pos = length $outputString;  
         if ($outputString =~ m#</body>#gi) {  
             $pos = (pos $outputString) - 7;  
         }  
         # If the trace messages were queued, we unroll them. Otherwise, we display the  
         # destination.  
         my $traceHtml;  
         if ($Destination eq "QUEUE") {  
             $traceHtml = QTrace('Html');  
         } elsif ($Destination =~ /^>>(.+)$/) {  
             # Here the tracing output it to a file. We code it as a hyperlink so the user  
             # can copy the file name into the clipboard easily.  
             my $actualDest = $1;  
             $traceHtml = "<p>Tracing output to <a href=\"$actualDest\">$actualDest</a>.</p>\n";  
         } else {  
             # Here we have one of the special destinations.  
             $traceHtml = "<P>Tracing output type is $Destination.</p>\n";  
3100          }          }
         substr $outputString, $pos, 0, $traceHtml;  
3101      }      }
3102      # Write the output string.      # Return the minimum found.
3103      print $outputString;      return $retVal;
3104  }  }
3105    
3106  =head3 Insure  =head3 Max
3107    
3108  C<< Insure($dirName); >>      my $max = Max($value1, $value2, ... $valueN);
3109    
3110  Insure a directory is present.  Return the maximum argument. The arguments are treated as numbers.
3111    
3112  =over 4  =over 4
3113    
3114  =item dirName  =item $value1, $value2, ... $valueN
3115    
3116  Name of the directory to check. If it does not exist, it will be created.  List of numbers to compare.
3117    
3118    =item RETURN
3119    
3120    Returns the highest number in the list.
3121    
3122  =back  =back
3123    
3124  =cut  =cut
3125    
3126  sub Insure {  sub Max {
3127      my ($dirName) = @_;      # Get the parameters. Note that we prime the return value with the first parameter.
3128      if (! -d $dirName) {      my ($retVal, @values) = @_;
3129          Trace("Creating $dirName directory.") if T(2);      # Loop through the remaining parameters, looking for the highest.
3130          eval { mkpath $dirName; };      for my $value (@values) {
3131          if ($@) {          if ($value > $retVal) {
3132              Confess("Error creating $dirName: $@");              $retVal = $value;
3133          }          }
3134      }      }
3135        # Return the maximum found.
3136        return $retVal;
3137  }  }
3138    
 =head3 ChDir  
3139    
3140  C<< ChDir($dirName); >>  =head3 Strip
3141    
3142        my $string = Tracer::Strip($line);
3143    
3144  Change to the specified directory.  Strip all line terminators off a string. This is necessary when dealing with files
3145    that may have been transferred back and forth several times among different
3146    operating environments.
3147    
3148  =over 4  =over 4
3149    
3150  =item dirName  =item line
3151    
3152  Name of the directory to which we want to change.  Line of text to be stripped.
3153    
3154    =item RETURN
3155    
3156    The same line of text with all the line-ending characters chopped from the end.
3157    
3158  =back  =back
3159    
3160  =cut  =cut
3161    
3162  sub ChDir {  sub Strip {
3163      my ($dirName) = @_;      # Get a copy of the parameter string.
3164      if (! -d $dirName) {      my ($string) = @_;
3165          Confess("Cannot change to directory $dirName: no such directory.");      my $retVal = (defined $string ? $string : "");
3166      } else {      # Strip the line terminator characters.
3167          Trace("Changing to directory $dirName.") if T(4);      $retVal =~ s/(\r|\n)+$//g;
3168          my $okFlag = chdir $dirName;      # Return the result.
3169          if (! $okFlag) {      return $retVal;
             Confess("Error switching to directory $dirName.");  
         }  
     }  
3170  }  }
3171    
3172  =head3 SendSMS  =head3 Pad
3173    
3174  C<< my $msgID = Tracer::SendSMS($phoneNumber, $msg); >>      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
3175    
3176  Send a text message to a phone number using Clickatell. The FIG_Config file must contain the  Pad a string to a specified length. The pad character will be a
3177  user name, password, and API ID for the relevant account in the hash reference variable  space, and the padding will be on the right side unless specified
3178  I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For  in the third parameter.
 example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID  
 is C<2561022>, then the FIG_Config file must contain  
3179    
3180      $phone =  { user => 'BruceTheHumanPet',  =over 4
                 password => 'silly',  
                 api_id => '2561022' };  
3181    
3182  The original purpose of this method was to insure Bruce would be notified immediately when the  =item string
 Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately  
 when you call this method.  
3183    
3184  The message ID will be returned if successful, and C<undef> if an error occurs.  String to be padded.
3185    
3186  =over 4  =item len
3187    
3188  =item phoneNumber  Desired length of the padded string.
3189    
3190  Phone number to receive the message, in international format. A United States phone number  =item left (optional)
 would be prefixed by "1". A British phone number would be prefixed by "44".  
3191    
3192  =item msg  TRUE if the string is to be left-padded; otherwise it will be padded on the right.
3193    
3194  Message to send to the specified phone.  =item padChar (optional)
3195    
3196    Character to use for padding. The default is a space.
3197    
3198  =item RETURN  =item RETURN
3199    
3200  Returns the message ID if successful, and C<undef> if the message could not be sent.  Returns a copy of the original string with the pad character added to the
3201    specified end so that it achieves the desired length.
3202    
3203  =back  =back
3204    
3205  =cut  =cut
3206    
3207  sub SendSMS {  sub Pad {
3208      # Get the parameters.      # Get the parameters.
3209      my ($phoneNumber, $msg) = @_;      my ($string, $len, $left, $padChar) = @_;
3210      # Declare the return variable. If we do not change it, C<undef> will be returned.      # Compute the padding character.
3211      my $retVal;      if (! defined $padChar) {
3212      # Only proceed if we have phone support.          $padChar = " ";
3213      if (! defined $FIG_Config::phone) {      }
3214          Trace("Phone support not present in FIG_Config.") if T(1);      # Compute the number of spaces needed.
3215      } else {      my $needed = $len - length $string;
3216          # Get the phone data.      # Copy the string into the return variable.
3217          my $parms = $FIG_Config::phone;      my $retVal = $string;
3218          # Get the Clickatell URL.      # Only proceed if padding is needed.
3219          my $url = "http://api.clickatell.com/http/";      if ($needed > 0) {
3220          # Create the user agent.          # Create the pad string.
3221          my $ua = LWP::UserAgent->new;          my $pad = $padChar x $needed;
3222          # Request a Clickatell session.          # Affix it to the return value.
3223          my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},          if ($left) {
3224                                       password => $parms->{password},              $retVal = $pad . $retVal;
                                      api_id => $parms->{api_id},  
                                      to => $phoneNumber,  
                                      text => $msg});  
         # Check for an error.  
         if (! $resp->is_success) {  
             Trace("Alert failed.") if T(1);  
         } else {  
             # Get the message ID.  
             my $rstring = $resp->content;  
             if ($rstring =~ /^ID:\s+(.*)$/) {  
                 $retVal = $1;  
3225              } else {              } else {
3226                  Trace("Phone attempt failed with $rstring") if T(1);              $retVal .= $pad;
3227              }              }
3228          }          }
3229        # Return the result.
3230        return $retVal;
3231    }
3232    
3233    =head3 EOF
3234    
3235    This is a constant that is lexically greater than any useful string.
3236    
3237    =cut
3238    
3239    sub EOF {
3240        return "\xFF\xFF\xFF\xFF\xFF";
3241    }
3242    
3243    =head3 TICK
3244    
3245        my @results = TICK($commandString);
3246    
3247    Perform a back-tick operation on a command. If this is a Windows environment, any leading
3248    dot-slash (C<./> will be removed. So, for example, if you were doing
3249    
3250        `./protein.cgi`
3251    
3252    from inside a CGI script, it would work fine in Unix, but would issue an error message
3253    in Windows complaining that C<'.'> is not a valid command. If instead you code
3254    
3255        TICK("./protein.cgi")
3256    
3257    it will work correctly in both environments.
3258    
3259    =over 4
3260    
3261    =item commandString
3262    
3263    The command string to pass to the system.
3264    
3265    =item RETURN
3266    
3267    Returns the standard output from the specified command, as a list.
3268    
3269    =back
3270    
3271    =cut
3272    #: Return Type @;
3273    sub TICK {
3274        # Get the parameters.
3275        my ($commandString) = @_;
3276        # Chop off the dot-slash if this is Windows.
3277        if ($FIG_Config::win_mode) {
3278