[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.45, Mon May 8 20:37:02 2006 UTC revision 1.92, Thu Dec 6 13:59:04 2007 UTC
# Line 19  Line 19 
19    
20      require Exporter;      require Exporter;
21      @ISA = ('Exporter');      @ISA = ('Exporter');
22      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup ScriptSetup ScriptFinish Insure ChDir);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);
23      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
26      use CGI;      use CGI;
27        use Cwd;
28      use FIG_Config;      use FIG_Config;
29      use PageBuilder;      use PageBuilder;
30      use Digest::MD5;      use Digest::MD5;
31      use File::Basename;      use File::Basename;
32      use File::Path;      use File::Path;
33        use File::stat;
34        use LWP::UserAgent;
35        use Time::HiRes 'gettimeofday';
36        use URI::Escape;
37        use Time::Local;
38    
39  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
40    
41  =head2 Introduction  =head2 Tracing
42    
43  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
44  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.
45  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,
46  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
47  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
48  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
49  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
50  appear. To generate a trace message, use the following syntax.  appear.
51    
52  C<< Trace($message) if T(errors => 4); >>  =head3 Putting Trace Messages in Your Code
53    
54    To generate a trace message, use the following syntax.
55    
56        Trace($message) if T(errors => 4);
57    
58  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>
59  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
60    
61  C<< Trace($message) if T(main => 4); >>      Trace($message) if T(main => 4);
62    
63  will trace if the trace level is 4 or more.  will trace if the trace level is 4 or more.
64    
# Line 56  Line 66 
66  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
67  active and the trace level is 2 or more.  active and the trace level is 2 or more.
68    
69  C<< Trace($message) if T(2); >>      Trace($message) if T(2);
70    
71    In scripts, where no package name is available, the category defaults to C<main>.
72    
73    =head3 Custom Tracing
74    
75  To set up tracing, you call the L</TSetup> method. The method takes as input a trace level, a list  Many programs have customized tracing configured using the L</TSetup> method. This is no longer
76  of category names, and a set of options. The trace level and list of category names are  the preferred method, but a knowledge of how custom tracing works can make the more modern
77    L</Emergency Tracing> easier to understand.
78    
79    To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
80    a list of category names, and a destination. The trace level and list of category names are
81  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
82    
83  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
84    
85  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
86  specifies that messages should be output as HTML paragraphs.  specifies that messages should be sent to the standard output.
87    
88  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
89  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
90  useful in a CGI environment.  useful in a CGI environment.
91    
92  C<< TSetup('3 *', 'WARN'); >>      TSetup('3 *', 'WARN');
93    
94  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
95  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
96  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
97  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
98  it easier to debug page formatting problems.  it easier to debug page formatting problems.
99    
100  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
101    a file at the same time. To trace to a file, specify the filename with an output character in front
102    of it.
103    
104        TSetup('4 SQL', ">$fileName");
105    
106    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
107    bracket.
108    
109        TSetup('3 *', "+>$fileName");
110    
111  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>.
112  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.
113  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
114  being used out in the field.  being used out in the field.
115    
116    =head3 Trace Levels
117    
118  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
119  a suggestion.  a suggestion.
120    
# Line 116  Line 145 
145    
146  =back  =back
147    
148    The format of trace messages is important because some utilities analyze trace files.
149    There are three fields-- the time stamp, the category name, and the text.
150    The time stamp is between square brackets and the category name between angle brackets.
151    After the category name there is a colon (C<:>) followed by the message text.
152    If the square brackets or angle brackets are missing, then the trace management
153    utilities assume that they are encountering a set of pre-formatted lines.
154    
155    Note, however, that this formatting is done automatically by the tracing functions. You
156    only need to know about it if you want to parse a trace file.
157    
158    =head3 Emergency Tracing
159    
160    Sometimes, you need a way for tracing to happen automatically without putting parameters
161    in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
162    from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.
163    Emergency tracing requires you specify a tracing key. For command-line tools, the key is
164    taken from the C<TRACING> environment variable. For web services, the key is taken from
165    a cookie. Either way, the key tells the tracing facility who you are, so that you control
166    the tracing in your environment without stepping on other users.
167    
168    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
169    generate one for you.
170    
171    You can activate and de-activate emergency tracing from the debugging control panel, as
172    well as display the trace file itself.
173    
174    To enable emergency tracing in your code, call
175    
176        ETracing($cgi)
177    
178    from a web script and
179    
180        ETracing()
181    
182    from a command-line script.
183    
184    The web script will look for the tracing key in the cookies, and the command-line
185    script will look for it in the C<TRACING> environment variable. If you are
186    using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
187    will be configured automatically.
188    
189    NOTE: to configure emergency tracing from the command line instead of the Debugging
190    Control Panel (see below), use the C<trace.pl> script.
191    
192    =head3 Debugging Control Panel
193    
194    The debugging control panel provides several tools to assist in development of
195    SEED and Sprout software. You access the debugging control panel from the URL
196    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
197    for example, the panel access point for the development NMPDR system is
198    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
199    find out what the password is. From this page, you can also specify a tracing
200    key. If you don't specify a key, one will be generated for you.
201    
202    =head4 Emergency Tracing Form
203    
204    At the bottom of the debugging control panel is a form that allows you to
205    specify a trace level and tracing categories. Special and common categories
206    are listed with check boxes. You can hold your mouse over a check box to see
207    what its category does. In general, however, a category name is the same as
208    the name of the package in which the trace message occurs.
209    
210    Additional categories can be entered in an input box, delimited by spaces or commas.
211    
212    The B<Activate> button turns on Emergency tracing at the level you specify with the
213    specified categories active. The B<Terminate> button turns tracing off. The
214    B<Show File> button displays the current contents of the trace file. The tracing
215    form at the bottom of the control panel is designed for emergency tracing, so it
216    will only affect programs that call L</ETracing>, L</StandardScript>,
217    or L</StandardSetup>.
218    
219    =head4 Script Form
220    
221    The top form of the debugging control panel allows you to enter a tiny script and
222    have the output generated in a formatted table. Certain object variables are
223    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
224    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
225    
226    The last line of the script must be a scalar, but it can be a reference to a hash,
227    a list, a list of lists, and various other combinations. If you select the appropriate
228    data type in the dropdown box, the output will be formatted accordingly. The form
229    also has controls for specifying tracing. These controls override any emergency
230    tracing in effect.
231    
232    =head4 Database Query Forms
233    
234    The forms between the script form and the emergency tracing form allow you to
235    make queries against the database. The FIG query form allows simple queries against
236    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
237    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
238    package, and it takes five parameters.
239    
240        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
241    
242    Each of the five parameters corresponds to a text box on the query form:
243    
244    =over 4
245    
246    =item Objects
247    
248    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
249    
250    =item Filter
251    
252    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
253    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
254    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
255    field, I<objectName> is the name of the entity or relationship object containing the field, and
256    I<number> is the 1-based position of the object in the object list. Any parameters
257    specified in the filter clause should be specified in the B<Params> field.
258    The fields in a filter clause can come from primary entity relations,
259    relationship relations, or secondary entity relations; however, all of the
260    entities and relationships involved must be included in the list of object names.
261    
262    =item Params
263    
264    List of the parameters to be substituted in for the parameters marks in the filter clause. This
265    is a comma-separated list without any quoting or escaping.
266    
267    =item fields
268    
269    Comma-separated list of the fields to be returned in each element of the list returned. Fields
270    are specified in the same manner as in the filter clause.
271    
272    =item count
273    
274    Maximum number of records to return. If omitted or 0, all available records will be returned.
275    
276    =back
277    
278    B<GetAll> automatically joins together the entities and relationships listed in the object
279    names. This simplifies the coding of the filter clause, but it means that some queries are
280    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
281    that has yet to be addressed.
282    
283  =cut  =cut
284    
285  # Declare the configuration variables.  # Declare the configuration variables.
# Line 136  Line 300 
300    
301  =head3 TSetup  =head3 TSetup
302    
303  C<< TSetup($categoryList, $target); >>      TSetup($categoryList, $target);
304    
305  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
306  and interrogated by the L</Trace> and L</T> methods.  and interrogated by the L</Trace> and L</T> methods.
# Line 195  Line 359 
359          }          }
360          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
361              open TRACEFILE, $target;              open TRACEFILE, $target;
362              print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
363              close TRACEFILE;              close TRACEFILE;
364              $Destination = ">$target";              $Destination = ">$target";
365          } else {          } else {
# Line 210  Line 374 
374    
375  =head3 StandardSetup  =head3 StandardSetup
376    
377  C<< my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV); >>      my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV);
378    
379  This method performs standard command-line parsing and tracing setup. The return  This method performs standard command-line parsing and tracing setup. The return
380  values are a hash of the command-line options and a list of the positional  values are a hash of the command-line options and a list of the positional
# Line 228  Line 392 
392      ["Sprout", "SproutLoad", "ERDB"]      ["Sprout", "SproutLoad", "ERDB"]
393    
394  This would cause trace messages in the specified three packages to appear in  This would cause trace messages in the specified three packages to appear in
395  the output. There are threer special tracing categories that are automatically  the output. There are two special tracing categories that are automatically
396  handled by this method. In other words, if you used L</TSetup> you would need  handled by this method. In other words, if you used L</TSetup> you would need
397  to include these categories manually, but if you use this method they are turned  to include these categories manually, but if you use this method they are turned
398  on automatically.  on automatically.
399    
400  =over 4  =over 4
401    
 =item FIG  
   
 Turns on trace messages inside the B<FIG> package.  
   
402  =item SQL  =item SQL
403    
404  Traces SQL commands and activity.  Traces SQL commands and activity.
# Line 288  Line 448 
448                            noAlias => [0, "do not expect aliases in CHANGE transactions"],                            noAlias => [0, "do not expect aliases in CHANGE transactions"],
449                            start => [' ', "start with this genome"],                            start => [' ', "start with this genome"],
450                            tblFiles => [0, "output TBL files containing the corrected IDs"] },                            tblFiles => [0, "output TBL files containing the corrected IDs"] },
451                          "command transactionDirectory IDfile",                          "<command> <transactionDirectory> <IDfile>",
452                        @ARGV);                        @ARGV);
453    
454    
# Line 300  Line 460 
460    
461      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
462    
463    Single and double hyphens are equivalent. So, you could also code the
464    above command as
465    
466        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
467    
468  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
469  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
470  above code fragment. The tracing would be set to level 2, and the categories  above code fragment. The tracing would be set to level 2, and the categories
471  would be C<FIG>, C<Tracer>, and <DocUtils>. C<FIG> and C<Tracer> are standard,  would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
472  and C<DocUtils> was included because it came in within the first parameter  and C<DocUtils> was included because it came in within the first parameter
473  to this method. The I<$options> hash would be  to this method. The I<$options> hash would be
474    
# Line 328  Line 493 
493  C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to  C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
494  simplify starting a command in the background.  simplify starting a command in the background.
495    
496  Finally, if the special option C<-h> is specified, the option names will  The user name is also used as the tracing key for L</Emergency Tracing>.
497  be traced at level 0 and the program will exit without processing.  Specifying a value of C<E> for the trace level causes emergency tracing to
498    be used instead of custom tracing. If the user name is not specified,
499    the tracing key is taken from the C<Tracing> environment variable. If there
500    is no value for that variable, the tracing key will be computed from the PID.
501    
502    Finally, if the special option C<-help> is specified, the option
503    names will be traced at level 0 and the program will exit without processing.
504  This provides a limited help capability. For example, if the user enters  This provides a limited help capability. For example, if the user enters
505    
506      TransactFeatures -h      TransactFeatures -help
507    
508  he would see the following output.  he would see the following output.
509    
510      TransactFeatures [options] command transactionDirectory IDfile      TransactFeatures [options] <command> <transactionDirectory> <IDfile>
511          -trace    tracing level (default 2)          -trace    tracing level (default E)
512          -sql      trace SQL commands          -sql      trace SQL commands
513          -safe     use database transactions          -safe     use database transactions
514          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
# Line 352  Line 523 
523      { trace => [0, "tracing level (default 0)"],      { trace => [0, "tracing level (default 0)"],
524         ...         ...
525    
526  would set the default trace level to 0 instead of 2, while  would set the default trace level to 0 instead of E, while
527    
528      { trace => ["2-", "tracing level (default 2)"],      { trace => ["2-", "tracing level (default 2)"],
529         ...         ...
530    
531  would leave the default at 2, but trace only to the log file, not to the  would set the default to 2, but trace only to the log file, not to the
532  standard output.  standard output.
533    
534  The parameters to this method are as follows.  The parameters to this method are as follows.
# Line 404  Line 575 
575  sub StandardSetup {  sub StandardSetup {
576      # Get the parameters.      # Get the parameters.
577      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
578        # Get the default tracing key.
579        my $tkey = EmergencyKey();
580      # Add the tracing options.      # Add the tracing options.
581      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
582          $options->{trace} = [2, "tracing level"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
583      }      }
584      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
585      $options->{h} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
586      $options->{user} = [$$, "trace log file name suffix"];      $options->{user} = [$tkey, "tracing key"];
587      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
588      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
589      # contains the default values rather than the default value      # contains the default values rather than the default value
# Line 434  Line 607 
607          my $errFileName = "$FIG_Config::temp/err$suffix.log";          my $errFileName = "$FIG_Config::temp/err$suffix.log";
608          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
609          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
610            # Check for phone support. If we have phone support and a phone number,
611            # we want to turn it on.
612            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
613                $retOptions->{phone} = $ENV{PHONE};
614            }
615      }      }
616      # Now we want to set up tracing. First, we need to know if SQL is to      # Now we want to set up tracing. First, we need to know if the user
617      # be traced.      # wants emergency tracing.
618        if ($retOptions->{trace} eq 'E') {
619            ETracing($retOptions->{user});
620        } else {
621            # Here the tracing is controlled from the command line.
622      my @cats = @{$categories};      my @cats = @{$categories};
623      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
624          push @cats, "SQL";          push @cats, "SQL";
625      }      }
626      # Add the default categories.      # Add the default categories.
627      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
628      # Next, we create the category string by joining the categories.      # Next, we create the category string by joining the categories.
629      my $cats = join(" ", @cats);      my $cats = join(" ", @cats);
630      # Check to determine whether or not the caller wants to turn off tracing      # Check to determine whether or not the caller wants to turn off tracing
# Line 477  Line 659 
659      }      }
660      # Now set up the tracing.      # Now set up the tracing.
661      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
662      # Check for the "h" option. If it is specified, dump the command-line      }
663        # Check for the "help" option. If it is specified, dump the command-line
664      # options and exit the program.      # options and exit the program.
665      if ($retOptions->{h}) {      if ($retOptions->{help}) {
666          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
667          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
668          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
669              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
670              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
671              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
672                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
673              }              }
674              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
675          }          }
676          exit(0);          exit(0);
677      }      }
678        # Trace the options, if applicable.
679        if (T(3)) {
680            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
681            Trace("Selected options: " . join(", ", sort @parms) . ".");
682        }
683      # Return the parsed parameters.      # Return the parsed parameters.
684      return ($retOptions, @retParameters);      return ($retOptions, @retParameters);
685  }  }
686    
687  =head3 Setups  =head3 Setups
688    
689  C<< my $count = Tracer::Setups(); >>      my $count = Tracer::Setups();
690    
691  Return the number of times L</TSetup> has been called.  Return the number of times L</TSetup> has been called.
692    
# Line 513  Line 701 
701    
702  =head3 Open  =head3 Open
703    
704  C<< my $handle = Open($fileHandle, $fileSpec, $message); >>      my $handle = Open($fileHandle, $fileSpec, $message);
705    
706  Open a file.  Open a file.
707    
# Line 605  Line 793 
793    
794  =head3 FindNamePart  =head3 FindNamePart
795    
796  C<< my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec); >>      my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec);
797    
798  Extract the portion of a file specification that contains the file name.  Extract the portion of a file specification that contains the file name.
799    
# Line 656  Line 844 
844    
845  =head3 OpenDir  =head3 OpenDir
846    
847  C<< my @files = OpenDir($dirName, $filtered, $flag); >>      my @files = OpenDir($dirName, $filtered, $flag);
848    
849  Open a directory and return all the file names. This function essentially performs  Open a directory and return all the file names. This function essentially performs
850  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
# Line 722  Line 910 
910    
911  =head3 SetLevel  =head3 SetLevel
912    
913  C<< Tracer::SetLevel($newLevel); >>      Tracer::SetLevel($newLevel);
914    
915  Modify the trace level. A higher trace level will cause more messages to appear.  Modify the trace level. A higher trace level will cause more messages to appear.
916    
# Line 742  Line 930 
930    
931  =head3 Now  =head3 Now
932    
933  C<< my $string = Tracer::Now(); >>      my $string = Tracer::Now();
934    
935  Return a displayable time stamp containing the local time.  Return a displayable time stamp containing the local time.
936    
# Line 762  Line 950 
950      return $value;      return $value;
951  }  }
952    
953    =head3 ParseTraceDate
954    
955        my $time = Tracer::ParseTraceDate($dateString);
956    
957    Convert a date from the trace file into a PERL timestamp.
958    
959    =over 4
960    
961    =item dateString
962    
963    The date string from the trace file. The format of the string is determined by the
964    L</Now> method.
965    
966    =item RETURN
967    
968    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
969    the time string is invalid.
970    
971    =back
972    
973    =cut
974    
975    sub ParseTraceDate {
976        # Get the parameters.
977        my ($dateString) = @_;
978        # Declare the return variable.
979        my $retVal;
980        # Parse the date.
981        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
982            # Create a time object. Note we need to convert the day, month,
983            # and year to a different base. Years count from 1900, and
984            # the internal month value is relocated to January = 0.
985            $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);
986        }
987        # Return the result.
988        return $retVal;
989    }
990    
991  =head3 LogErrors  =head3 LogErrors
992    
993  C<< Tracer::LogErrors($fileName); >>      Tracer::LogErrors($fileName);
994    
995  Route the standard error output to a log file.  Route the standard error output to a log file.
996    
# Line 787  Line 1013 
1013    
1014  =head3 ReadOptions  =head3 ReadOptions
1015    
1016  C<< my %options = Tracer::ReadOptions($fileName); >>      my %options = Tracer::ReadOptions($fileName);
1017    
1018  Read a set of options from a file. Each option is encoded in a line of text that has the  Read a set of options from a file. Each option is encoded in a line of text that has the
1019  format  format
# Line 848  Line 1074 
1074    
1075  =head3 GetOptions  =head3 GetOptions
1076    
1077  C<< Tracer::GetOptions(\%defaults, \%options); >>      Tracer::GetOptions(\%defaults, \%options);
1078    
1079  Merge a specified set of options into a table of defaults. This method takes two hash references  Merge a specified set of options into a table of defaults. This method takes two hash references
1080  as input and uses the data from the second to update the first. If the second does not exist,  as input and uses the data from the second to update the first. If the second does not exist,
# Line 857  Line 1083 
1083    
1084  Consider the following example.  Consider the following example.
1085    
1086  C<< my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options); >>      my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options);
1087    
1088  In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and  In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and
1089  B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of  B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of
# Line 865  Line 1091 
1091  the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level  the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level
1092  will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as  will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as
1093    
1094  C<< {databaseType => 'Oracle'} >>      {databaseType => 'Oracle'}
1095    
1096  an error will occur because the B<databaseType> option does not exist.  an error will occur because the B<databaseType> option does not exist.
1097    
# Line 909  Line 1135 
1135    
1136  =head3 MergeOptions  =head3 MergeOptions
1137    
1138  C<< Tracer::MergeOptions(\%table, \%defaults); >>      Tracer::MergeOptions(\%table, \%defaults);
1139    
1140  Merge default values into a hash table. This method looks at the key-value pairs in the  Merge default values into a hash table. This method looks at the key-value pairs in the
1141  second (default) hash, and if a matching key is not found in the first hash, the default  second (default) hash, and if a matching key is not found in the first hash, the default
# Line 943  Line 1169 
1169    
1170  =head3 Trace  =head3 Trace
1171    
1172  C<< Trace($message); >>      Trace($message);
1173    
1174  Write a trace message to the target location specified in L</TSetup>. If there has not been  Write a trace message to the target location specified in L</TSetup>. If there has not been
1175  any prior call to B<TSetup>.  any prior call to B<TSetup>.
# Line 964  Line 1190 
1190      # Get the timestamp.      # Get the timestamp.
1191      my $timeStamp = Now();      my $timeStamp = Now();
1192      # Format the message. Note we strip off any line terminators at the end.      # Format the message. Note we strip off any line terminators at the end.
1193      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $prefix = "[$timeStamp] <$LastCategory>: ";
1194        my $formatted = $prefix . Strip($message);
1195      # Process according to the destination.      # Process according to the destination.
1196      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1197          # Write the message to the standard output.          # Write the message to the standard output.
# Line 978  Line 1205 
1205      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
1206          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML and write it to the standard output.
1207          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($message);
1208          print "<p>$formatted</p>\n";          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";
1209      } elsif ($Destination eq "WARN") {      } elsif ($Destination eq "WARN") {
1210         # Emit the message as a warning.         # Emit the message as a warning.
1211         warn $message;         warn $message;
# Line 996  Line 1223 
1223    
1224  =head3 T  =head3 T
1225    
1226  C<< my $switch = T($category, $traceLevel); >>      my $switch = T($category, $traceLevel);
1227    
1228      or      or
1229    
1230  C<< my $switch = T($traceLevel); >>      my $switch = T($traceLevel);
1231    
1232  Return TRUE if the trace level is at or above a specified value and the specified category  Return TRUE if the trace level is at or above a specified value and the specified category
1233  is active, else FALSE. If no category is specified, the caller's package name is used.  is active, else FALSE. If no category is specified, the caller's package name is used.
# Line 1043  Line 1270 
1270              if (!$package) {              if (!$package) {
1271                  $category = "main";                  $category = "main";
1272              } else {              } else {
1273                  $category = $package;                  my @cats = split /::/, $package;
1274                    $category = $cats[$#cats];
1275              }              }
1276          }          }
1277          # Save the category name.          # Save the category name.
# Line 1064  Line 1292 
1292    
1293  =head3 ParseCommand  =head3 ParseCommand
1294    
1295  C<< my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList); >>      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
1296    
1297  Parse a command line consisting of a list of parameters. The initial parameters may be option  Parse a command line consisting of a list of parameters. The initial parameters may be option
1298  specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped  specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped
1299  off and merged into a table of default options. The remainder of the command line is  off and merged into a table of default options. The remainder of the command line is
1300  returned as a list of positional arguments. For example, consider the following invocation.  returned as a list of positional arguments. For example, consider the following invocation.
1301    
1302  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>      my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words);
1303    
1304  In this case, the list @words will be treated as a command line. There are two options available,  In this case, the list @words will be treated as a command line and there are two options available,
1305  B<errors> and B<logFile>. If @words has the following format  B<errors> and B<logFile>. If @words has the following format
1306    
1307  C<< -logFile=error.log apple orange rutabaga >>      -logFile=error.log apple orange rutabaga
1308    
1309  then at the end of the invocation, C<$options> will be  then at the end of the invocation, C<$options> will be
1310    
1311  C<< { errors => 0, logFile => 'error.log' } >>      { errors => 0, logFile => 'error.log' }
1312    
1313  and C<@arguments> will contain  and C<@arguments> will contain
1314    
1315  C<< apple orange rutabaga >>      apple orange rutabaga
1316    
1317  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
1318  support for quote characters.  support for quote characters. Options can be specified with single or double hyphens.
1319    
1320  =over 4  =over 4
1321    
# Line 1112  Line 1340 
1340      my ($optionTable, @inputList) = @_;      my ($optionTable, @inputList) = @_;
1341      # Process any options in the input list.      # Process any options in the input list.
1342      my %overrides = ();      my %overrides = ();
1343      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
1344          # Get the current option.          # Get the current option.
1345          my $arg = shift @inputList;          my $arg = shift @inputList;
1346          # Pull out the option name.          # Pull out the option name.
1347          $arg =~ /^-([^=]*)/g;          $arg =~ /^--?([^=]*)/g;
1348          my $name = $1;          my $name = $1;
1349          # Check for an option value.          # Check for an option value.
1350          if ($arg =~ /\G=(.*)$/g) {          if ($arg =~ /\G=(.*)$/g) {
# Line 1140  Line 1368 
1368    
1369  =head3 Escape  =head3 Escape
1370    
1371  C<< my $codedString = Tracer::Escape($realString); >>      my $codedString = Tracer::Escape($realString);
1372    
1373  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 length. Tabs will be replaced by C<\t>, new-lines
1374  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
# Line 1195  Line 1423 
1423    
1424  =head3 UnEscape  =head3 UnEscape
1425    
1426  C<< my $realString = Tracer::UnEscape($codedString); >>      my $realString = Tracer::UnEscape($codedString);
1427    
1428  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
1429  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 1255  Line 1483 
1483    
1484  =head3 ParseRecord  =head3 ParseRecord
1485    
1486  C<< my @fields = Tracer::ParseRecord($line); >>      my @fields = Tracer::ParseRecord($line);
1487    
1488  Parse a tab-delimited data line. The data line is split into field values. Embedded tab  Parse a tab-delimited data line. The data line is split into field values. Embedded tab
1489  and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.  and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.
# Line 1300  Line 1528 
1528    
1529  =head3 Merge  =head3 Merge
1530    
1531  C<< my @mergedList = Tracer::Merge(@inputList); >>      my @mergedList = Tracer::Merge(@inputList);
1532    
1533  Sort a list of strings and remove duplicates.  Sort a list of strings and remove duplicates.
1534    
# Line 1346  Line 1574 
1574      return @inputList;      return @inputList;
1575  }  }
1576    
1577    =head3 Percent
1578    
1579        my $percent = Tracer::Percent($number, $base);
1580    
1581    Returns the percent of the base represented by the given number. If the base
1582    is zero, returns zero.
1583    
1584    =over 4
1585    
1586    =item number
1587    
1588    Percent numerator.
1589    
1590    =item base
1591    
1592    Percent base.
1593    
1594    =item RETURN
1595    
1596    Returns the percentage of the base represented by the numerator.
1597    
1598    =back
1599    
1600    =cut
1601    
1602    sub Percent {
1603        # Get the parameters.
1604        my ($number, $base) = @_;
1605        # Declare the return variable.
1606        my $retVal = 0;
1607        # Compute the percent.
1608        if ($base != 0) {
1609            $retVal = $number * 100 / $base;
1610        }
1611        # Return the result.
1612        return $retVal;
1613    }
1614    
1615  =head3 GetFile  =head3 GetFile
1616    
1617  C<< my @fileContents = Tracer::GetFile($fileName); >>      my @fileContents = Tracer::GetFile($fileName);
1618    
1619      or      or
1620    
1621  C<< my $fileContents = Tracer::GetFile($fileName); >>      my $fileContents = Tracer::GetFile($fileName);
1622    
1623  Return the entire contents of a file. In list context, line-ends are removed and  Return the entire contents of a file. In list context, line-ends are removed and
1624  each line is a list element. In scalar context, line-ends are replaced by C<\n>.  each line is a list element. In scalar context, line-ends are replaced by C<\n>.
# Line 1379  Line 1645 
1645      # Declare the return variable.      # Declare the return variable.
1646      my @retVal = ();      my @retVal = ();
1647      # Open the file for input.      # Open the file for input.
1648      my $ok = open INPUTFILE, "<$fileName";      my $handle = Open(undef, "<$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 {  
1649          # Read the whole file into the return variable, stripping off any terminator          # Read the whole file into the return variable, stripping off any terminator
1650          # characters.          # characters.
1651          my $lineCount = 0;          my $lineCount = 0;
1652          while (my $line = <INPUTFILE>) {      while (my $line = <$handle>) {
1653              $lineCount++;              $lineCount++;
1654              $line = Strip($line);              $line = Strip($line);
1655              push @retVal, $line;              push @retVal, $line;
1656          }          }
1657          # Close it.          # Close it.
1658          close INPUTFILE;      close $handle;
1659          my $actualLines = @retVal;          my $actualLines = @retVal;
1660      }      Trace("$actualLines lines read from file $fileName.") if T(File => 2);
1661      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
1662      if (wantarray) {      if (wantarray) {
1663          return @retVal;          return @retVal;
# Line 1404  Line 1666 
1666      }      }
1667  }  }
1668    
1669    =head3 PutFile
1670    
1671        Tracer::PutFile($fileName, \@lines);
1672    
1673    Write out a file from a list of lines of text.
1674    
1675    =over 4
1676    
1677    =item fileName
1678    
1679    Name of the output file.
1680    
1681    =item lines
1682    
1683    Reference to a list of text lines. The lines will be written to the file in order, with trailing
1684    new-line characters. Alternatively, may be a string, in which case the string will be written without
1685    modification.
1686    
1687    =back
1688    
1689    =cut
1690    
1691    sub PutFile {
1692        # Get the parameters.
1693        my ($fileName, $lines) = @_;
1694        # Open the output file.
1695        my $handle = Open(undef, ">$fileName");
1696        # Count the lines written.
1697        if (ref $lines ne 'ARRAY') {
1698            # Here we have a scalar, so we write it raw.
1699            print $handle $lines;
1700            Trace("Scalar put to file $fileName.") if T(File => 3);
1701        } else {
1702            # Write the lines one at a time.
1703            my $count = 0;
1704            for my $line (@{$lines}) {
1705                print $handle "$line\n";
1706                $count++;
1707            }
1708            Trace("$count lines put to file $fileName.") if T(File => 3);
1709        }
1710        # Close the output file.
1711        close $handle;
1712    }
1713    
1714  =head3 QTrace  =head3 QTrace
1715    
1716  C<< my $data = QTrace($format); >>      my $data = QTrace($format);
1717    
1718  Return the queued trace data in the specified format.  Return the queued trace data in the specified format.
1719    
# Line 1449  Line 1756 
1756    
1757  =head3 Confess  =head3 Confess
1758    
1759  C<< Confess($message); >>      Confess($message);
1760    
1761  Trace the call stack and abort the program with the specified message. When used with  Trace the call stack and abort the program with the specified message. When used with
1762  the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.  the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.
1763  So, for example  So, for example
1764    
1765  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>      Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
1766    
1767  Will abort the program with a stack trace if the value of C<$recNum> is negative.  Will abort the program with a stack trace if the value of C<$recNum> is negative.
1768    
# Line 1472  Line 1779 
1779  sub Confess {  sub Confess {
1780      # Get the parameters.      # Get the parameters.
1781      my ($message) = @_;      my ($message) = @_;
1782        if (! defined($FIG_Config::no_tool_hdr)) {
1783            # Here we have a tool header. Display its length so that the user can adjust the line numbers.
1784            my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
1785            # Only proceed if the tool header file is actually present.
1786            if (-f $toolHeaderFile) {
1787                my @lines = GetFile($toolHeaderFile);
1788                Trace("Tool header has " . scalar(@lines) . " lines.");
1789            }
1790        }
1791      # Trace the call stack.      # Trace the call stack.
1792      Cluck($message);      Cluck($message);
1793      # Abort the program.      # Abort the program.
# Line 1480  Line 1796 
1796    
1797  =head3 Assert  =head3 Assert
1798    
1799  C<< Assert($condition1, $condition2, ... $conditionN); >>      Assert($condition1, $condition2, ... $conditionN);
1800    
1801  Return TRUE if all the conditions are true. This method can be used in conjunction with  Return TRUE if all the conditions are true. This method can be used in conjunction with
1802  the OR operator and the L</Confess> method as a debugging assert.  the OR operator and the L</Confess> method as a debugging assert.
1803  So, for example  So, for example
1804    
1805  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>      Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
1806    
1807  Will abort the program with a stack trace if the value of C<$recNum> is negative.  Will abort the program with a stack trace if the value of C<$recNum> is negative.
1808    
# Line 1504  Line 1820 
1820    
1821  =head3 Cluck  =head3 Cluck
1822    
1823  C<< Cluck($message); >>      Cluck($message);
1824    
1825  Trace the call stack. Note that for best results, you should qualify the call with a  Trace the call stack. Note that for best results, you should qualify the call with a
1826  trace condition. For example,  trace condition. For example,
1827    
1828  C<< Cluck("Starting record parse.") if T(3); >>      Cluck("Starting record parse.") if T(3);
1829    
1830  will only trace the stack if the trace level for the package is 3 or more.  will only trace the stack if the trace level for the package is 3 or more.
1831    
# Line 1538  Line 1854 
1854    
1855  =head3 Min  =head3 Min
1856    
1857  C<< my $min = Min($value1, $value2, ... $valueN); >>      my $min = Min($value1, $value2, ... $valueN);
1858    
1859  Return the minimum argument. The arguments are treated as numbers.  Return the minimum argument. The arguments are treated as numbers.
1860    
# Line 1571  Line 1887 
1887    
1888  =head3 Max  =head3 Max
1889    
1890  C<< my $max = Max($value1, $value2, ... $valueN); >>      my $max = Max($value1, $value2, ... $valueN);
1891    
1892  Return the maximum argument. The arguments are treated as numbers.  Return the maximum argument. The arguments are treated as numbers.
1893    
# Line 1604  Line 1920 
1920    
1921  =head3 AddToListMap  =head3 AddToListMap
1922    
1923  C<< Tracer::AddToListMap(\%hash, $key, $value); >>      Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN);
1924    
1925  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list
1926  is created for the key. Otherwise, the new value is pushed onto the list.  is created for the key. Otherwise, the new value is pushed onto the list.
# Line 1619  Line 1935 
1935    
1936  Key for which the value is to be added.  Key for which the value is to be added.
1937    
1938  =item value  =item value1, value2, ... valueN
1939    
1940  Value to add to the key's value list.  List of values to add to the key's value list.
1941    
1942  =back  =back
1943    
# Line 1629  Line 1945 
1945    
1946  sub AddToListMap {  sub AddToListMap {
1947      # Get the parameters.      # Get the parameters.
1948      my ($hash, $key, $value) = @_;      my ($hash, $key, @values) = @_;
1949      # Process according to whether or not the key already has a value.      # Process according to whether or not the key already has a value.
1950      if (! exists $hash->{$key}) {      if (! exists $hash->{$key}) {
1951          $hash->{$key} = [$value];          $hash->{$key} = [@values];
1952      } else {      } else {
1953          push @{$hash->{$key}}, $value;          push @{$hash->{$key}}, @values;
1954      }      }
1955  }  }
1956    
1957  =head3 DebugMode  =head3 DebugMode
1958    
1959  C<< if (Tracer::DebugMode) { ...code... } >>      if (Tracer::DebugMode) { ...code... }
1960    
1961  Return TRUE if debug mode has been turned on, else output an error  Return TRUE if debug mode has been turned on, else abort.
 page and return FALSE.  
1962    
1963  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1964  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1965  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1966  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1967  is not turned on, an error web page will be output directing the  is not turned on, an error will occur.
 user to enter in the correct password.  
1968    
1969  =cut  =cut
1970    
# Line 1663  Line 1977 
1977      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1978          $retVal = 1;          $retVal = 1;
1979      } else {      } else {
1980          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1981          my $pageString = PageBuilder::Build("<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1982      }      }
1983      # Return the determination indicator.      # Return the determination indicator.
1984      return $retVal;      return $retVal;
# Line 1673  Line 1986 
1986    
1987  =head3 Strip  =head3 Strip
1988    
1989  C<< my $string = Tracer::Strip($line); >>      my $string = Tracer::Strip($line);
1990    
1991  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
1992  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 1705  Line 2018 
2018    
2019  =head3 Pad  =head3 Pad
2020    
2021  C<< my $paddedString = Tracer::Pad($string, $len, $left, $padChar); >>      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
2022    
2023  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
2024  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 1776  Line 2089 
2089    
2090  =head3 TICK  =head3 TICK
2091    
2092  C<< my @results = TICK($commandString); >>      my @results = TICK($commandString);
2093    
2094  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
2095  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 1817  Line 2130 
2130    
2131  =head3 ScriptSetup  =head3 ScriptSetup
2132    
2133  C<< my ($query, $varHash) = ScriptSetup(); >>      my ($cgi, $varHash) = ScriptSetup($noTrace);
2134    
2135  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2136  the CGI object followed by a pre-built variable hash.  the CGI object followed by a pre-built variable hash. At the end of the script,
2137    the client should call L</ScriptFinish> to output the web page.
2138    
2139    This method calls L</ETracing> to configure tracing, which allows the tracing
2140    to be configured via the emergency tracing form on the debugging control panel.
2141    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2142    method, which includes every program that uses this method or L</StandardSetup>.
2143    
2144    =over 4
2145    
2146    =item noTrace (optional)
2147    
2148    If specified, tracing will be suppressed. This is useful if the script wants to set up
2149    tracing manually.
2150    
2151    =item RETURN
2152    
2153  The C<Trace> query parameter is used to determine whether or not tracing is active and  Returns a two-element list consisting of a CGI query object and a variable hash for
2154  which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  the output page.
2155  the C<CGI> trace module will trace parameter and environment information. Parameters are  
2156  traced at level 3 and environment variables at level 4. At the end of the script, the  =back
 client should call L</ScriptFinish> to output the web page.  
2157    
2158  =cut  =cut
2159    
2160  sub ScriptSetup {  sub ScriptSetup {
2161        # Get the parameters.
2162        my ($noTrace) = @_;
2163      # Get the CGI query object.      # Get the CGI query object.
2164      my $query = CGI->new();      my $cgi = CGI->new();
2165      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2166      if ($query->param('Trace')) {      ETracing($cgi) unless $noTrace;
         # Set up tracing to be queued for display at the bottom of the web page.  
         TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");  
         # Trace the parameter and environment data.  
         if (T(CGI => 3)) {  
             # Here we want to trace the parameter data.  
             my @names = $query->param;  
             for my $parmName (sort @names) {  
                 # Note we skip "Trace", which is for our use only.  
                 if ($parmName ne 'Trace') {  
                     my @values = $query->param($parmName);  
                     Trace("CGI: $parmName = " . join(", ", @values));  
                 }  
             }  
         }  
         if (T(CGI => 4)) {  
             # Here we want the environment data too.  
             for my $envName (sort keys %ENV) {  
                 Trace("ENV: $envName = $ENV{$envName}");  
             }  
         }  
     } else {  
         # Here tracing is to be turned off. All we allow is errors traced into the  
         # error log.  
         TSetup("0", "WARN");  
     }  
2167      # Create the variable hash.      # Create the variable hash.
2168      my $varHash = { DebugData => '' };      my $varHash = { results => '' };
     # If we're in DEBUG mode, set up the debug mode data for forms.  
     if (Tracer::DebugMode) {  
         $varHash->{DebugData} = GetFile("Html/DebugFragment.html");  
     }  
2169      # Return the query object and variable hash.      # Return the query object and variable hash.
2170      return ($query, $varHash);      return ($cgi, $varHash);
2171  }  }
2172    
2173  =head3 ScriptFinish  =head3 ETracing
2174    
2175  C<< ScriptFinish($webData, $varHash); >>      ETracing($parameter);
2176    
2177  Output a web page at the end of a script. Either the string to be output or the  Set up emergency tracing. Emergency tracing is tracing that is turned
2178  name of a template file can be specified. If the second parameter is omitted,  on automatically for any program that calls this method. The emergency
2179  it is assumed we have a string to be output; otherwise, it is assumed we have the  tracing parameters are stored in a a file identified by a tracing key.
2180  name of a template file. The template should have the variable C<DebugData>  If this method is called with a CGI object, then the tracing key is
2181  specified in any form that invokes a standard script. If debugging mode is turned  taken from a cookie. If it is called with no parameters, then the tracing
2182  on, a form field will be put in that allows the user to enter tracing data.  key is taken from an environment variable. If it is called with a string,
2183  Trace messages will be placed immediately before the terminal C<BODY> tag in  the tracing key is that string.
 the output, formatted as a list.  
2184    
2185  A typical standard script would loook like the following.  =over 4
2186    
2187      BEGIN {  =item parameter
         # Print the HTML header.  
         print "CONTENT-TYPE: text/html\n\n";  
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
2188    
2189      my ($query, $varHash) = ScriptSetup();  A parameter from which the tracing key is computed. If it is a scalar,
2190      eval {  that scalar is used as the tracing key. If it is a CGI object, the
2191          # ... get data from $query, put it in $varHash ...  tracing key is taken from the C<IP> cookie. If it is omitted, the
2192      };  tracing key is taken from the C<TRACING> environment variable. If it
2193      if ($@) {  is a CGI object and emergency tracing is not on, the C<Trace> and
2194          Trace("Script Error: $@") if T(0);  C<TF> parameters will be used to determine the type of tracing.
2195    
2196    =back
2197    
2198    =cut
2199    
2200    sub ETracing {
2201        # Get the parameter.
2202        my ($parameter) = @_;
2203        # Check for CGI mode.
2204        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2205        # Default to no tracing except errors.
2206        my ($tracing, $dest) = ("0", "WARN");
2207        # Check for emergency tracing.
2208        my $tkey = EmergencyKey($parameter);
2209        my $emergencyFile = EmergencyFileName($tkey);
2210        if (-e $emergencyFile) {
2211            # We have the file. Read in the data.
2212            my @tracing = GetFile($emergencyFile);
2213            # Pull off the time limit.
2214            my $expire = shift @tracing;
2215            # Convert it to seconds.
2216            $expire *= 3600;
2217            # Check the file data.
2218            my $stat = stat($emergencyFile);
2219            my ($now) = gettimeofday;
2220            if ($now - $stat->mtime > $expire) {
2221                # Delete the expired file.
2222                unlink $emergencyFile;
2223            } else {
2224                # Emergency tracing is on. Pull off the destination and
2225                # the trace level;
2226                $dest = shift @tracing;
2227                my $level = shift @tracing;
2228                # Convert the destination to a real tracing destination.
2229                # temp directory.
2230                $dest = EmergencyTracingDest($tkey, $dest);
2231                # Insure Tracer is specified.
2232                my %moduleHash = map { $_ => 1 } @tracing;
2233                $moduleHash{Tracer} = 1;
2234                # Set the trace parameter.
2235                $tracing = join(" ", $level, sort keys %moduleHash);
2236            }
2237        } elsif (defined $cgi) {
2238            # There's no emergency tracing, but we have a CGI object, so check
2239            # for tracing from the form parameters.
2240            if ($cgi->param('Trace')) {
2241                # Here the user has requested tracing via a form.
2242                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2243                $tracing = $cgi->param('Trace') . " Tracer";
2244            }
2245        }
2246        # Setup the tracing we've determined from all the stuff above.
2247        TSetup($tracing, $dest);
2248        # If we're a web script, trace the parameter and environment data.
2249        if (defined $cgi) {
2250            TraceParms($cgi);
2251        }
2252      }      }
     ScriptFinish("Html/MyTemplate.html", $varHash);  
2253    
2254  The idea here is that even if the script fails, you'll see trace messages and  =head3 EmergencyFileName
2255  useful output.  
2256        my $fileName = Tracer::EmergencyFileName($tkey);
2257    
2258    Return the emergency tracing file name. This is the file that specifies
2259    the tracing information.
2260    
2261  =over 4  =over 4
2262    
2263  =item webData  =item tkey
2264    
2265  A string containing either the full web page to be written to the output or the  Tracing key for the current program.
 name of a template file from which the page is to be constructed. If the name  
 of a template file is specified, then the second parameter must be present;  
 otherwise, it must be absent.  
2266    
2267  =item varHash (optional)  =item RETURN
2268    
2269  If specified, then a reference to a hash mapping variable names for a template  Returns the name of the file to contain the emergency tracing information.
 to their values. The template file will be read into memory, and variable markers  
 will be replaced by data in this hash reference.  
2270    
2271  =back  =back
2272    
2273  =cut  =cut
2274    
2275  sub ScriptFinish {  sub EmergencyFileName {
2276      # Get the parameters.      # Get the parameters.
2277      my ($webData, $varHash) = @_;      my ($tkey) = @_;
2278      # Check for a template file situation.      # Compute the emergency tracing file name.
2279      my $outputString;      return "$FIG_Config::temp/Emergency$tkey.txt";
     if (defined $varHash) {  
         # Here we have a template file. We need to apply the variables to the template.  
         $outputString = PageBuilder::Build("<$webData", $varHash, "Html");  
     } else {  
         # Here the user gave us a raw string.  
         $outputString = $webData;  
     }  
     # Check for trace messages.  
     if ($Destination eq "QUEUE") {  
         # We have trace messages, so we want to put them at the end of the body. This  
         # is either at the end of the whole string or at the beginning of the BODY  
         # end-tag.  
         my $pos = length $outputString;  
         if ($outputString =~ m#</body>#gi) {  
             $pos = (pos $outputString) - 7;  
         }  
         substr $outputString, $pos, 0, QTrace('Html');  
     }  
     # Write the output string.  
     print $outputString;  
2280  }  }
2281    
2282  =head3 Insure  =head3 EmergencyFileTarget
2283    
2284  C<< Insure($dirName); >>      my $fileName = Tracer::EmergencyFileTarget($tkey);
2285    
2286  Insure a directory is present.  Return the emergency tracing target file name. This is the file that receives
2287    the tracing output for file-based tracing.
2288    
2289  =over 4  =over 4
2290    
2291  =item dirName  =item tkey
2292    
2293  Name of the directory to check. If it does not exist, it will be created.  Tracing key for the current program.
2294    
2295    =item RETURN
2296    
2297    Returns the name of the file to contain the trace output.
2298    
2299  =back  =back
2300    
2301  =cut  =cut
2302    
2303  sub Insure {  sub EmergencyFileTarget {
2304      my ($dirName) = @_;      # Get the parameters.
2305      if (! -d $dirName) {      my ($tkey) = @_;
2306          Trace("Creating $dirName directory.") if T(2);      # Compute the emergency tracing file name.
2307          eval { mkpath $dirName; };      return "$FIG_Config::temp/trace$tkey.log";
         if ($@) {  
             Confess("Error creating $dirName: $@");  
         }  
     }  
2308  }  }
2309    
2310  =head3 ChDir  =head3 EmergencyTracingDest
2311    
2312  C<< ChDir($dirName); >>      my $dest = Tracer::EmergencyTracingDest($tkey, $myDest);
2313    
2314  Change to the specified directory.  This method converts an emergency tracing destination to a real
2315    tracing destination. The main difference is that if the
2316    destination is C<FILE> or C<APPEND>, we convert it to file
2317    output. If the destination is C<DUAL>, we convert it to file
2318    and standard output.
2319    
2320  =over 4  =over 4
2321    
2322  =item dirName  =item tkey
2323    
2324  Name of the directory to which we want to change.  Tracing key for this environment.
2325    
2326    =item myDest
2327    
2328    Destination from the emergency tracing file.
2329    
2330    =item RETURN
2331    
2332    Returns a destination that can be passed into L</TSetup>.
2333    
2334  =back  =back
2335    
2336  =cut  =cut
2337    
2338  sub ChDir {  sub EmergencyTracingDest {
2339      my ($dirName) = @_;      # Get the parameters.
2340      if (! -d $dirName) {      my ($tkey, $myDest) = @_;
2341          Confess("Cannot change to directory $dirName: no such directory.");      # Declare the return variable.
2342      } else {      my $retVal = $myDest;
2343          Trace("Changing to directory $dirName.") if T(4);      # Process according to the destination value.
2344          my $okFlag = chdir $dirName;      if ($myDest eq 'FILE') {
2345            $retVal = ">" . EmergencyFileTarget($tkey);
2346        } elsif ($myDest eq 'APPEND') {
2347            $retVal = ">>" . EmergencyFileTarget($tkey);
2348        } elsif ($myDest eq 'DUAL') {
2349            $retVal = "+>" . EmergencyFileTarget($tkey);
2350        }
2351        # Return the result.
2352        return $retVal;
2353    }
2354    
2355    =head3 Emergency
2356    
2357        Emergency($key, $hours, $dest, $level, @modules);
2358    
2359    Turn on emergency tracing. This method is normally invoked over the web from
2360    a debugging console, but it can also be called by the C<trace.pl> script.
2361    The caller specifies the duration of the emergency in hours, the desired tracing
2362    destination, the trace level, and a list of the trace modules to activate.
2363    For the length of the duration, when a program in an environment with the
2364    specified tracing key active invokes a Sprout CGI script, tracing will be
2365    turned on automatically. See L</TSetup> for more about tracing setup and
2366    L</ETracing> for more about emergency tracing.
2367    
2368    =over 4
2369    
2370    =item tkey
2371    
2372    The tracing key. This is used to identify the control file and the trace file.
2373    
2374    =item hours
2375    
2376    Number of hours to keep emergency tracing alive.
2377    
2378    =item dest
2379    
2380    Tracing destination. If no path information is specified for a file
2381    destination, it is put in the FIG temporary directory.
2382    
2383    =item level
2384    
2385    Tracing level. A higher level means more trace messages.
2386    
2387    =item modules
2388    
2389    A list of the tracing modules to activate.
2390    
2391    =back
2392    
2393    =cut
2394    
2395    sub Emergency {
2396        # Get the parameters.
2397        my ($tkey, $hours, $dest, $level, @modules) = @_;
2398        # Create the emergency file.
2399        my $specFile = EmergencyFileName($tkey);
2400        my $outHandle = Open(undef, ">$specFile");
2401        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2402    }
2403    
2404    =head3 EmergencyKey
2405    
2406        my $tkey = EmergencyKey($parameter);
2407    
2408    Return the Key to be used for emergency tracing. This could be an IP address,
2409     a session ID, or a user name, depending on the environment.
2410    
2411    =over 4
2412    
2413    =item parameter
2414    
2415    Parameter defining the method for finding the tracing key. If it is a scalar,
2416    then it is presumed to be the tracing key itself. If it is a CGI object, then
2417    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2418    taken from the C<TRACING> environment variable.
2419    
2420    =item RETURN
2421    
2422    Returns the key to be used for labels in emergency tracing.
2423    
2424    =back
2425    
2426    =cut
2427    
2428    sub EmergencyKey {
2429        # Get the parameters.
2430        my ($parameter) = @_;
2431        # Declare the return variable.
2432        my $retVal;
2433        # Determine the parameter type.
2434        if (! defined $parameter) {
2435            # Here we're supposed to check the environment.
2436            $retVal = $ENV{TRACING};
2437        } else {
2438            my $ptype = ref $parameter;
2439            if ($ptype eq 'CGI') {
2440                # Here we were invoked from a web page. Look for a cookie.
2441                $retVal = $parameter->cookie('IP');
2442            } elsif (! $ptype) {
2443                # Here the key was passed in.
2444                $retVal = $parameter;
2445            }
2446        }
2447        # If no luck finding a key, use the PID.
2448        if (! defined $retVal) {
2449            $retVal = $$;
2450        }
2451        # Return the result.
2452        return $retVal;
2453    }
2454    
2455    
2456    =head3 TraceParms
2457    
2458        Tracer::TraceParms($cgi);
2459    
2460    Trace the CGI parameters at trace level CGI => 3 and the environment variables
2461    at level CGI => 4.
2462    
2463    =over 4
2464    
2465    =item cgi
2466    
2467    CGI query object containing the parameters to trace.
2468    
2469    =back
2470    
2471    =cut
2472    
2473    sub TraceParms {
2474        # Get the parameters.
2475        my ($cgi) = @_;
2476        if (T(CGI => 3)) {
2477            # Here we want to trace the parameter data.
2478            my @names = $cgi->param;
2479            for my $parmName (sort @names) {
2480                # Note we skip the Trace parameters, which are for our use only.
2481                if ($parmName ne 'Trace' && $parmName ne 'TF') {
2482                    my @values = $cgi->param($parmName);
2483                    Trace("CGI: $parmName = " . join(", ", @values));
2484                }
2485            }
2486            # Display the request method.
2487            my $method = $cgi->request_method();
2488            Trace("Method: $method");
2489        }
2490        if (T(CGI => 4)) {
2491            # Here we want the environment data too.
2492            for my $envName (sort keys %ENV) {
2493                Trace("ENV: $envName = $ENV{$envName}");
2494            }
2495        }
2496    }
2497    
2498    =head3 ScriptFinish
2499    
2500        ScriptFinish($webData, $varHash);
2501    
2502    Output a web page at the end of a script. Either the string to be output or the
2503    name of a template file can be specified. If the second parameter is omitted,
2504    it is assumed we have a string to be output; otherwise, it is assumed we have the
2505    name of a template file. The template should have the variable C<DebugData>
2506    specified in any form that invokes a standard script. If debugging mode is turned
2507    on, a form field will be put in that allows the user to enter tracing data.
2508    Trace messages will be placed immediately before the terminal C<BODY> tag in
2509    the output, formatted as a list.
2510    
2511    A typical standard script would loook like the following.
2512    
2513        BEGIN {
2514            # Print the HTML header.
2515            print "CONTENT-TYPE: text/html\n\n";
2516        }
2517        use Tracer;
2518        use CGI;
2519        use FIG;
2520        # ... more uses ...
2521    
2522        my ($cgi, $varHash) = ScriptSetup();
2523        eval {
2524            # ... get data from $cgi, put it in $varHash ...
2525        };
2526        if ($@) {
2527            Trace("Script Error: $@") if T(0);
2528        }
2529        ScriptFinish("Html/MyTemplate.html", $varHash);
2530    
2531    The idea here is that even if the script fails, you'll see trace messages and
2532    useful output.
2533    
2534    =over 4
2535    
2536    =item webData
2537    
2538    A string containing either the full web page to be written to the output or the
2539    name of a template file from which the page is to be constructed. If the name
2540    of a template file is specified, then the second parameter must be present;
2541    otherwise, it must be absent.
2542    
2543    =item varHash (optional)
2544    
2545    If specified, then a reference to a hash mapping variable names for a template
2546    to their values. The template file will be read into memory, and variable markers
2547    will be replaced by data in this hash reference.
2548    
2549    =back
2550    
2551    =cut
2552    
2553    sub ScriptFinish {
2554        # Get the parameters.
2555        my ($webData, $varHash) = @_;
2556        # Check for a template file situation.
2557        my $outputString;
2558        if (defined $varHash) {
2559            # Here we have a template file. We need to determine the template type.
2560            my $template;
2561            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
2562                $template = "$FIG_Config::template_url/$webData";
2563            } else {
2564                $template = "<<$webData";
2565            }
2566            $outputString = PageBuilder::Build($template, $varHash, "Html");
2567        } else {
2568            # Here the user gave us a raw string.
2569            $outputString = $webData;
2570        }
2571        # Check for trace messages.
2572        if ($Destination ne "NONE" && $TraceLevel > 0) {
2573            # We have trace messages, so we want to put them at the end of the body. This
2574            # is either at the end of the whole string or at the beginning of the BODY
2575            # end-tag.
2576            my $pos = length $outputString;
2577            if ($outputString =~ m#</body>#gi) {
2578                $pos = (pos $outputString) - 7;
2579            }
2580            # If the trace messages were queued, we unroll them. Otherwise, we display the
2581            # destination.
2582            my $traceHtml;
2583            if ($Destination eq "QUEUE") {
2584                $traceHtml = QTrace('Html');
2585            } elsif ($Destination =~ /^>>(.+)$/) {
2586                # Here the tracing output it to a file. We code it as a hyperlink so the user
2587                # can copy the file name into the clipboard easily.
2588                my $actualDest = $1;
2589                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2590            } else {
2591                # Here we have one of the special destinations.
2592                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2593            }
2594            substr $outputString, $pos, 0, $traceHtml;
2595        }
2596        # Write the output string.
2597        print $outputString;
2598    }
2599    
2600    =head3 Insure
2601    
2602        Insure($dirName, $chmod);
2603    
2604    Insure a directory is present.
2605    
2606    =over 4
2607    
2608    =item dirName
2609    
2610    Name of the directory to check. If it does not exist, it will be created.
2611    
2612    =item chmod (optional)
2613    
2614    Security privileges to be given to the directory if it is created.
2615    
2616    =back
2617    
2618    =cut
2619    
2620    sub Insure {
2621        my ($dirName, $chmod) = @_;
2622        if (! -d $dirName) {
2623            Trace("Creating $dirName directory.") if T(2);
2624            eval {
2625                mkpath $dirName;
2626                # If we have permissions specified, set them here.
2627                if (defined($chmod)) {
2628                    chmod $chmod, $dirName;
2629                }
2630            };
2631            if ($@) {
2632                Confess("Error creating $dirName: $@");
2633            }
2634        }
2635    }
2636    
2637    =head3 ChDir
2638    
2639        ChDir($dirName);
2640    
2641    Change to the specified directory.
2642    
2643    =over 4
2644    
2645    =item dirName
2646    
2647    Name of the directory to which we want to change.
2648    
2649    =back
2650    
2651    =cut
2652    
2653    sub ChDir {
2654        my ($dirName) = @_;
2655        if (! -d $dirName) {
2656            Confess("Cannot change to directory $dirName: no such directory.");
2657        } else {
2658            Trace("Changing to directory $dirName.") if T(File => 4);
2659            my $okFlag = chdir $dirName;
2660          if (! $okFlag) {          if (! $okFlag) {
2661              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
2662          }          }
2663      }      }
2664  }  }
2665    
2666    =head3 SendSMS
2667    
2668        my $msgID = Tracer::SendSMS($phoneNumber, $msg);
2669    
2670    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
2671    user name, password, and API ID for the relevant account in the hash reference variable
2672    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
2673    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
2674    is C<2561022>, then the FIG_Config file must contain
2675    
2676        $phone =  { user => 'BruceTheHumanPet',
2677                    password => 'silly',
2678                    api_id => '2561022' };
2679    
2680    The original purpose of this method was to insure Bruce would be notified immediately when the
2681    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
2682    when you call this method.
2683    
2684    The message ID will be returned if successful, and C<undef> if an error occurs.
2685    
2686    =over 4
2687    
2688    =item phoneNumber
2689    
2690    Phone number to receive the message, in international format. A United States phone number
2691    would be prefixed by "1". A British phone number would be prefixed by "44".
2692    
2693    =item msg
2694    
2695    Message to send to the specified phone.
2696    
2697    =item RETURN
2698    
2699    Returns the message ID if successful, and C<undef> if the message could not be sent.
2700    
2701    =back
2702    
2703    =cut
2704    
2705    sub SendSMS {
2706        # Get the parameters.
2707        my ($phoneNumber, $msg) = @_;
2708        # Declare the return variable. If we do not change it, C<undef> will be returned.
2709        my $retVal;
2710        # Only proceed if we have phone support.
2711        if (! defined $FIG_Config::phone) {
2712            Trace("Phone support not present in FIG_Config.") if T(1);
2713        } else {
2714            # Get the phone data.
2715            my $parms = $FIG_Config::phone;
2716            # Get the Clickatell URL.
2717            my $url = "http://api.clickatell.com/http/";
2718            # Create the user agent.
2719            my $ua = LWP::UserAgent->new;
2720            # Request a Clickatell session.
2721            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
2722                                         password => $parms->{password},
2723                                         api_id => $parms->{api_id},
2724                                         to => $phoneNumber,
2725                                         text => $msg});
2726            # Check for an error.
2727            if (! $resp->is_success) {
2728                Trace("Alert failed.") if T(1);
2729            } else {
2730                # Get the message ID.
2731                my $rstring = $resp->content;
2732                if ($rstring =~ /^ID:\s+(.*)$/) {
2733                    $retVal = $1;
2734                } else {
2735                    Trace("Phone attempt failed with $rstring") if T(1);
2736                }
2737            }
2738        }
2739        # Return the result.
2740        return $retVal;
2741    }
2742    
2743    =head3 CommaFormat
2744    
2745        my $formatted = Tracer::CommaFormat($number);
2746    
2747    Insert commas into a number.
2748    
2749    =over 4
2750    
2751    =item number
2752    
2753    A sequence of digits.
2754    
2755    =item RETURN
2756    
2757    Returns the same digits with commas strategically inserted.
2758    
2759    =back
2760    
2761    =cut
2762    
2763    sub CommaFormat {
2764        # Get the parameters.
2765        my ($number) = @_;
2766        # Pad the length up to a multiple of three.
2767        my $padded = "$number";
2768        $padded = " " . $padded while length($padded) % 3 != 0;
2769        # This is a fancy PERL trick. The parentheses in the SPLIT pattern
2770        # cause the delimiters to be included in the output stream. The
2771        # GREP removes the empty strings in between the delimiters.
2772        my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
2773        # Clean out the spaces.
2774        $retVal =~ s/ //g;
2775        # Return the result.
2776        return $retVal;
2777    }
2778    =head3 SetPermissions
2779    
2780        Tracer::SetPermissions($dirName, $group, $mask, %otherMasks);
2781    
2782    Set the permissions for a directory and all the files and folders inside it.
2783    In addition, the group ownership will be changed to the specified value.
2784    
2785    This method is more vulnerable than most to permission and compatability
2786    problems, so it does internal error recovery.
2787    
2788    =over 4
2789    
2790    =item dirName
2791    
2792    Name of the directory to process.
2793    
2794    =item group
2795    
2796    Name of the group to be assigned.
2797    
2798    =item mask
2799    
2800    Permission mask. Bits that are C<1> in this mask will be ORed into the
2801    permission bits of any file or directory that does not already have them
2802    set to 1.
2803    
2804    =item otherMasks
2805    
2806    Map of search patterns to permission masks. If a directory name matches
2807    one of the patterns, that directory and all its members and subdirectories
2808    will be assigned the new pattern. For example, the following would
2809    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2810    
2811        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2812    
2813    The list is ordered, so the following would use 0777 for C<tmp1> and
2814    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2815    
2816        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2817                                                       '^tmp' => 0666);
2818    
2819    Note that the pattern matches are all case-insensitive, and only directory
2820    names are matched, not file names.
2821    
2822    =back
2823    
2824    =cut
2825    
2826    sub SetPermissions {
2827        # Get the parameters.
2828        my ($dirName, $group, $mask, @otherMasks) = @_;
2829        # Set up for error recovery.
2830        eval {
2831            # Switch to the specified directory.
2832            ChDir($dirName);
2833            # Get the group ID.
2834            my $gid = getgrnam($group);
2835            # Get the mask for tracing.
2836            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2837            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2838            my $fixCount = 0;
2839            my $lookCount = 0;
2840            # @dirs will be a stack of directories to be processed.
2841            my @dirs = (getcwd());
2842            while (scalar(@dirs) > 0) {
2843                # Get the current directory.
2844                my $dir = pop @dirs;
2845                # Check for a match to one of the specified directory names. To do
2846                # that, we need to pull the individual part of the name off of the
2847                # whole path.
2848                my $simpleName = $dir;
2849                if ($dir =~ m!/([^/]+)$!) {
2850                    $simpleName = $1;
2851                }
2852                Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2853                # Search for a match.
2854                my $match = 0;
2855                my $i;
2856                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2857                    my $pattern = $otherMasks[$i];
2858                    if ($simpleName =~ /$pattern/i) {
2859                        $match = 1;
2860                    }
2861                }
2862                # Check for a match. Note we use $i-1 because the loop added 2
2863                # before terminating due to the match.
2864                if ($match && $otherMasks[$i-1] != $mask) {
2865                    # This directory matches one of the incoming patterns, and it's
2866                    # a different mask, so we process it recursively with that mask.
2867                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2868                } else {
2869                    # Here we can process normally. Get all of the non-hidden members.
2870                    my @submems = OpenDir($dir, 1);
2871                    for my $submem (@submems) {
2872                        # Get the full name.
2873                        my $thisMem = "$dir/$submem";
2874                        Trace("Checking member $thisMem.") if T(4);
2875                        $lookCount++;
2876                        if ($lookCount % 1000 == 0) {
2877                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2878                        }
2879                        # Fix the group.
2880                        chown -1, $gid, $thisMem;
2881                        # Insure this member is not a symlink.
2882                        if (! -l $thisMem) {
2883                            # Get its info.
2884                            my $fileInfo = stat $thisMem;
2885                            # Only proceed if we got the info. Otherwise, it's a hard link
2886                            # and we want to skip it anyway.
2887                            if ($fileInfo) {
2888                                my $fileMode = $fileInfo->mode;
2889                                if (($fileMode & $mask) != $mask) {
2890                                    # Fix this member.
2891                                    $fileMode |= $mask;
2892                                    chmod $fileMode, $thisMem;
2893                                    $fixCount++;
2894                                }
2895                                # If it's a subdirectory, stack it.
2896                                if (-d $thisMem) {
2897                                    push @dirs, $thisMem;
2898                                }
2899                            }
2900                        }
2901                    }
2902                }
2903            }
2904            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2905        };
2906        # Check for an error.
2907        if ($@) {
2908            Confess("SetPermissions error: $@");
2909        }
2910    }
2911    
2912    =head3 CompareLists
2913    
2914        my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
2915    
2916    Compare two lists of tuples, and return a hash analyzing the differences. The lists
2917    are presumed to be sorted alphabetically by the value in the $keyIndex column.
2918    The return value contains a list of items that are only in the new list
2919    (inserted) and only in the old list (deleted).
2920    
2921    =over 4
2922    
2923    =item newList
2924    
2925    Reference to a list of new tuples.
2926    
2927    =item oldList
2928    
2929    Reference to a list of old tuples.
2930    
2931    =item keyIndex (optional)
2932    
2933    Index into each tuple of its key field. The default is 0.
2934    
2935    =item RETURN
2936    
2937    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
2938    list (inserted) followed by a reference to the list of items that are only in the old
2939    list (deleted).
2940    
2941    =back
2942    
2943    =cut
2944    
2945    sub CompareLists {
2946        # Get the parameters.
2947        my ($newList, $oldList, $keyIndex) = @_;
2948        if (! defined $keyIndex) {
2949            $keyIndex = 0;
2950        }
2951        # Declare the return variables.
2952        my ($inserted, $deleted) = ([], []);
2953        # Loop through the two lists simultaneously.
2954        my ($newI, $oldI) = (0, 0);
2955        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
2956        while ($newI < $newN || $oldI < $oldN) {
2957            # Get the current object in each list. Note that if one
2958            # of the lists is past the end, we'll get undef.
2959            my $newItem = $newList->[$newI];
2960            my $oldItem = $oldList->[$oldI];
2961            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
2962                # The old item is not in the new list, so mark it deleted.
2963                push @{$deleted}, $oldItem;
2964                $oldI++;
2965            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
2966                # The new item is not in the old list, so mark it inserted.
2967                push @{$inserted}, $newItem;
2968                $newI++;
2969            } else {
2970                # The item is in both lists, so push forward.
2971                $oldI++;
2972                $newI++;
2973            }
2974        }
2975        # Return the result.
2976        return ($inserted, $deleted);
2977    }
2978    
2979    =head3 GetLine
2980    
2981        my @data = Tracer::GetLine($handle);
2982    
2983    Read a line of data from a tab-delimited file.
2984    
2985    =over 4
2986    
2987    =item handle
2988    
2989    Open file handle from which to read.
2990    
2991    =item RETURN
2992    
2993    Returns a list of the fields in the record read. The fields are presumed to be
2994    tab-delimited. If we are at the end of the file, then an empty list will be
2995    returned. If an empty line is read, a single list item consisting of a null
2996    string will be returned.
2997    
2998    =back
2999    
3000    =cut
3001    
3002    sub GetLine {
3003        # Get the parameters.
3004        my ($handle) = @_;
3005        # Declare the return variable.
3006        my @retVal = ();
3007        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
3008        # Read from the file.
3009        my $line = <$handle>;
3010        # Only proceed if we found something.
3011        if (defined $line) {
3012            # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
3013            # upload control and have a nonstandard EOL combination.
3014            $line =~ s/(\r|\n)+$//;
3015            # Here we do some fancy tracing to help in debugging complicated EOL marks.
3016            if (T(File => 4)) {
3017                my $escapedLine = $line;
3018                $escapedLine =~ s/\n/\\n/g;
3019                $escapedLine =~ s/\r/\\r/g;
3020                $escapedLine =~ s/\t/\\t/g;
3021                Trace("Line read: -->$escapedLine<--");
3022            }
3023            # If the line is empty, return a single empty string; otherwise, parse
3024            # it into fields.
3025            if ($line eq "") {
3026                push @retVal, "";
3027            } else {
3028                push @retVal, split /\t/,$line;
3029            }
3030        } else {
3031            # Trace the reason the read failed.
3032            Trace("End of file: $!") if T(File => 3);
3033        }
3034        # Return the result.
3035        return @retVal;
3036    }
3037    
3038    =head3 PutLine
3039    
3040        Tracer::PutLine($handle, \@fields, $eol);
3041    
3042    Write a line of data to a tab-delimited file. The specified field values will be
3043    output in tab-separated form, with a trailing new-line.
3044    
3045    =over 4
3046    
3047    =item handle
3048    
3049    Output file handle.
3050    
3051    =item fields
3052    
3053    List of field values.
3054    
3055    =item eol (optional)
3056    
3057    End-of-line character (default is "\n").
3058    
3059    =back
3060    
3061    =cut
3062    
3063    sub PutLine {
3064        # Get the parameters.
3065        my ($handle, $fields, $eol) = @_;
3066        # Write the data.
3067        print $handle join("\t", @{$fields}) . ($eol || "\n");
3068    }
3069    
3070    =head3 GenerateURL
3071    
3072        my $queryUrl = Tracer::GenerateURL($page, %parameters);
3073    
3074    Generate a GET-style URL for the specified page with the specified parameter
3075    names and values. The values will be URL-escaped automatically. So, for
3076    example
3077    
3078        Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3079    
3080    would return
3081    
3082        form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3083    
3084    =over 4
3085    
3086    =item page
3087    
3088    Page URL.
3089    
3090    =item parameters
3091    
3092    Hash mapping parameter names to parameter values.
3093    
3094    =item RETURN
3095    
3096    Returns a GET-style URL that goes to the specified page and passes in the
3097    specified parameters and values.
3098    
3099    =back
3100    
3101    =cut
3102    
3103    sub GenerateURL {
3104        # Get the parameters.
3105        my ($page, %parameters) = @_;
3106        # Prime the return variable with the page URL.
3107        my $retVal = $page;
3108        # Loop through the parameters, creating parameter elements in a list.
3109        my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3110        # If the list is nonempty, tack it on.
3111        if (@parmList) {
3112            $retVal .= "?" . join(";", @parmList);
3113        }
3114        # Return the result.
3115        return $retVal;
3116    }
3117    
3118    =head3 ApplyURL
3119    
3120        Tracer::ApplyURL($table, $target, $url);
3121    
3122    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3123    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3124    URL column will be deleted by this process and the target column will be HTML-escaped.
3125    
3126    This provides a simple way to process the results of a database query into something
3127    displayable by combining a URL with text.
3128    
3129    =over 4
3130    
3131    =item table
3132    
3133    Reference to a list of lists. The elements in the containing list will be updated by
3134    this method.
3135    
3136    =item target
3137    
3138    The index of the column to be converted into HTML.
3139    
3140    =item url
3141    
3142    The index of the column containing the URL. Note that the URL must have a recognizable
3143    C<http:> at the beginning.
3144    
3145    =back
3146    
3147    =cut
3148    
3149    sub ApplyURL {
3150        # Get the parameters.
3151        my ($table, $target, $url) = @_;
3152        # Loop through the table.
3153        for my $row (@{$table}) {
3154            # Apply the URL to the target cell.
3155            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3156            # Delete the URL from the row.
3157            delete $row->[$url];
3158        }
3159    }
3160    
3161    =head3 CombineURL
3162    
3163        my $combinedHtml = Tracer::CombineURL($text, $url);
3164    
3165    This method will convert the specified text into HTML hyperlinked to the specified
3166    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3167    is defined and begins with an C<http:> header.
3168    
3169    =over 4
3170    
3171    =item text
3172    
3173    Text to return. This will be HTML-escaped automatically.
3174    
3175    =item url
3176    
3177    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3178    will be returned without any hyperlinking.
3179    
3180    =item RETURN
3181    
3182    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3183    doesn't look right, the HTML-escaped text will be returned without any further
3184    modification.
3185    
3186    =back
3187    
3188    =cut
3189    
3190    sub CombineURL {
3191        # Get the parameters.
3192        my ($text, $url) = @_;
3193        # Declare the return variable.
3194        my $retVal = CGI::escapeHTML($text);
3195        # Verify the URL.
3196        if (defined($url) && $url =~ m!http://!i) {
3197            # It's good, so we apply it to the text.
3198            $retVal = "<a href=\"$url\">$retVal</a>";
3199        }
3200        # Return the result.
3201        return $retVal;
3202    }
3203    
3204    
3205  1;  1;

Legend:
Removed from v.1.45  
changed lines
  Added in v.1.92

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3