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

Legend:
Removed from v.1.29  
changed lines
  Added in v.1.98

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3