[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.62, Thu Aug 24 07:58:29 2006 UTC revision 1.79, Thu Nov 9 21:12:46 2006 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);
# Line 32  Line 32 
32      use File::Path;      use File::Path;
33      use File::stat;      use File::stat;
34      use LWP::UserAgent;      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 59  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  To set up tracing, you call the L</TSetup> method. The method takes as input a trace level, a list  =head3 Custom Tracing
74  of category names, and a set of options. The trace level and list of category names are  
75    Many programs have customized tracing configured using the L</TSetup> method. This is no longer
76    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 119  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    =head3 Debugging Control Panel
190    
191    The debugging control panel provides several tools to assist in development of
192    SEED and Sprout software. You access the debugging control panel from the URL
193    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
194    for example, the panel access point for the development NMPDR system is
195    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
196    find out what the password is. From this page, you can also specify a tracing
197    key. If you don't specify a key, one will be generated for you.
198    
199    =head4 Emergency Tracing Form
200    
201    At the bottom of the debugging control panel is a form that allows you to
202    specify a trace level and tracing categories. Special and common categories
203    are listed with check boxes. You can hold your mouse over a check box to see
204    what its category does. In general, however, a category name is the same as
205    the name of the package in which the trace message occurs.
206    
207    Additional categories can be entered in an input box, delimited by spaces or commas.
208    
209    The B<Activate> button turns on Emergency tracing at the level you specify with the
210    specified categories active. The B<Terminate> button turns tracing off. The
211    B<Show File> button displays the current contents of the trace file. The tracing
212    form at the bottom of the control panel is designed for emergency tracing, so it
213    will only affect programs that call L</ETracing>, L</StandardScript>,
214    or L</StandardSetup>.
215    
216    =head4 Script Form
217    
218    The top form of the debugging control panel allows you to enter a tiny script and
219    have the output generated in a formatted table. Certain object variables are
220    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
221    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
222    
223    The last line of the script must be a scalar, but it can be a reference to a hash,
224    a list, a list of lists, and various other combinations. If you select the appropriate
225    data type in the dropdown box, the output will be formatted accordingly. The form
226    also has controls for specifying tracing. These controls override any emergency
227    tracing in effect.
228    
229    =head4 Database Query Forms
230    
231    The forms between the script form and the emergency tracing form allow you to
232    make queries against the database. The FIG query form allows simple queries against
233    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
234    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
235    package, and it takes five parameters.
236    
237        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
238    
239    Each of the five parameters corresponds to a text box on the query form:
240    
241    =over 4
242    
243    =item Objects
244    
245    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
246    
247    =item Filter
248    
249    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
250    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
251    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
252    field, I<objectName> is the name of the entity or relationship object containing the field, and
253    I<number> is the 1-based position of the object in the object list. Any parameters
254    specified in the filter clause should be specified in the B<Params> field.
255    The fields in a filter clause can come from primary entity relations,
256    relationship relations, or secondary entity relations; however, all of the
257    entities and relationships involved must be included in the list of object names.
258    
259    =item Params
260    
261    List of the parameters to be substituted in for the parameters marks in the filter clause. This
262    is a comma-separated list without any quoting or escaping.
263    
264    =item fields
265    
266    Comma-separated list of the fields to be returned in each element of the list returned. Fields
267    are specified in the same manner as in the filter clause.
268    
269    =item count
270    
271    Maximum number of records to return. If omitted or 0, all available records will be returned.
272    
273    =back
274    
275    B<GetAll> automatically joins together the entities and relationships listed in the object
276    names. This simplifies the coding of the filter clause, but it means that some queries are
277    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
278    that has yet to be addressed.
279    
280  =cut  =cut
281    
282  # Declare the configuration variables.  # Declare the configuration variables.
# Line 198  Line 356 
356          }          }
357          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
358              open TRACEFILE, $target;              open TRACEFILE, $target;
359              print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
360              close TRACEFILE;              close TRACEFILE;
361              $Destination = ">$target";              $Destination = ">$target";
362          } else {          } else {
# Line 231  Line 389 
389      ["Sprout", "SproutLoad", "ERDB"]      ["Sprout", "SproutLoad", "ERDB"]
390    
391  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
392  the output. There are threer special tracing categories that are automatically  the output. There are two special tracing categories that are automatically
393  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
394  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
395  on automatically.  on automatically.
396    
397  =over 4  =over 4
398    
 =item FIG  
   
 Turns on trace messages inside the B<FIG> package.  
   
399  =item SQL  =item SQL
400    
401  Traces SQL commands and activity.  Traces SQL commands and activity.
# Line 306  Line 460 
460  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
461  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
462  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
463  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,
464  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
465  to this method. The I<$options> hash would be  to this method. The I<$options> hash would be
466    
# Line 331  Line 485 
485  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
486  simplify starting a command in the background.  simplify starting a command in the background.
487    
488    The user name is also used as the tracing key for L</Emergency Tracing>.
489    Specifying a value of C<E> for the trace level causes emergency tracing to
490    be used instead of custom tracing. If the user name is not specified,
491    the tracing key is taken from the C<Tracing> environment variable. If there
492    is no value for that variable, the tracing key will be computed from the PID.
493    
494  Finally, if the special option C<-h> is specified, the option names will  Finally, if the special option C<-h> is specified, the option names will
495  be traced at level 0 and the program will exit without processing.  be traced at level 0 and the program will exit without processing.
496  This provides a limited help capability. For example, if the user enters  This provides a limited help capability. For example, if the user enters
# Line 340  Line 500 
500  he would see the following output.  he would see the following output.
501    
502      TransactFeatures [options] command transactionDirectory IDfile      TransactFeatures [options] command transactionDirectory IDfile
503          -trace    tracing level (default 2)          -trace    tracing level (default E)
504          -sql      trace SQL commands          -sql      trace SQL commands
505          -safe     use database transactions          -safe     use database transactions
506          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
# Line 355  Line 515 
515      { trace => [0, "tracing level (default 0)"],      { trace => [0, "tracing level (default 0)"],
516         ...         ...
517    
518  would set the default trace level to 0 instead of 2, while  would set the default trace level to 0 instead of E, while
519    
520      { trace => ["2-", "tracing level (default 2)"],      { trace => ["2-", "tracing level (default 2)"],
521         ...         ...
522    
523  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
524  standard output.  standard output.
525    
526  The parameters to this method are as follows.  The parameters to this method are as follows.
# Line 407  Line 567 
567  sub StandardSetup {  sub StandardSetup {
568      # Get the parameters.      # Get the parameters.
569      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
570        # Get the default tracing key.
571        my $tkey = EmergencyKey();
572      # Add the tracing options.      # Add the tracing options.
573      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
574          $options->{trace} = [2, "tracing level"];          $options->{trace} = ['E', "tracing level (E for emergency tracing)"];
575      }      }
576      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
577      $options->{h} = [0, "display command-line options"];      $options->{h} = [0, "display command-line options"];
578      $options->{user} = [$$, "trace log file name suffix"];      $options->{user} = [$tkey, "tracing key"];
579      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
580      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
581      # contains the default values rather than the default value      # contains the default values rather than the default value
# Line 438  Line 600 
600          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
601          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
602      }      }
603      # 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
604      # be traced.      # wants emergency tracing.
605        if ($retOptions->{trace} eq 'E') {
606            ETracing($retOptions->{user});
607        } else {
608            # Here the tracing is controlled from the command line.
609      my @cats = @{$categories};      my @cats = @{$categories};
610      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
611          push @cats, "SQL";          push @cats, "SQL";
612      }      }
613      # Add the default categories.      # Add the default categories.
614      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
615      # Next, we create the category string by joining the categories.      # Next, we create the category string by joining the categories.
616      my $cats = join(" ", @cats);      my $cats = join(" ", @cats);
617      # 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 480  Line 646 
646      }      }
647      # Now set up the tracing.      # Now set up the tracing.
648      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
649        }
650      # 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
651      # options and exit the program.      # options and exit the program.
652      if ($retOptions->{h}) {      if ($retOptions->{h}) {
653          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
654          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
655          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
656              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
657              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
658              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
659                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
660              }              }
661              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
662          }          }
663          exit(0);          exit(0);
664      }      }
# Line 765  Line 932 
932      return $value;      return $value;
933  }  }
934    
935    =head3 ParseTraceDate
936    
937    C<< my $time = Tracer::ParseTraceDate($dateString); >>
938    
939    Convert a date from the trace file into a PERL timestamp.
940    
941    =over 4
942    
943    =item dateString
944    
945    The date string from the trace file. The format of the string is determined by the
946    L</Now> method.
947    
948    =item RETURN
949    
950    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
951    the time string is invalid.
952    
953    =back
954    
955    =cut
956    
957    sub ParseTraceDate {
958        # Get the parameters.
959        my ($dateString) = @_;
960        # Declare the return variable.
961        my $retVal;
962        # Parse the date.
963        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
964            # Create a time object. Note we need to convert the day, month,
965            # and year to a different base. Years count from 1900, and
966            # the internal month value is relocated to January = 0.
967            $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);
968        }
969        # Return the result.
970        return $retVal;
971    }
972    
973  =head3 LogErrors  =head3 LogErrors
974    
975  C<< Tracer::LogErrors($fileName); >>  C<< Tracer::LogErrors($fileName); >>
# Line 967  Line 1172 
1172      # Get the timestamp.      # Get the timestamp.
1173      my $timeStamp = Now();      my $timeStamp = Now();
1174      # 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.
1175      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);
1176      # Process according to the destination.      # Process according to the destination.
1177      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1178          # Write the message to the standard output.          # Write the message to the standard output.
# Line 1432  Line 1637 
1637      # Close it.      # Close it.
1638      close $handle;      close $handle;
1639      my $actualLines = @retVal;      my $actualLines = @retVal;
1640        Trace("$actualLines lines read from file $fileName.") if T(File => 2);
1641      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
1642      if (wantarray) {      if (wantarray) {
1643          return @retVal;          return @retVal;
# Line 1455  Line 1661 
1661  =item lines  =item lines
1662    
1663  Reference to a list of text lines. The lines will be written to the file in order, with trailing  Reference to a list of text lines. The lines will be written to the file in order, with trailing
1664  new-line characters.  new-line characters. Alternatively, may be a string, in which case the string will be written without
1665    modification.
1666    
1667  =back  =back
1668    
# Line 1466  Line 1673 
1673      my ($fileName, $lines) = @_;      my ($fileName, $lines) = @_;
1674      # Open the output file.      # Open the output file.
1675      my $handle = Open(undef, ">$fileName");      my $handle = Open(undef, ">$fileName");
1676      # Write the lines.      # Count the lines written.
1677        if (ref $lines ne 'ARRAY') {
1678            # Here we have a scalar, so we write it raw.
1679            print $handle $lines;
1680            Trace("Scalar put to file $fileName.") if T(File => 3);
1681        } else {
1682            # Write the lines one at a time.
1683            my $count = 0;
1684      for my $line (@{$lines}) {      for my $line (@{$lines}) {
1685          print $handle "$line\n";          print $handle "$line\n";
1686                $count++;
1687            }
1688            Trace("$count lines put to file $fileName.") if T(File => 3);
1689      }      }
1690      # Close the output file.      # Close the output file.
1691      close $handle;      close $handle;
# Line 1712  Line 1929 
1929    
1930  C<< if (Tracer::DebugMode) { ...code... } >>  C<< if (Tracer::DebugMode) { ...code... } >>
1931    
1932  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.  
1933    
1934  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1935  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1936  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1937  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1938  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.  
1939    
1940  =cut  =cut
1941    
# Line 1733  Line 1948 
1948      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1949          $retVal = 1;          $retVal = 1;
1950      } else {      } else {
1951          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1952          my $pageString = PageBuilder::Build("<<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1953      }      }
1954      # Return the determination indicator.      # Return the determination indicator.
1955      return $retVal;      return $retVal;
# Line 1887  Line 2101 
2101    
2102  =head3 ScriptSetup  =head3 ScriptSetup
2103    
2104  C<< my ($query, $varHash) = ScriptSetup(); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2105    
2106  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2107  the CGI object followed by a pre-built variable hash.  the CGI object followed by a pre-built variable hash.
2108    
2109  The C<Trace> query parameter is used to determine whether or not tracing is active and  The C<Trace> form parameter is used to determine whether or not tracing is active and
2110  which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  which trace modules (other than C<Tracer> itself) should be turned on. Specifying
2111  the C<CGI> trace module will trace parameter and environment information. Parameters are  the C<CGI> trace module will trace parameter and environment information. Parameters are
2112  traced at level 3 and environment variables at level 4. At the end of the script, the  traced at level 3 and environment variables at level 4. To trace to a file instead of to
2113  client should call L</ScriptFinish> to output the web page.  the web page, set C<TF> to 1. At the end of the script, the client should call
2114    L</ScriptFinish> to output the web page.
2115    
2116    In some situations, it is not practical to invoke tracing via form parameters. For this
2117    situation, you can turn on emergency tracing from the debugging control panel.
2118    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2119    method, which includes every program that uses this method or L</StandardSetup>.
2120    
2121    =over 4
2122    
2123    =item noTrace (optional)
2124    
2125    If specified, tracing will be suppressed. This is useful if the script wants to set up
2126    tracing manually.
2127    
2128    =item RETURN
2129    
2130    Returns a two-element list consisting of a CGI query object and a variable hash for
2131    the output page.
2132    
2133    =back
2134    
2135  =cut  =cut
2136    
2137  sub ScriptSetup {  sub ScriptSetup {
2138        # Get the parameters.
2139        my ($noTrace) = @_;
2140      # Get the CGI query object.      # Get the CGI query object.
2141      my $query = CGI->new();      my $cgi = CGI->new();
2142      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2143      if ($query->param('Trace')) {      ETracing($cgi) unless $noTrace;
2144          # Set up tracing to be queued for display at the bottom of the web page.      # Create the variable hash.
2145          TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");      my $varHash = { results => '' };
2146          # Trace the parameter and environment data.      # Return the query object and variable hash.
2147        return ($cgi, $varHash);
2148    }
2149    
2150    =head3 ETracing
2151    
2152    C<< ETracing($parameter); >>
2153    
2154    Set up emergency tracing. Emergency tracing is tracing that is turned
2155    on automatically for any program that calls this method. The emergency
2156    tracing parameters are stored in a a file identified by a tracing key.
2157    If this method is called with a CGI object, then the tracing key is
2158    taken from a cookie. If it is called with no parameters, then the tracing
2159    key is taken from an environment variable. If it is called with a string,
2160    the tracing key is that string.
2161    
2162    =over 4
2163    
2164    =item parameter
2165    
2166    A parameter from which the tracing key is computed. If it is a scalar,
2167    that scalar is used as the tracing key. If it is a CGI object, the
2168    tracing key is taken from the C<IP> cookie. If it is omitted, the
2169    tracing key is taken from the C<TRACING> environment variable. If it
2170    is a CGI object and emergency tracing is not on, the C<Trace> and
2171    C<TF> parameters will be used to determine the type of tracing.
2172    
2173    =back
2174    
2175    =cut
2176    
2177    sub ETracing {
2178        # Get the parameter.
2179        my ($parameter) = @_;
2180        # Check for CGI mode.
2181        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2182        # Default to no tracing except errors.
2183        my ($tracing, $dest) = ("0", "WARN");
2184        # Check for emergency tracing.
2185        my $tkey = EmergencyKey($parameter);
2186        my $emergencyFile = EmergencyFileName($tkey);
2187        if (-e $emergencyFile) {
2188            # We have the file. Read in the data.
2189            my @tracing = GetFile($emergencyFile);
2190            # Pull off the time limit.
2191            my $expire = shift @tracing;
2192            # Convert it to seconds.
2193            $expire *= 3600;
2194            # Check the file data.
2195            my $stat = stat($emergencyFile);
2196            my ($now) = gettimeofday;
2197            if ($now - $stat->mtime > $expire) {
2198                # Delete the expired file.
2199                unlink $emergencyFile;
2200            } else {
2201                # Emergency tracing is on. Pull off the destination and
2202                # the trace level;
2203                $dest = shift @tracing;
2204                my $level = shift @tracing;
2205                # Convert the destination to a real tracing destination.
2206                # temp directory.
2207                $dest = EmergencyTracingDest($tkey, $dest);
2208                # Insure Tracer is specified.
2209                my %moduleHash = map { $_ => 1 } @tracing;
2210                $moduleHash{Tracer} = 1;
2211                # Set the trace parameter.
2212                $tracing = join(" ", $level, sort keys %moduleHash);
2213            }
2214        } elsif (defined $cgi) {
2215            # There's no emergency tracing, but we have a CGI object, so check
2216            # for tracing from the form parameters.
2217            if ($cgi->param('Trace')) {
2218                # Here the user has requested tracing via a form.
2219                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2220                $tracing = $cgi->param('Trace') . " Tracer";
2221            }
2222        }
2223        # Setup the tracing we've determined from all the stuff above.
2224        TSetup($tracing, $dest);
2225        # If we're a web script, trace the parameter and environment data.
2226        if (defined $cgi) {
2227            TraceParms($cgi);
2228        }
2229    }
2230    
2231    =head3 EmergencyFileName
2232    
2233    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2234    
2235    Return the emergency tracing file name. This is the file that specifies
2236    the tracing information.
2237    
2238    =over 4
2239    
2240    =item tkey
2241    
2242    Tracing key for the current program.
2243    
2244    =item RETURN
2245    
2246    Returns the name of the file to contain the emergency tracing information.
2247    
2248    =back
2249    
2250    =cut
2251    
2252    sub EmergencyFileName {
2253        # Get the parameters.
2254        my ($tkey) = @_;
2255        # Compute the emergency tracing file name.
2256        return "$FIG_Config::temp/Emergency$tkey.txt";
2257    }
2258    
2259    =head3 EmergencyFileTarget
2260    
2261    C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2262    
2263    Return the emergency tracing target file name. This is the file that receives
2264    the tracing output for file-based tracing.
2265    
2266    =over 4
2267    
2268    =item tkey
2269    
2270    Tracing key for the current program.
2271    
2272    =item RETURN
2273    
2274    Returns the name of the file to contain the trace output.
2275    
2276    =back
2277    
2278    =cut
2279    
2280    sub EmergencyFileTarget {
2281        # Get the parameters.
2282        my ($tkey) = @_;
2283        # Compute the emergency tracing file name.
2284        return "$FIG_Config::temp/trace$tkey.log";
2285    }
2286    
2287    =head3 EmergencyTracingDest
2288    
2289    C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2290    
2291    This method converts an emergency tracing destination to a real
2292    tracing destination. The main difference is that if the
2293    destination is C<FILE> or C<APPEND>, we convert it to file
2294    output.
2295    
2296    =over 4
2297    
2298    =item tkey
2299    
2300    Tracing key for this environment.
2301    
2302    =item myDest
2303    
2304    Destination from the emergency tracing file.
2305    
2306    =item RETURN
2307    
2308    Returns a destination that can be passed into L</TSetup>.
2309    
2310    =back
2311    
2312    =cut
2313    
2314    sub EmergencyTracingDest {
2315        # Get the parameters.
2316        my ($tkey, $myDest) = @_;
2317        # Declare the return variable.
2318        my $retVal;
2319        # Process according to the destination value.
2320        if ($myDest eq 'FILE') {
2321            $retVal = ">" . EmergencyFileTarget($tkey);
2322        } elsif ($myDest eq 'APPEND') {
2323            $retVal = ">>" . EmergencyFileTarget($tkey);
2324        } else {
2325            $retVal = $myDest;
2326        }
2327        # Return the result.
2328        return $retVal;
2329    }
2330    
2331    =head3 Emergency
2332    
2333    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2334    
2335    Turn on emergency tracing. This method can only be invoked over the web and is
2336    should not be called if debug mode is off. The caller specifies the duration of the
2337    emergency in hours, the desired tracing destination, the trace level,
2338    and a list of the trace modules to activate. For the length of the duration, when a
2339    program in an environment with the specified tracing key active invokes a Sprout
2340    CGI script, tracing will be turned on automatically. See L</TSetup> for more
2341    about tracing setup and L</ETracing> for more about emergency tracing.
2342    
2343    =over 4
2344    
2345    =item tkey
2346    
2347    The tracing key. This is used to identify the control file and the trace file.
2348    
2349    =item hours
2350    
2351    Number of hours to keep emergency tracing alive.
2352    
2353    =item dest
2354    
2355    Tracing destination. If no path information is specified for a file
2356    destination, it is put in the FIG temporary directory.
2357    
2358    =item level
2359    
2360    Tracing level. A higher level means more trace messages.
2361    
2362    =item modules
2363    
2364    A list of the tracing modules to activate.
2365    
2366    =back
2367    
2368    =cut
2369    
2370    sub Emergency {
2371        # Get the parameters.
2372        my ($tkey, $hours, $dest, $level, @modules) = @_;
2373        # Create the emergency file.
2374        my $specFile = EmergencyFileName($tkey);
2375        my $outHandle = Open(undef, ">$specFile");
2376        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2377    }
2378    
2379    =head3 EmergencyKey
2380    
2381    C<< my $tkey = EmergencyKey($parameter); >>
2382    
2383    Return the Key to be used for emergency tracing. This could be an IP address,
2384     a session ID, or a user name, depending on the environment.
2385    
2386    =over 4
2387    
2388    =item parameter
2389    
2390    Parameter defining the method for finding the tracing key. If it is a scalar,
2391    then it is presumed to be the tracing key itself. If it is a CGI object, then
2392    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2393    taken from the C<TRACING> environment variable.
2394    
2395    =item RETURN
2396    
2397    Returns the key to be used for labels in emergency tracing.
2398    
2399    =back
2400    
2401    =cut
2402    
2403    sub EmergencyKey {
2404        # Get the parameters.
2405        my ($parameter) = @_;
2406        # Declare the return variable.
2407        my $retVal;
2408        # Determine the parameter type.
2409        if (! defined $parameter) {
2410            # Here we're supposed to check the environment.
2411            $retVal = $ENV{TRACING};
2412        } else {
2413            my $ptype = ref $parameter;
2414            if ($ptype eq 'CGI') {
2415                # Here we were invoked from a web page. Look for a cookie.
2416                $retVal = $parameter->cookie('IP');
2417            } elsif (! $ptype) {
2418                # Here the key was passed in.
2419                $retVal = $parameter;
2420            }
2421        }
2422        # If no luck finding a key, use the PID.
2423        if (! defined $retVal) {
2424            $retVal = $$;
2425        }
2426        # Return the result.
2427        return $retVal;
2428    }
2429    
2430    
2431    =head3 TraceParms
2432    
2433    C<< Tracer::TraceParms($cgi); >>
2434    
2435    Trace the CGI parameters at trace level CGI => 3 and the environment variables
2436    at level CGI => 4.
2437    
2438    =over 4
2439    
2440    =item cgi
2441    
2442    CGI query object containing the parameters to trace.
2443    
2444    =back
2445    
2446    =cut
2447    
2448    sub TraceParms {
2449        # Get the parameters.
2450        my ($cgi) = @_;
2451          if (T(CGI => 3)) {          if (T(CGI => 3)) {
2452              # Here we want to trace the parameter data.              # Here we want to trace the parameter data.
2453              my @names = $query->param;          my @names = $cgi->param;
2454              for my $parmName (sort @names) {              for my $parmName (sort @names) {
2455                  # Note we skip "Trace", which is for our use only.              # Note we skip the Trace parameters, which are for our use only.
2456                  if ($parmName ne 'Trace') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
2457                      my @values = $query->param($parmName);                  my @values = $cgi->param($parmName);
2458                      Trace("CGI: $parmName = " . join(", ", @values));                      Trace("CGI: $parmName = " . join(", ", @values));
2459                  }                  }
2460              }              }
2461            # Display the request method.
2462            my $method = $cgi->request_method();
2463            Trace("Method: $method");
2464          }          }
2465          if (T(CGI => 4)) {          if (T(CGI => 4)) {
2466              # Here we want the environment data too.              # Here we want the environment data too.
# Line 1925  Line 2468 
2468                  Trace("ENV: $envName = $ENV{$envName}");                  Trace("ENV: $envName = $ENV{$envName}");
2469              }              }
2470          }          }
     } else {  
         # Here tracing is to be turned off. All we allow is errors traced into the  
         # error log.  
         TSetup("0", "WARN");  
     }  
     # Create the variable hash.  
     my $varHash = { DebugData => '' };  
     # If we're in DEBUG mode, set up the debug mode data for forms.  
     if (Tracer::DebugMode) {  
         $varHash->{DebugData} = GetFile("Html/DebugFragment.html");  
     }  
     # Return the query object and variable hash.  
     return ($query, $varHash);  
2471  }  }
2472    
2473  =head3 ScriptFinish  =head3 ScriptFinish
# Line 1964  Line 2494 
2494      use FIG;      use FIG;
2495      # ... more uses ...      # ... more uses ...
2496    
2497      my ($query, $varHash) = ScriptSetup();      my ($cgi, $varHash) = ScriptSetup();
2498      eval {      eval {
2499          # ... get data from $query, put it in $varHash ...          # ... get data from $cgi, put it in $varHash ...
2500      };      };
2501      if ($@) {      if ($@) {
2502          Trace("Script Error: $@") if T(0);          Trace("Script Error: $@") if T(0);
# Line 2001  Line 2531 
2531      # Check for a template file situation.      # Check for a template file situation.
2532      my $outputString;      my $outputString;
2533      if (defined $varHash) {      if (defined $varHash) {
2534          # Here we have a template file. We need to apply the variables to the template.          # Here we have a template file. We need to determine the template type.
2535          $outputString = PageBuilder::Build("<<$webData", $varHash, "Html");          my $template;
2536            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
2537                $template = "$FIG_Config::template_url/$webData";
2538            } else {
2539                $template = "<<$webData";
2540            }
2541            $outputString = PageBuilder::Build($template, $varHash, "Html");
2542      } else {      } else {
2543          # Here the user gave us a raw string.          # Here the user gave us a raw string.
2544          $outputString = $webData;          $outputString = $webData;
2545      }      }
2546      # Check for trace messages.      # Check for trace messages.
2547      if ($Destination eq "QUEUE") {      if ($Destination ne "NONE" && $TraceLevel > 0) {
2548          # We have trace messages, so we want to put them at the end of the body. This          # We have trace messages, so we want to put them at the end of the body. This
2549          # is either at the end of the whole string or at the beginning of the BODY          # is either at the end of the whole string or at the beginning of the BODY
2550          # end-tag.          # end-tag.
# Line 2016  Line 2552 
2552          if ($outputString =~ m#</body>#gi) {          if ($outputString =~ m#</body>#gi) {
2553              $pos = (pos $outputString) - 7;              $pos = (pos $outputString) - 7;
2554          }          }
2555          substr $outputString, $pos, 0, QTrace('Html');          # If the trace messages were queued, we unroll them. Otherwise, we display the
2556            # destination.
2557            my $traceHtml;
2558            if ($Destination eq "QUEUE") {
2559                $traceHtml = QTrace('Html');
2560            } elsif ($Destination =~ /^>>(.+)$/) {
2561                # Here the tracing output it to a file. We code it as a hyperlink so the user
2562                # can copy the file name into the clipboard easily.
2563                my $actualDest = $1;
2564                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2565            } else {
2566                # Here we have one of the special destinations.
2567                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2568            }
2569            substr $outputString, $pos, 0, $traceHtml;
2570      }      }
2571      # Write the output string.      # Write the output string.
2572      print $outputString;      print $outputString;
# Line 2041  Line 2591 
2591  sub Insure {  sub Insure {
2592      my ($dirName) = @_;      my ($dirName) = @_;
2593      if (! -d $dirName) {      if (! -d $dirName) {
2594          Trace("Creating $dirName directory.") if T(2);          Trace("Creating $dirName directory.") if T(File => 2);
2595          eval { mkpath $dirName; };          eval { mkpath $dirName; };
2596          if ($@) {          if ($@) {
2597              Confess("Error creating $dirName: $@");              Confess("Error creating $dirName: $@");
# Line 2070  Line 2620 
2620      if (! -d $dirName) {      if (! -d $dirName) {
2621          Confess("Cannot change to directory $dirName: no such directory.");          Confess("Cannot change to directory $dirName: no such directory.");
2622      } else {      } else {
2623          Trace("Changing to directory $dirName.") if T(4);          Trace("Changing to directory $dirName.") if T(File => 4);
2624          my $okFlag = chdir $dirName;          my $okFlag = chdir $dirName;
2625          if (! $okFlag) {          if (! $okFlag) {
2626              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
# Line 2249  Line 2799 
2799          my $gid = getgrnam($group);          my $gid = getgrnam($group);
2800          # Get the mask for tracing.          # Get the mask for tracing.
2801          my $traceMask = sprintf("%04o", $mask) . "($mask)";          my $traceMask = sprintf("%04o", $mask) . "($mask)";
2802          Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(2);          Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2803          my $fixCount = 0;          my $fixCount = 0;
2804          my $lookCount = 0;          my $lookCount = 0;
2805          # @dirs will be a stack of directories to be processed.          # @dirs will be a stack of directories to be processed.
# Line 2264  Line 2814 
2814              if ($dir =~ m!/([^/]+)$!) {              if ($dir =~ m!/([^/]+)$!) {
2815                  $simpleName = $1;                  $simpleName = $1;
2816              }              }
2817              Trace("Simple directory name for $dir is $simpleName.") if T(4);              Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2818              # Search for a match.              # Search for a match.
2819              my $match = 0;              my $match = 0;
2820              my $i;              my $i;
# Line 2289  Line 2839 
2839                      Trace("Checking member $thisMem.") if T(4);                      Trace("Checking member $thisMem.") if T(4);
2840                      $lookCount++;                      $lookCount++;
2841                      if ($lookCount % 1000 == 0) {                      if ($lookCount % 1000 == 0) {
2842                          Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(3);                          Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2843                      }                      }
2844                      # Fix the group.                      # Fix the group.
2845                      chown -1, $gid, $thisMem;                      chown -1, $gid, $thisMem;
# Line 2316  Line 2866 
2866                  }                  }
2867              }              }
2868          }          }
2869          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2870      };      };
2871      # Check for an error.      # Check for an error.
2872      if ($@) {      if ($@) {
# Line 2373  Line 2923 
2923          # of the lists is past the end, we'll get undef.          # of the lists is past the end, we'll get undef.
2924          my $newItem = $newList->[$newI];          my $newItem = $newList->[$newI];
2925          my $oldItem = $oldList->[$oldI];          my $oldItem = $oldList->[$oldI];
2926          if (! defined($newItem) || $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {          if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
2927              # The old item is not in the new list, so mark it deleted.              # The old item is not in the new list, so mark it deleted.
2928              push @{$deleted}, $oldItem;              push @{$deleted}, $oldItem;
2929              $oldI++;              $oldI++;
# Line 2391  Line 2941 
2941      return ($inserted, $deleted);      return ($inserted, $deleted);
2942  }  }
2943    
2944    =head3 GetLine
2945    
2946    C<< my @data = Tracer::GetLine($handle); >>
2947    
2948    Read a line of data from a tab-delimited file.
2949    
2950    =over 4
2951    
2952    =item handle
2953    
2954    Open file handle from which to read.
2955    
2956    =item RETURN
2957    
2958    Returns a list of the fields in the record read. The fields are presumed to be
2959    tab-delimited. If we are at the end of the file, then an empty list will be
2960    returned. If an empty line is read, a single list item consisting of a null
2961    string will be returned.
2962    
2963    =back
2964    
2965    =cut
2966    
2967    sub GetLine {
2968        # Get the parameters.
2969        my ($handle) = @_;
2970        # Declare the return variable.
2971        my @retVal = ();
2972        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2973        # Read from the file.
2974        my $line = <$handle>;
2975        # Only proceed if we found something.
2976        if (defined $line) {
2977            # Remove the new-line.
2978            chomp $line;
2979            Trace("Line read: $line") if T(File => 4);
2980            # If the line is empty, return a single empty string; otherwise, parse
2981            # it into fields.
2982            if ($line eq "") {
2983                push @retVal, "";
2984            } else {
2985                push @retVal, split /\t/,$line;
2986            }
2987        } else {
2988            # Trace the reason the read failed.
2989            Trace("End of file: $!") if T(File => 3);
2990        }
2991        # Return the result.
2992        return @retVal;
2993    }
2994    
2995    =head3 PutLine
2996    
2997    C<< Tracer::PutLine($handle, \@fields); >>
2998    
2999    Write a line of data to a tab-delimited file. The specified field values will be
3000    output in tab-separated form, with a trailing new-line.
3001    
3002    =over 4
3003    
3004    =item handle
3005    
3006    Output file handle.
3007    
3008    =item fields
3009    
3010    List of field values.
3011    
3012    =back
3013    
3014    =cut
3015    
3016    sub PutLine {
3017        # Get the parameters.
3018        my ($handle, $fields) = @_;
3019        # Write the data.
3020        print $handle join("\t", @{$fields}) . "\n";
3021    }
3022    
3023    =head3 GenerateURL
3024    
3025    C<< my $queryUrl = Tracer::GenerateURL($page, %parameters); >>
3026    
3027    Generate a GET-style URL for the specified page with the specified parameter
3028    names and values. The values will be URL-escaped automatically. So, for
3029    example
3030    
3031        Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3032    
3033    would return
3034    
3035        form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3036    
3037    =over 4
3038    
3039    =item page
3040    
3041    Page URL.
3042    
3043    =item parameters
3044    
3045    Hash mapping parameter names to parameter values.
3046    
3047    =item RETURN
3048    
3049    Returns a GET-style URL that goes to the specified page and passes in the
3050    specified parameters and values.
3051    
3052    =back
3053    
3054    =cut
3055    
3056    sub GenerateURL {
3057        # Get the parameters.
3058        my ($page, %parameters) = @_;
3059        # Prime the return variable with the page URL.
3060        my $retVal = $page;
3061        # Loop through the parameters, creating parameter elements in a list.
3062        my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3063        # If the list is nonempty, tack it on.
3064        if (@parmList) {
3065            $retVal .= "?" . join(";", @parmList);
3066        }
3067        # Return the result.
3068        return $retVal;
3069    }
3070    
3071    =head3 ApplyURL
3072    
3073    C<< Tracer::ApplyURL($table, $target, $url); >>
3074    
3075    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3076    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3077    URL column will be deleted by this process and the target column will be HTML-escaped.
3078    
3079    This provides a simple way to process the results of a database query into something
3080    displayable by combining a URL with text.
3081    
3082    =over 4
3083    
3084    =item table
3085    
3086    Reference to a list of lists. The elements in the containing list will be updated by
3087    this method.
3088    
3089    =item target
3090    
3091    The index of the column to be converted into HTML.
3092    
3093    =item url
3094    
3095    The index of the column containing the URL. Note that the URL must have a recognizable
3096    C<http:> at the beginning.
3097    
3098    =back
3099    
3100    =cut
3101    
3102    sub ApplyURL {
3103        # Get the parameters.
3104        my ($table, $target, $url) = @_;
3105        # Loop through the table.
3106        for my $row (@{$table}) {
3107            # Apply the URL to the target cell.
3108            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3109            # Delete the URL from the row.
3110            delete $row->[$url];
3111        }
3112    }
3113    
3114    =head3 CombineURL
3115    
3116    C<< my $combinedHtml = Tracer::CombineURL($text, $url); >>
3117    
3118    This method will convert the specified text into HTML hyperlinked to the specified
3119    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3120    is defined and begins with an C<http:> header.
3121    
3122    =over 4
3123    
3124    =item text
3125    
3126    Text to return. This will be HTML-escaped automatically.
3127    
3128    =item url
3129    
3130    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3131    will be returned without any hyperlinking.
3132    
3133    =item RETURN
3134    
3135    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3136    doesn't look right, the HTML-escaped text will be returned without any further
3137    modification.
3138    
3139    =back
3140    
3141    =cut
3142    
3143    sub CombineURL {
3144        # Get the parameters.
3145        my ($text, $url) = @_;
3146        # Declare the return variable.
3147        my $retVal = CGI::escapeHTML($text);
3148        # Verify the URL.
3149        if (defined($url) && $url =~ m!http://!i) {
3150            # It's good, so we apply it to the text.
3151            $retVal = "<a href=\"$url\">$retVal</a>";
3152        }
3153        # Return the result.
3154        return $retVal;
3155    }
3156    
3157  1;  1;

Legend:
Removed from v.1.62  
changed lines
  Added in v.1.79

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3