[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.91, Mon Aug 20 23:07:05 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 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 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 435  Line 608 
608          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
609          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
610      }      }
611      # 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
612      # be traced.      # wants emergency tracing.
613        if ($retOptions->{trace} eq 'E') {
614            ETracing($retOptions->{user});
615        } else {
616            # Here the tracing is controlled from the command line.
617      my @cats = @{$categories};      my @cats = @{$categories};
618      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
619          push @cats, "SQL";          push @cats, "SQL";
620      }      }
621      # Add the default categories.      # Add the default categories.
622      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
623      # Next, we create the category string by joining the categories.      # Next, we create the category string by joining the categories.
624      my $cats = join(" ", @cats);      my $cats = join(" ", @cats);
625      # 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 654 
654      }      }
655      # Now set up the tracing.      # Now set up the tracing.
656      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
657        }
658      # Check for the "h" option. If it is specified, dump the command-line      # Check for the "h" option. If it is specified, dump the command-line
659      # options and exit the program.      # options and exit the program.
660      if ($retOptions->{h}) {      if ($retOptions->{help}) {
661          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
662          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
663          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
664              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
665              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
666              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
667                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
668              }              }
669              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
670          }          }
671          exit(0);          exit(0);
672      }      }
673        # Trace the options, if applicable.
674        if (T(3)) {
675            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
676            Trace("Selected options: " . join(", ", sort @parms) . ".");
677        }
678      # Return the parsed parameters.      # Return the parsed parameters.
679      return ($retOptions, @retParameters);      return ($retOptions, @retParameters);
680  }  }
# Line 762  Line 945 
945      return $value;      return $value;
946  }  }
947    
948    =head3 ParseTraceDate
949    
950    C<< my $time = Tracer::ParseTraceDate($dateString); >>
951    
952    Convert a date from the trace file into a PERL timestamp.
953    
954    =over 4
955    
956    =item dateString
957    
958    The date string from the trace file. The format of the string is determined by the
959    L</Now> method.
960    
961    =item RETURN
962    
963    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
964    the time string is invalid.
965    
966    =back
967    
968    =cut
969    
970    sub ParseTraceDate {
971        # Get the parameters.
972        my ($dateString) = @_;
973        # Declare the return variable.
974        my $retVal;
975        # Parse the date.
976        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
977            # Create a time object. Note we need to convert the day, month,
978            # and year to a different base. Years count from 1900, and
979            # the internal month value is relocated to January = 0.
980            $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);
981        }
982        # Return the result.
983        return $retVal;
984    }
985    
986  =head3 LogErrors  =head3 LogErrors
987    
988  C<< Tracer::LogErrors($fileName); >>  C<< Tracer::LogErrors($fileName); >>
# Line 964  Line 1185 
1185      # Get the timestamp.      # Get the timestamp.
1186      my $timeStamp = Now();      my $timeStamp = Now();
1187      # 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.
1188      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $prefix = "[$timeStamp] <$LastCategory>: ";
1189        my $formatted = $prefix . Strip($message);
1190      # Process according to the destination.      # Process according to the destination.
1191      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1192          # Write the message to the standard output.          # Write the message to the standard output.
# Line 978  Line 1200 
1200      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
1201          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML and write it to the standard output.
1202          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($message);
1203          print "<p>$formatted</p>\n";          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";
1204      } elsif ($Destination eq "WARN") {      } elsif ($Destination eq "WARN") {
1205         # Emit the message as a warning.         # Emit the message as a warning.
1206         warn $message;         warn $message;
# Line 1043  Line 1265 
1265              if (!$package) {              if (!$package) {
1266                  $category = "main";                  $category = "main";
1267              } else {              } else {
1268                  $category = $package;                  my @cats = split /::/, $package;
1269                    $category = $cats[$#cats];
1270              }              }
1271          }          }
1272          # Save the category name.          # Save the category name.
# Line 1073  Line 1296 
1296    
1297  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>
1298    
1299  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,
1300  B<errors> and B<logFile>. If @words has the following format  B<errors> and B<logFile>. If @words has the following format
1301    
1302  C<< -logFile=error.log apple orange rutabaga >>  C<< -logFile=error.log apple orange rutabaga >>
# Line 1087  Line 1310 
1310  C<< apple orange rutabaga >>  C<< apple orange rutabaga >>
1311    
1312  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
1313  support for quote characters.  support for quote characters. Options can be specified with single or double hyphens.
1314    
1315  =over 4  =over 4
1316    
# Line 1112  Line 1335 
1335      my ($optionTable, @inputList) = @_;      my ($optionTable, @inputList) = @_;
1336      # Process any options in the input list.      # Process any options in the input list.
1337      my %overrides = ();      my %overrides = ();
1338      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
1339          # Get the current option.          # Get the current option.
1340          my $arg = shift @inputList;          my $arg = shift @inputList;
1341          # Pull out the option name.          # Pull out the option name.
1342          $arg =~ /^-([^=]*)/g;          $arg =~ /^--?([^=]*)/g;
1343          my $name = $1;          my $name = $1;
1344          # Check for an option value.          # Check for an option value.
1345          if ($arg =~ /\G=(.*)$/g) {          if ($arg =~ /\G=(.*)$/g) {
# Line 1346  Line 1569 
1569      return @inputList;      return @inputList;
1570  }  }
1571    
1572    =head3 Percent
1573    
1574    C<< my $percent = Tracer::Percent($number, $base); >>
1575    
1576    Returns the percent of the base represented by the given number. If the base
1577    is zero, returns zero.
1578    
1579    =over 4
1580    
1581    =item number
1582    
1583    Percent numerator.
1584    
1585    =item base
1586    
1587    Percent base.
1588    
1589    =item RETURN
1590    
1591    Returns the percentage of the base represented by the numerator.
1592    
1593    =back
1594    
1595    =cut
1596    
1597    sub Percent {
1598        # Get the parameters.
1599        my ($number, $base) = @_;
1600        # Declare the return variable.
1601        my $retVal = 0;
1602        # Compute the percent.
1603        if ($base != 0) {
1604            $retVal = $number * 100 / $base;
1605        }
1606        # Return the result.
1607        return $retVal;
1608    }
1609    
1610  =head3 GetFile  =head3 GetFile
1611    
1612  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
# Line 1379  Line 1640 
1640      # Declare the return variable.      # Declare the return variable.
1641      my @retVal = ();      my @retVal = ();
1642      # Open the file for input.      # Open the file for input.
1643      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 {  
1644          # Read the whole file into the return variable, stripping off any terminator          # Read the whole file into the return variable, stripping off any terminator
1645          # characters.          # characters.
1646          my $lineCount = 0;          my $lineCount = 0;
1647          while (my $line = <INPUTFILE>) {      while (my $line = <$handle>) {
1648              $lineCount++;              $lineCount++;
1649              $line = Strip($line);              $line = Strip($line);
1650              push @retVal, $line;              push @retVal, $line;
1651          }          }
1652          # Close it.          # Close it.
1653          close INPUTFILE;      close $handle;
1654          my $actualLines = @retVal;          my $actualLines = @retVal;
1655      }      Trace("$actualLines lines read from file $fileName.") if T(File => 2);
1656      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
1657      if (wantarray) {      if (wantarray) {
1658          return @retVal;          return @retVal;
# Line 1404  Line 1661 
1661      }      }
1662  }  }
1663    
1664    =head3 PutFile
1665    
1666    C<< Tracer::PutFile($fileName, \@lines); >>
1667    
1668    Write out a file from a list of lines of text.
1669    
1670    =over 4
1671    
1672    =item fileName
1673    
1674    Name of the output file.
1675    
1676    =item lines
1677    
1678    Reference to a list of text lines. The lines will be written to the file in order, with trailing
1679    new-line characters. Alternatively, may be a string, in which case the string will be written without
1680    modification.
1681    
1682    =back
1683    
1684    =cut
1685    
1686    sub PutFile {
1687        # Get the parameters.
1688        my ($fileName, $lines) = @_;
1689        # Open the output file.
1690        my $handle = Open(undef, ">$fileName");
1691        # Count the lines written.
1692        if (ref $lines ne 'ARRAY') {
1693            # Here we have a scalar, so we write it raw.
1694            print $handle $lines;
1695            Trace("Scalar put to file $fileName.") if T(File => 3);
1696        } else {
1697            # Write the lines one at a time.
1698            my $count = 0;
1699            for my $line (@{$lines}) {
1700                print $handle "$line\n";
1701                $count++;
1702            }
1703            Trace("$count lines put to file $fileName.") if T(File => 3);
1704        }
1705        # Close the output file.
1706        close $handle;
1707    }
1708    
1709  =head3 QTrace  =head3 QTrace
1710    
1711  C<< my $data = QTrace($format); >>  C<< my $data = QTrace($format); >>
# Line 1472  Line 1774 
1774  sub Confess {  sub Confess {
1775      # Get the parameters.      # Get the parameters.
1776      my ($message) = @_;      my ($message) = @_;
1777        if (! defined($FIG_Config::no_tool_hdr)) {
1778            # Here we have a tool header. Display its length so that the user can adjust the line numbers.
1779            my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
1780            # Only proceed if the tool header file is actually present.
1781            if (-f $toolHeaderFile) {
1782                my @lines = GetFile($toolHeaderFile);
1783                Trace("Tool header has " . scalar(@lines) . " lines.");
1784            }
1785        }
1786      # Trace the call stack.      # Trace the call stack.
1787      Cluck($message);      Cluck($message);
1788      # Abort the program.      # Abort the program.
# Line 1604  Line 1915 
1915    
1916  =head3 AddToListMap  =head3 AddToListMap
1917    
1918  C<< Tracer::AddToListMap(\%hash, $key, $value); >>  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>
1919    
1920  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
1921  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 1930 
1930    
1931  Key for which the value is to be added.  Key for which the value is to be added.
1932    
1933  =item value  =item value1, value2, ... valueN
1934    
1935  Value to add to the key's value list.  List of values to add to the key's value list.
1936    
1937  =back  =back
1938    
# Line 1629  Line 1940 
1940    
1941  sub AddToListMap {  sub AddToListMap {
1942      # Get the parameters.      # Get the parameters.
1943      my ($hash, $key, $value) = @_;      my ($hash, $key, @values) = @_;
1944      # Process according to whether or not the key already has a value.      # Process according to whether or not the key already has a value.
1945      if (! exists $hash->{$key}) {      if (! exists $hash->{$key}) {
1946          $hash->{$key} = [$value];          $hash->{$key} = [@values];
1947      } else {      } else {
1948          push @{$hash->{$key}}, $value;          push @{$hash->{$key}}, @values;
1949      }      }
1950  }  }
1951    
# Line 1642  Line 1953 
1953    
1954  C<< if (Tracer::DebugMode) { ...code... } >>  C<< if (Tracer::DebugMode) { ...code... } >>
1955    
1956  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.  
1957    
1958  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1959  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1960  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1961  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1962  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.  
1963    
1964  =cut  =cut
1965    
# Line 1663  Line 1972 
1972      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1973          $retVal = 1;          $retVal = 1;
1974      } else {      } else {
1975          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1976          my $pageString = PageBuilder::Build("<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1977      }      }
1978      # Return the determination indicator.      # Return the determination indicator.
1979      return $retVal;      return $retVal;
# Line 1817  Line 2125 
2125    
2126  =head3 ScriptSetup  =head3 ScriptSetup
2127    
2128  C<< my ($query, $varHash) = ScriptSetup(); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2129    
2130  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2131  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,
2132    the client should call L</ScriptFinish> to output the web page.
2133    
2134    This method calls L</ETracing> to configure tracing, which allows the tracing
2135    to be configured via the emergency tracing form on the debugging control panel.
2136    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2137    method, which includes every program that uses this method or L</StandardSetup>.
2138    
2139  The C<Trace> query parameter is used to determine whether or not tracing is active and  =over 4
2140  which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  
2141  the C<CGI> trace module will trace parameter and environment information. Parameters are  =item noTrace (optional)
2142  traced at level 3 and environment variables at level 4. At the end of the script, the  
2143  client should call L</ScriptFinish> to output the web page.  If specified, tracing will be suppressed. This is useful if the script wants to set up
2144    tracing manually.
2145    
2146    =item RETURN
2147    
2148    Returns a two-element list consisting of a CGI query object and a variable hash for
2149    the output page.
2150    
2151    =back
2152    
2153  =cut  =cut
2154    
2155  sub ScriptSetup {  sub ScriptSetup {
2156        # Get the parameters.
2157        my ($noTrace) = @_;
2158      # Get the CGI query object.      # Get the CGI query object.
2159      my $query = CGI->new();      my $cgi = CGI->new();
2160      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2161      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");  
     }  
2162      # Create the variable hash.      # Create the variable hash.
2163      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");  
     }  
2164      # Return the query object and variable hash.      # Return the query object and variable hash.
2165      return ($query, $varHash);      return ($cgi, $varHash);
2166  }  }
2167    
2168  =head3 ScriptFinish  =head3 ETracing
2169    
2170  C<< ScriptFinish($webData, $varHash); >>  C<< ETracing($parameter); >>
2171    
2172  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
2173  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
2174  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.
2175  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
2176  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
2177  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,
2178  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.  
2179    
2180  A typical standard script would loook like the following.  =over 4
2181    
2182      BEGIN {  =item parameter
         # Print the HTML header.  
         print "CONTENT-TYPE: text/html\n\n";  
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
2183    
2184      my ($query, $varHash) = ScriptSetup();  A parameter from which the tracing key is computed. If it is a scalar,
2185      eval {  that scalar is used as the tracing key. If it is a CGI object, the
2186          # ... get data from $query, put it in $varHash ...  tracing key is taken from the C<IP> cookie. If it is omitted, the
2187      };  tracing key is taken from the C<TRACING> environment variable. If it
2188      if ($@) {  is a CGI object and emergency tracing is not on, the C<Trace> and
2189          Trace("Script Error: $@") if T(0);  C<TF> parameters will be used to determine the type of tracing.
2190    
2191    =back
2192    
2193    =cut
2194    
2195    sub ETracing {
2196        # Get the parameter.
2197        my ($parameter) = @_;
2198        # Check for CGI mode.
2199        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2200        # Default to no tracing except errors.
2201        my ($tracing, $dest) = ("0", "WARN");
2202        # Check for emergency tracing.
2203        my $tkey = EmergencyKey($parameter);
2204        my $emergencyFile = EmergencyFileName($tkey);
2205        if (-e $emergencyFile) {
2206            # We have the file. Read in the data.
2207            my @tracing = GetFile($emergencyFile);
2208            # Pull off the time limit.
2209            my $expire = shift @tracing;
2210            # Convert it to seconds.
2211            $expire *= 3600;
2212            # Check the file data.
2213            my $stat = stat($emergencyFile);
2214            my ($now) = gettimeofday;
2215            if ($now - $stat->mtime > $expire) {
2216                # Delete the expired file.
2217                unlink $emergencyFile;
2218            } else {
2219                # Emergency tracing is on. Pull off the destination and
2220                # the trace level;
2221                $dest = shift @tracing;
2222                my $level = shift @tracing;
2223                # Convert the destination to a real tracing destination.
2224                # temp directory.
2225                $dest = EmergencyTracingDest($tkey, $dest);
2226                # Insure Tracer is specified.
2227                my %moduleHash = map { $_ => 1 } @tracing;
2228                $moduleHash{Tracer} = 1;
2229                # Set the trace parameter.
2230                $tracing = join(" ", $level, sort keys %moduleHash);
2231            }
2232        } elsif (defined $cgi) {
2233            # There's no emergency tracing, but we have a CGI object, so check
2234            # for tracing from the form parameters.
2235            if ($cgi->param('Trace')) {
2236                # Here the user has requested tracing via a form.
2237                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2238                $tracing = $cgi->param('Trace') . " Tracer";
2239            }
2240        }
2241        # Setup the tracing we've determined from all the stuff above.
2242        TSetup($tracing, $dest);
2243        # If we're a web script, trace the parameter and environment data.
2244        if (defined $cgi) {
2245            TraceParms($cgi);
2246        }
2247      }      }
     ScriptFinish("Html/MyTemplate.html", $varHash);  
2248    
2249  The idea here is that even if the script fails, you'll see trace messages and  =head3 EmergencyFileName
2250  useful output.  
2251    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2252    
2253    Return the emergency tracing file name. This is the file that specifies
2254    the tracing information.
2255    
2256  =over 4  =over 4
2257    
2258  =item webData  =item tkey
2259    
2260  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.  
2261    
2262  =item varHash (optional)  =item RETURN
2263    
2264  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.  
2265    
2266  =back  =back
2267    
2268  =cut  =cut
2269    
2270  sub ScriptFinish {  sub EmergencyFileName {
2271      # Get the parameters.      # Get the parameters.
2272      my ($webData, $varHash) = @_;      my ($tkey) = @_;
2273      # Check for a template file situation.      # Compute the emergency tracing file name.
2274      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;  
2275  }  }
2276    
2277  =head3 Insure  =head3 EmergencyFileTarget
2278    
2279  C<< Insure($dirName); >>  C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2280    
2281  Insure a directory is present.  Return the emergency tracing target file name. This is the file that receives
2282    the tracing output for file-based tracing.
2283    
2284  =over 4  =over 4
2285    
2286  =item dirName  =item tkey
2287    
2288  Name of the directory to check. If it does not exist, it will be created.  Tracing key for the current program.
2289    
2290    =item RETURN
2291    
2292    Returns the name of the file to contain the trace output.
2293    
2294  =back  =back
2295    
2296  =cut  =cut
2297    
2298  sub Insure {  sub EmergencyFileTarget {
2299      my ($dirName) = @_;      # Get the parameters.
2300      if (! -d $dirName) {      my ($tkey) = @_;
2301          Trace("Creating $dirName directory.") if T(2);      # Compute the emergency tracing file name.
2302          eval { mkpath $dirName; };      return "$FIG_Config::temp/trace$tkey.log";
         if ($@) {  
             Confess("Error creating $dirName: $@");  
         }  
     }  
2303  }  }
2304    
2305  =head3 ChDir  =head3 EmergencyTracingDest
2306    
2307  C<< ChDir($dirName); >>  C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2308    
2309  Change to the specified directory.  This method converts an emergency tracing destination to a real
2310    tracing destination. The main difference is that if the
2311    destination is C<FILE> or C<APPEND>, we convert it to file
2312    output. If the destination is C<DUAL>, we convert it to file
2313    and standard output.
2314    
2315  =over 4  =over 4
2316    
2317  =item dirName  =item tkey
2318    
2319  Name of the directory to which we want to change.  Tracing key for this environment.
2320    
2321    =item myDest
2322    
2323    Destination from the emergency tracing file.
2324    
2325    =item RETURN
2326    
2327    Returns a destination that can be passed into L</TSetup>.
2328    
2329  =back  =back
2330    
2331  =cut  =cut
2332    
2333  sub ChDir {  sub EmergencyTracingDest {
2334      my ($dirName) = @_;      # Get the parameters.
2335      if (! -d $dirName) {      my ($tkey, $myDest) = @_;
2336          Confess("Cannot change to directory $dirName: no such directory.");      # Declare the return variable.
2337      } else {      my $retVal = $myDest;
2338          Trace("Changing to directory $dirName.") if T(4);      # Process according to the destination value.
2339          my $okFlag = chdir $dirName;      if ($myDest eq 'FILE') {
2340            $retVal = ">" . EmergencyFileTarget($tkey);
2341        } elsif ($myDest eq 'APPEND') {
2342            $retVal = ">>" . EmergencyFileTarget($tkey);
2343        } elsif ($myDest eq 'DUAL') {
2344            $retVal = "+>" . EmergencyFileTarget($tkey);
2345        }
2346        # Return the result.
2347        return $retVal;
2348    }
2349    
2350    =head3 Emergency
2351    
2352    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2353    
2354    Turn on emergency tracing. This method is normally invoked over the web from
2355    a debugging console, but it can also be called by the C<trace.pl> script.
2356    The caller specifies the duration of the emergency in hours, the desired tracing
2357    destination, the trace level, and a list of the trace modules to activate.
2358    For the length of the duration, when a program in an environment with the
2359    specified tracing key active invokes a Sprout CGI script, tracing will be
2360    turned on automatically. See L</TSetup> for more about tracing setup and
2361    L</ETracing> for more about emergency tracing.
2362    
2363    =over 4
2364    
2365    =item tkey
2366    
2367    The tracing key. This is used to identify the control file and the trace file.
2368    
2369    =item hours
2370    
2371    Number of hours to keep emergency tracing alive.
2372    
2373    =item dest
2374    
2375    Tracing destination. If no path information is specified for a file
2376    destination, it is put in the FIG temporary directory.
2377    
2378    =item level
2379    
2380    Tracing level. A higher level means more trace messages.
2381    
2382    =item modules
2383    
2384    A list of the tracing modules to activate.
2385    
2386    =back
2387    
2388    =cut
2389    
2390    sub Emergency {
2391        # Get the parameters.
2392        my ($tkey, $hours, $dest, $level, @modules) = @_;
2393        # Create the emergency file.
2394        my $specFile = EmergencyFileName($tkey);
2395        my $outHandle = Open(undef, ">$specFile");
2396        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2397    }
2398    
2399    =head3 EmergencyKey
2400    
2401    C<< my $tkey = EmergencyKey($parameter); >>
2402    
2403    Return the Key to be used for emergency tracing. This could be an IP address,
2404     a session ID, or a user name, depending on the environment.
2405    
2406    =over 4
2407    
2408    =item parameter
2409    
2410    Parameter defining the method for finding the tracing key. If it is a scalar,
2411    then it is presumed to be the tracing key itself. If it is a CGI object, then
2412    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2413    taken from the C<TRACING> environment variable.
2414    
2415    =item RETURN
2416    
2417    Returns the key to be used for labels in emergency tracing.
2418    
2419    =back
2420    
2421    =cut
2422    
2423    sub EmergencyKey {
2424        # Get the parameters.
2425        my ($parameter) = @_;
2426        # Declare the return variable.
2427        my $retVal;
2428        # Determine the parameter type.
2429        if (! defined $parameter) {
2430            # Here we're supposed to check the environment.
2431            $retVal = $ENV{TRACING};
2432        } else {
2433            my $ptype = ref $parameter;
2434            if ($ptype eq 'CGI') {
2435                # Here we were invoked from a web page. Look for a cookie.
2436                $retVal = $parameter->cookie('IP');
2437            } elsif (! $ptype) {
2438                # Here the key was passed in.
2439                $retVal = $parameter;
2440            }
2441        }
2442        # If no luck finding a key, use the PID.
2443        if (! defined $retVal) {
2444            $retVal = $$;
2445        }
2446        # Return the result.
2447        return $retVal;
2448    }
2449    
2450    
2451    =head3 TraceParms
2452    
2453    C<< Tracer::TraceParms($cgi); >>
2454    
2455    Trace the CGI parameters at trace level CGI => 3 and the environment variables
2456    at level CGI => 4.
2457    
2458    =over 4
2459    
2460    =item cgi
2461    
2462    CGI query object containing the parameters to trace.
2463    
2464    =back
2465    
2466    =cut
2467    
2468    sub TraceParms {
2469        # Get the parameters.
2470        my ($cgi) = @_;
2471        if (T(CGI => 3)) {
2472            # Here we want to trace the parameter data.
2473            my @names = $cgi->param;
2474            for my $parmName (sort @names) {
2475                # Note we skip the Trace parameters, which are for our use only.
2476                if ($parmName ne 'Trace' && $parmName ne 'TF') {
2477                    my @values = $cgi->param($parmName);
2478                    Trace("CGI: $parmName = " . join(", ", @values));
2479                }
2480            }
2481            # Display the request method.
2482            my $method = $cgi->request_method();
2483            Trace("Method: $method");
2484        }
2485        if (T(CGI => 4)) {
2486            # Here we want the environment data too.
2487            for my $envName (sort keys %ENV) {
2488                Trace("ENV: $envName = $ENV{$envName}");
2489            }
2490        }
2491    }
2492    
2493    =head3 ScriptFinish
2494    
2495    C<< ScriptFinish($webData, $varHash); >>
2496    
2497    Output a web page at the end of a script. Either the string to be output or the
2498    name of a template file can be specified. If the second parameter is omitted,
2499    it is assumed we have a string to be output; otherwise, it is assumed we have the
2500    name of a template file. The template should have the variable C<DebugData>
2501    specified in any form that invokes a standard script. If debugging mode is turned
2502    on, a form field will be put in that allows the user to enter tracing data.
2503    Trace messages will be placed immediately before the terminal C<BODY> tag in
2504    the output, formatted as a list.
2505    
2506    A typical standard script would loook like the following.
2507    
2508        BEGIN {
2509            # Print the HTML header.
2510            print "CONTENT-TYPE: text/html\n\n";
2511        }
2512        use Tracer;
2513        use CGI;
2514        use FIG;
2515        # ... more uses ...
2516    
2517        my ($cgi, $varHash) = ScriptSetup();
2518        eval {
2519            # ... get data from $cgi, put it in $varHash ...
2520        };
2521        if ($@) {
2522            Trace("Script Error: $@") if T(0);
2523        }
2524        ScriptFinish("Html/MyTemplate.html", $varHash);
2525    
2526    The idea here is that even if the script fails, you'll see trace messages and
2527    useful output.
2528    
2529    =over 4
2530    
2531    =item webData
2532    
2533    A string containing either the full web page to be written to the output or the
2534    name of a template file from which the page is to be constructed. If the name
2535    of a template file is specified, then the second parameter must be present;
2536    otherwise, it must be absent.
2537    
2538    =item varHash (optional)
2539    
2540    If specified, then a reference to a hash mapping variable names for a template
2541    to their values. The template file will be read into memory, and variable markers
2542    will be replaced by data in this hash reference.
2543    
2544    =back
2545    
2546    =cut
2547    
2548    sub ScriptFinish {
2549        # Get the parameters.
2550        my ($webData, $varHash) = @_;
2551        # Check for a template file situation.
2552        my $outputString;
2553        if (defined $varHash) {
2554            # Here we have a template file. We need to determine the template type.
2555            my $template;
2556            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
2557                $template = "$FIG_Config::template_url/$webData";
2558            } else {
2559                $template = "<<$webData";
2560            }
2561            $outputString = PageBuilder::Build($template, $varHash, "Html");
2562        } else {
2563            # Here the user gave us a raw string.
2564            $outputString = $webData;
2565        }
2566        # Check for trace messages.
2567        if ($Destination ne "NONE" && $TraceLevel > 0) {
2568            # We have trace messages, so we want to put them at the end of the body. This
2569            # is either at the end of the whole string or at the beginning of the BODY
2570            # end-tag.
2571            my $pos = length $outputString;
2572            if ($outputString =~ m#</body>#gi) {
2573                $pos = (pos $outputString) - 7;
2574            }
2575            # If the trace messages were queued, we unroll them. Otherwise, we display the
2576            # destination.
2577            my $traceHtml;
2578            if ($Destination eq "QUEUE") {
2579                $traceHtml = QTrace('Html');
2580            } elsif ($Destination =~ /^>>(.+)$/) {
2581                # Here the tracing output it to a file. We code it as a hyperlink so the user
2582                # can copy the file name into the clipboard easily.
2583                my $actualDest = $1;
2584                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2585            } else {
2586                # Here we have one of the special destinations.
2587                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2588            }
2589            substr $outputString, $pos, 0, $traceHtml;
2590        }
2591        # Write the output string.
2592        print $outputString;
2593    }
2594    
2595    =head3 Insure
2596    
2597    C<< Insure($dirName, $chmod); >>
2598    
2599    Insure a directory is present.
2600    
2601    =over 4
2602    
2603    =item dirName
2604    
2605    Name of the directory to check. If it does not exist, it will be created.
2606    
2607    =item chmod (optional)
2608    
2609    Security privileges to be given to the directory if it is created.
2610    
2611    =back
2612    
2613    =cut
2614    
2615    sub Insure {
2616        my ($dirName, $chmod) = @_;
2617        if (! -d $dirName) {
2618            Trace("Creating $dirName directory.") if T(2);
2619            eval {
2620                mkpath $dirName;
2621                # If we have permissions specified, set them here.
2622                if (defined($chmod)) {
2623                    chmod $chmod, $dirName;
2624                }
2625            };
2626            if ($@) {
2627                Confess("Error creating $dirName: $@");
2628            }
2629        }
2630    }
2631    
2632    =head3 ChDir
2633    
2634    C<< ChDir($dirName); >>
2635    
2636    Change to the specified directory.
2637    
2638    =over 4
2639    
2640    =item dirName
2641    
2642    Name of the directory to which we want to change.
2643    
2644    =back
2645    
2646    =cut
2647    
2648    sub ChDir {
2649        my ($dirName) = @_;
2650        if (! -d $dirName) {
2651            Confess("Cannot change to directory $dirName: no such directory.");
2652        } else {
2653            Trace("Changing to directory $dirName.") if T(File => 4);
2654            my $okFlag = chdir $dirName;
2655          if (! $okFlag) {          if (! $okFlag) {
2656              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
2657          }          }
2658      }      }
2659  }  }
2660    
2661    =head3 SendSMS
2662    
2663    C<< my $msgID = Tracer::SendSMS($phoneNumber, $msg); >>
2664    
2665    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
2666    user name, password, and API ID for the relevant account in the hash reference variable
2667    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
2668    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
2669    is C<2561022>, then the FIG_Config file must contain
2670    
2671        $phone =  { user => 'BruceTheHumanPet',
2672                    password => 'silly',
2673                    api_id => '2561022' };
2674    
2675    The original purpose of this method was to insure Bruce would be notified immediately when the
2676    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
2677    when you call this method.
2678    
2679    The message ID will be returned if successful, and C<undef> if an error occurs.
2680    
2681    =over 4
2682    
2683    =item phoneNumber
2684    
2685    Phone number to receive the message, in international format. A United States phone number
2686    would be prefixed by "1". A British phone number would be prefixed by "44".
2687    
2688    =item msg
2689    
2690    Message to send to the specified phone.
2691    
2692    =item RETURN
2693    
2694    Returns the message ID if successful, and C<undef> if the message could not be sent.
2695    
2696    =back
2697    
2698    =cut
2699    
2700    sub SendSMS {
2701        # Get the parameters.
2702        my ($phoneNumber, $msg) = @_;
2703        # Declare the return variable. If we do not change it, C<undef> will be returned.
2704        my $retVal;
2705        # Only proceed if we have phone support.
2706        if (! defined $FIG_Config::phone) {
2707            Trace("Phone support not present in FIG_Config.") if T(1);
2708        } else {
2709            # Get the phone data.
2710            my $parms = $FIG_Config::phone;
2711            # Get the Clickatell URL.
2712            my $url = "http://api.clickatell.com/http/";
2713            # Create the user agent.
2714            my $ua = LWP::UserAgent->new;
2715            # Request a Clickatell session.
2716            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
2717                                         password => $parms->{password},
2718                                         api_id => $parms->{api_id},
2719                                         to => $phoneNumber,
2720                                         text => $msg});
2721            # Check for an error.
2722            if (! $resp->is_success) {
2723                Trace("Alert failed.") if T(1);
2724            } else {
2725                # Get the message ID.
2726                my $rstring = $resp->content;
2727                if ($rstring =~ /^ID:\s+(.*)$/) {
2728                    $retVal = $1;
2729                } else {
2730                    Trace("Phone attempt failed with $rstring") if T(1);
2731                }
2732            }
2733        }
2734        # Return the result.
2735        return $retVal;
2736    }
2737    
2738    =head3 CommaFormat
2739    
2740    C<< my $formatted = Tracer::CommaFormat($number); >>
2741    
2742    Insert commas into a number.
2743    
2744    =over 4
2745    
2746    =item number
2747    
2748    A sequence of digits.
2749    
2750    =item RETURN
2751    
2752    Returns the same digits with commas strategically inserted.
2753    
2754    =back
2755    
2756    =cut
2757    
2758    sub CommaFormat {
2759        # Get the parameters.
2760        my ($number) = @_;
2761        # Pad the length up to a multiple of three.
2762        my $padded = "$number";
2763        $padded = " " . $padded while length($padded) % 3 != 0;
2764        # This is a fancy PERL trick. The parentheses in the SPLIT pattern
2765        # cause the delimiters to be included in the output stream. The
2766        # GREP removes the empty strings in between the delimiters.
2767        my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
2768        # Clean out the spaces.
2769        $retVal =~ s/ //g;
2770        # Return the result.
2771        return $retVal;
2772    }
2773    =head3 SetPermissions
2774    
2775    C<< Tracer::SetPermissions($dirName, $group, $mask, %otherMasks); >>
2776    
2777    Set the permissions for a directory and all the files and folders inside it.
2778    In addition, the group ownership will be changed to the specified value.
2779    
2780    This method is more vulnerable than most to permission and compatability
2781    problems, so it does internal error recovery.
2782    
2783    =over 4
2784    
2785    =item dirName
2786    
2787    Name of the directory to process.
2788    
2789    =item group
2790    
2791    Name of the group to be assigned.
2792    
2793    =item mask
2794    
2795    Permission mask. Bits that are C<1> in this mask will be ORed into the
2796    permission bits of any file or directory that does not already have them
2797    set to 1.
2798    
2799    =item otherMasks
2800    
2801    Map of search patterns to permission masks. If a directory name matches
2802    one of the patterns, that directory and all its members and subdirectories
2803    will be assigned the new pattern. For example, the following would
2804    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2805    
2806        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2807    
2808    The list is ordered, so the following would use 0777 for C<tmp1> and
2809    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2810    
2811        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2812                                                       '^tmp' => 0666);
2813    
2814    Note that the pattern matches are all case-insensitive, and only directory
2815    names are matched, not file names.
2816    
2817    =back
2818    
2819    =cut
2820    
2821    sub SetPermissions {
2822        # Get the parameters.
2823        my ($dirName, $group, $mask, @otherMasks) = @_;
2824        # Set up for error recovery.
2825        eval {
2826            # Switch to the specified directory.
2827            ChDir($dirName);
2828            # Get the group ID.
2829            my $gid = getgrnam($group);
2830            # Get the mask for tracing.
2831            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2832            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2833            my $fixCount = 0;
2834            my $lookCount = 0;
2835            # @dirs will be a stack of directories to be processed.
2836            my @dirs = (getcwd());
2837            while (scalar(@dirs) > 0) {
2838                # Get the current directory.
2839                my $dir = pop @dirs;
2840                # Check for a match to one of the specified directory names. To do
2841                # that, we need to pull the individual part of the name off of the
2842                # whole path.
2843                my $simpleName = $dir;
2844                if ($dir =~ m!/([^/]+)$!) {
2845                    $simpleName = $1;
2846                }
2847                Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2848                # Search for a match.
2849                my $match = 0;
2850                my $i;
2851                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2852                    my $pattern = $otherMasks[$i];
2853                    if ($simpleName =~ /$pattern/i) {
2854                        $match = 1;
2855                    }
2856                }
2857                # Check for a match. Note we use $i-1 because the loop added 2
2858                # before terminating due to the match.
2859                if ($match && $otherMasks[$i-1] != $mask) {
2860                    # This directory matches one of the incoming patterns, and it's
2861                    # a different mask, so we process it recursively with that mask.
2862                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2863                } else {
2864                    # Here we can process normally. Get all of the non-hidden members.
2865                    my @submems = OpenDir($dir, 1);
2866                    for my $submem (@submems) {
2867                        # Get the full name.
2868                        my $thisMem = "$dir/$submem";
2869                        Trace("Checking member $thisMem.") if T(4);
2870                        $lookCount++;
2871                        if ($lookCount % 1000 == 0) {
2872                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2873                        }
2874                        # Fix the group.
2875                        chown -1, $gid, $thisMem;
2876                        # Insure this member is not a symlink.
2877                        if (! -l $thisMem) {
2878                            # Get its info.
2879                            my $fileInfo = stat $thisMem;
2880                            # Only proceed if we got the info. Otherwise, it's a hard link
2881                            # and we want to skip it anyway.
2882                            if ($fileInfo) {
2883                                my $fileMode = $fileInfo->mode;
2884                                if (($fileMode & $mask) != $mask) {
2885                                    # Fix this member.
2886                                    $fileMode |= $mask;
2887                                    chmod $fileMode, $thisMem;
2888                                    $fixCount++;
2889                                }
2890                                # If it's a subdirectory, stack it.
2891                                if (-d $thisMem) {
2892                                    push @dirs, $thisMem;
2893                                }
2894                            }
2895                        }
2896                    }
2897                }
2898            }
2899            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2900        };
2901        # Check for an error.
2902        if ($@) {
2903            Confess("SetPermissions error: $@");
2904        }
2905    }
2906    
2907    =head3 CompareLists
2908    
2909    C<< my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex); >>
2910    
2911    Compare two lists of tuples, and return a hash analyzing the differences. The lists
2912    are presumed to be sorted alphabetically by the value in the $keyIndex column.
2913    The return value contains a list of items that are only in the new list
2914    (inserted) and only in the old list (deleted).
2915    
2916    =over 4
2917    
2918    =item newList
2919    
2920    Reference to a list of new tuples.
2921    
2922    =item oldList
2923    
2924    Reference to a list of old tuples.
2925    
2926    =item keyIndex (optional)
2927    
2928    Index into each tuple of its key field. The default is 0.
2929    
2930    =item RETURN
2931    
2932    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
2933    list (inserted) followed by a reference to the list of items that are only in the old
2934    list (deleted).
2935    
2936    =back
2937    
2938    =cut
2939    
2940    sub CompareLists {
2941        # Get the parameters.
2942        my ($newList, $oldList, $keyIndex) = @_;
2943        if (! defined $keyIndex) {
2944            $keyIndex = 0;
2945        }
2946        # Declare the return variables.
2947        my ($inserted, $deleted) = ([], []);
2948        # Loop through the two lists simultaneously.
2949        my ($newI, $oldI) = (0, 0);
2950        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
2951        while ($newI < $newN || $oldI < $oldN) {
2952            # Get the current object in each list. Note that if one
2953            # of the lists is past the end, we'll get undef.
2954            my $newItem = $newList->[$newI];
2955            my $oldItem = $oldList->[$oldI];
2956            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
2957                # The old item is not in the new list, so mark it deleted.
2958                push @{$deleted}, $oldItem;
2959                $oldI++;
2960            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
2961                # The new item is not in the old list, so mark it inserted.
2962                push @{$inserted}, $newItem;
2963                $newI++;
2964            } else {
2965                # The item is in both lists, so push forward.
2966                $oldI++;
2967                $newI++;
2968            }
2969        }
2970        # Return the result.
2971        return ($inserted, $deleted);
2972    }
2973    
2974    =head3 GetLine
2975    
2976    C<< my @data = Tracer::GetLine($handle); >>
2977    
2978    Read a line of data from a tab-delimited file.
2979    
2980    =over 4
2981    
2982    =item handle
2983    
2984    Open file handle from which to read.
2985    
2986    =item RETURN
2987    
2988    Returns a list of the fields in the record read. The fields are presumed to be
2989    tab-delimited. If we are at the end of the file, then an empty list will be
2990    returned. If an empty line is read, a single list item consisting of a null
2991    string will be returned.
2992    
2993    =back
2994    
2995    =cut
2996    
2997    sub GetLine {
2998        # Get the parameters.
2999        my ($handle) = @_;
3000        # Declare the return variable.
3001        my @retVal = ();
3002        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
3003        # Read from the file.
3004        my $line = <$handle>;
3005        # Only proceed if we found something.
3006        if (defined $line) {
3007            # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
3008            # upload control and have a nonstandard EOL combination.
3009            $line =~ s/(\r|\n)+$//;
3010            # Here we do some fancy tracing to help in debugging complicated EOL marks.
3011            if (T(File => 4)) {
3012                my $escapedLine = $line;
3013                $escapedLine =~ s/\n/\\n/g;
3014                $escapedLine =~ s/\r/\\r/g;
3015                $escapedLine =~ s/\t/\\t/g;
3016                Trace("Line read: -->$escapedLine<--");
3017            }
3018            # If the line is empty, return a single empty string; otherwise, parse
3019            # it into fields.
3020            if ($line eq "") {
3021                push @retVal, "";
3022            } else {
3023                push @retVal, split /\t/,$line;
3024            }
3025        } else {
3026            # Trace the reason the read failed.
3027            Trace("End of file: $!") if T(File => 3);
3028        }
3029        # Return the result.
3030        return @retVal;
3031    }
3032    
3033    =head3 PutLine
3034    
3035    C<< Tracer::PutLine($handle, \@fields, $eol); >>
3036    
3037    Write a line of data to a tab-delimited file. The specified field values will be
3038    output in tab-separated form, with a trailing new-line.
3039    
3040    =over 4
3041    
3042    =item handle
3043    
3044    Output file handle.
3045    
3046    =item fields
3047    
3048    List of field values.
3049    
3050    =item eol (optional)
3051    
3052    End-of-line character (default is "\n").
3053    
3054    =back
3055    
3056    =cut
3057    
3058    sub PutLine {
3059        # Get the parameters.
3060        my ($handle, $fields, $eol) = @_;
3061        # Write the data.
3062        print $handle join("\t", @{$fields}) . ($eol || "\n");
3063    }
3064    
3065    =head3 GenerateURL
3066    
3067    C<< my $queryUrl = Tracer::GenerateURL($page, %parameters); >>
3068    
3069    Generate a GET-style URL for the specified page with the specified parameter
3070    names and values. The values will be URL-escaped automatically. So, for
3071    example
3072    
3073        Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3074    
3075    would return
3076    
3077        form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3078    
3079    =over 4
3080    
3081    =item page
3082    
3083    Page URL.
3084    
3085    =item parameters
3086    
3087    Hash mapping parameter names to parameter values.
3088    
3089    =item RETURN
3090    
3091    Returns a GET-style URL that goes to the specified page and passes in the
3092    specified parameters and values.
3093    
3094    =back
3095    
3096    =cut
3097    
3098    sub GenerateURL {
3099        # Get the parameters.
3100        my ($page, %parameters) = @_;
3101        # Prime the return variable with the page URL.
3102        my $retVal = $page;
3103        # Loop through the parameters, creating parameter elements in a list.
3104        my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3105        # If the list is nonempty, tack it on.
3106        if (@parmList) {
3107            $retVal .= "?" . join(";", @parmList);
3108        }
3109        # Return the result.
3110        return $retVal;
3111    }
3112    
3113    =head3 ApplyURL
3114    
3115    C<< Tracer::ApplyURL($table, $target, $url); >>
3116    
3117    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3118    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3119    URL column will be deleted by this process and the target column will be HTML-escaped.
3120    
3121    This provides a simple way to process the results of a database query into something
3122    displayable by combining a URL with text.
3123    
3124    =over 4
3125    
3126    =item table
3127    
3128    Reference to a list of lists. The elements in the containing list will be updated by
3129    this method.
3130    
3131    =item target
3132    
3133    The index of the column to be converted into HTML.
3134    
3135    =item url
3136    
3137    The index of the column containing the URL. Note that the URL must have a recognizable
3138    C<http:> at the beginning.
3139    
3140    =back
3141    
3142    =cut
3143    
3144    sub ApplyURL {
3145        # Get the parameters.
3146        my ($table, $target, $url) = @_;
3147        # Loop through the table.
3148        for my $row (@{$table}) {
3149            # Apply the URL to the target cell.
3150            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3151            # Delete the URL from the row.
3152            delete $row->[$url];
3153        }
3154    }
3155    
3156    =head3 CombineURL
3157    
3158    C<< my $combinedHtml = Tracer::CombineURL($text, $url); >>
3159    
3160    This method will convert the specified text into HTML hyperlinked to the specified
3161    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3162    is defined and begins with an C<http:> header.
3163    
3164    =over 4
3165    
3166    =item text
3167    
3168    Text to return. This will be HTML-escaped automatically.
3169    
3170    =item url
3171    
3172    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3173    will be returned without any hyperlinking.
3174    
3175    =item RETURN
3176    
3177    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3178    doesn't look right, the HTML-escaped text will be returned without any further
3179    modification.
3180    
3181    =back
3182    
3183    =cut
3184    
3185    sub CombineURL {
3186        # Get the parameters.
3187        my ($text, $url) = @_;
3188        # Declare the return variable.
3189        my $retVal = CGI::escapeHTML($text);
3190        # Verify the URL.
3191        if (defined($url) && $url =~ m!http://!i) {
3192            # It's good, so we apply it to the text.
3193            $retVal = "<a href=\"$url\">$retVal</a>";
3194        }
3195        # Return the result.
3196        return $retVal;
3197    }
3198    
3199    
3200  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3