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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3