[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.69, Mon Oct 2 02:59:47 2006 UTC revision 1.89, Tue Jun 19 21:15:37 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 EmergencyIP ScriptSetup ScriptFinish Insure ChDir Emergency);      @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 34  Line 34 
34      use LWP::UserAgent;      use LWP::UserAgent;
35      use Time::HiRes 'gettimeofday';      use Time::HiRes 'gettimeofday';
36      use URI::Escape;      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 61  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    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 tracing, you call the L</TSetup> method. The method takes as input a trace level, a list  To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
80  of category names, and a set of options. The trace level and list of category names are  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 122  Line 146 
146  =back  =back
147    
148  The format of trace messages is important because some utilities analyze trace files.  The format of trace messages is important because some utilities analyze trace files.
149  The time stamp is between square brackets, the module name between angle brackets,  There are three fields-- the time stamp, the category name, and the text.
150  a colon (C<:>), and the message text after that. If the square brackets or angle  The time stamp is between square brackets and the category name between angle brackets.
151  brackets are missing, then the trace management utilities assume that they  After the category name there is a colon (C<:>) followed by the message text.
152  are encountering a set of pre-formatted lines.  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    
# Line 295  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 307  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
# Line 335  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 359  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 411  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 442  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";
# Line 484  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          print "$1 [options] $parmHelp\n";          print "$1 [options] $parmHelp\n";
663          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
# Line 499  Line 670 
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 769  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 1050  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 1080  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 1094  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 1119  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 1436  Line 1651 
1651      # Close it.      # Close it.
1652      close $handle;      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 1471  Line 1687 
1687      my ($fileName, $lines) = @_;      my ($fileName, $lines) = @_;
1688      # Open the output file.      # Open the output file.
1689      my $handle = Open(undef, ">$fileName");      my $handle = Open(undef, ">$fileName");
1690        # Count the lines written.
1691      if (ref $lines ne 'ARRAY') {      if (ref $lines ne 'ARRAY') {
1692          # Here we have a scalar, so we write it raw.          # Here we have a scalar, so we write it raw.
1693          print $handle $lines;          print $handle $lines;
1694            Trace("Scalar put to file $fileName.") if T(File => 3);
1695      } else {      } else {
1696          # Write the lines one at a time.          # Write the lines one at a time.
1697            my $count = 0;
1698          for my $line (@{$lines}) {          for my $line (@{$lines}) {
1699              print $handle "$line\n";              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.      # Close the output file.
1705      close $handle;      close $handle;
# Line 1552  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            my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch";
1779            # Only proceed if the tool header file is actually present.
1780            if (-f $toolHeaderFile) {
1781                my @lines = GetFile($toolHeaderFile);
1782                Trace("Tool header has " . scalar(@lines) . " lines.");
1783            }
1784        }
1785      # Trace the call stack.      # Trace the call stack.
1786      Cluck($message);      Cluck($message);
1787      # Abort the program.      # Abort the program.
# Line 1897  Line 2127 
2127  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2128    
2129  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2130  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,
2131    the client should call L</ScriptFinish> to output the web page.
2132    
2133  The C<Trace> query parameter is used to determine whether or not tracing is active and  This method calls L</ETracing> to configure tracing, which allows the tracing
2134  which trace modules (other than C<Tracer> itself) should be turned on. Specifying  to be configured via the emergency tracing form on the debugging control panel.
2135  the C<CGI> trace module will trace parameter and environment information. Parameters are  Tracing will then be turned on automatically for all programs that use the L</ETracing>
2136  traced at level 3 and environment variables at level 4. To trace to a file instead of to  method, which includes every program that uses this method or L</StandardSetup>.
 the web page, set C<TF> to 1. At the end of the script, the client should call  
 L</ScriptFinish> to output the web page.  
   
 In some situations, it is not practical to invoke tracing via form parameters. For this  
 situation, you can turn on emergency tracing by invoking the L</Emergency> method from  
 a web page. Emergency tracing is detected via a file with the name  
 C<Emergency>I<IPaddr>C<.txt> in the FIG temporary directory, where I<IPaddr> is the  
 IP address of the remote user who wants tracing turned on. The file contains a time  
 limit in hours on the first line, a tracing destination on the second line, a trace  
 level on the third line, and the tracing modules on subsequent lines.  
2137    
2138  =over 4  =over 4
2139    
# Line 1936  Line 2157 
2157      # Get the CGI query object.      # Get the CGI query object.
2158      my $cgi = CGI->new();      my $cgi = CGI->new();
2159      # Set up tracing if it's not suppressed.      # Set up tracing if it's not suppressed.
2160      CGITrace($cgi) unless $noTrace;      ETracing($cgi) unless $noTrace;
2161      # Create the variable hash.      # Create the variable hash.
2162      my $varHash = { results => '' };      my $varHash = { results => '' };
2163      # Return the query object and variable hash.      # Return the query object and variable hash.
2164      return ($cgi, $varHash);      return ($cgi, $varHash);
2165  }  }
2166    
2167  =head3 CGITrace  =head3 ETracing
2168    
2169  C<< Tracer::CGITrace($cgi); >>  C<< ETracing($parameter); >>
2170    
2171  Set up tracing for a CGI script. See L</ScriptSetup> for more information.  Set up emergency tracing. Emergency tracing is tracing that is turned
2172    on automatically for any program that calls this method. The emergency
2173    tracing parameters are stored in a a file identified by a tracing key.
2174    If this method is called with a CGI object, then the tracing key is
2175    taken from a cookie. If it is called with no parameters, then the tracing
2176    key is taken from an environment variable. If it is called with a string,
2177    the tracing key is that string.
2178    
2179  =over 4  =over 4
2180    
2181  =item cgi  =item parameter
2182    
2183  Ths CGI query object for this script.  A parameter from which the tracing key is computed. If it is a scalar,
2184    that scalar is used as the tracing key. If it is a CGI object, the
2185    tracing key is taken from the C<IP> cookie. If it is omitted, the
2186    tracing key is taken from the C<TRACING> environment variable. If it
2187    is a CGI object and emergency tracing is not on, the C<Trace> and
2188    C<TF> parameters will be used to determine the type of tracing.
2189    
2190  =back  =back
2191    
2192  =cut  =cut
2193    
2194  sub CGITrace {  sub ETracing {
2195      # Get the parameters.      # Get the parameter.
2196      my ($cgi) = @_;      my ($parameter) = @_;
2197        # Check for CGI mode.
2198        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2199      # Default to no tracing except errors.      # Default to no tracing except errors.
2200      my ($tracing, $dest) = ("0", "WARN");      my ($tracing, $dest) = ("0", "WARN");
2201      # Check for emergency tracing.      # Check for emergency tracing.
2202      my $ip = EmergencyIP($cgi);      my $tkey = EmergencyKey($parameter);
2203      my $emergencyFile = EmergencyFileName($ip);      my $emergencyFile = EmergencyFileName($tkey);
2204      if (-e $emergencyFile) {      if (-e $emergencyFile) {
2205          # We have the file. Read in the data.          # We have the file. Read in the data.
2206          my @tracing = GetFile($emergencyFile);          my @tracing = GetFile($emergencyFile);
# Line 1987  Line 2221 
2221              my $level = shift @tracing;              my $level = shift @tracing;
2222              # Convert the destination to a real tracing destination.              # Convert the destination to a real tracing destination.
2223              # temp directory.              # temp directory.
2224              $dest = EmergencyTracingDest($ip, $dest);              $dest = EmergencyTracingDest($tkey, $dest);
2225              # Insure Tracer is specified.              # Insure Tracer is specified.
2226              my %moduleHash = map { $_ => 1 } @tracing;              my %moduleHash = map { $_ => 1 } @tracing;
2227              $moduleHash{Tracer} = 1;              $moduleHash{Tracer} = 1;
2228              # Set the trace parameter.              # Set the trace parameter.
2229              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
             # Make sure the script knows tracing is on.  
             $cgi->param(-name => 'Trace', -value => $tracing);  
             $cgi->param(-name => 'TF', -value => (($dest =~ /^>/) ? 1 : 0));  
2230          }          }
2231      } elsif ($cgi->param('Trace')) {      } elsif (defined $cgi) {
2232            # There's no emergency tracing, but we have a CGI object, so check
2233            # for tracing from the form parameters.
2234            if ($cgi->param('Trace')) {
2235          # Here the user has requested tracing via a form.          # Here the user has requested tracing via a form.
2236          $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");          $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2237          $tracing = $cgi->param('Trace') . " Tracer";          $tracing = $cgi->param('Trace') . " Tracer";
2238      }      }
2239        }
2240      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
2241      TSetup($tracing, $dest);      TSetup($tracing, $dest);
2242      # Trace the parameter and environment data.      # If we're a web script, trace the parameter and environment data.
2243        if (defined $cgi) {
2244      TraceParms($cgi);      TraceParms($cgi);
2245  }  }
2246    }
2247    
2248  =head3 EmergencyFileName  =head3 EmergencyFileName
2249    
2250  C<< my $fileName = Tracer::EmergencyFileName($ip); >>  C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2251    
2252  Return the emergency tracing file name. This is the file that specifies  Return the emergency tracing file name. This is the file that specifies
2253  the tracing information.  the tracing information.
2254    
2255  =over 4  =over 4
2256    
2257  =item ip  =item tkey
2258    
2259  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for the current program.
 method.  
2260    
2261  =item RETURN  =item RETURN
2262    
# Line 2032  Line 2268 
2268    
2269  sub EmergencyFileName {  sub EmergencyFileName {
2270      # Get the parameters.      # Get the parameters.
2271      my ($ip) = @_;      my ($tkey) = @_;
2272      # Compute the emergency tracing file name.      # Compute the emergency tracing file name.
2273      return "$FIG_Config::temp/Emergency$ip.txt";      return "$FIG_Config::temp/Emergency$tkey.txt";
2274  }  }
2275    
2276  =head3 EmergencyFileTarget  =head3 EmergencyFileTarget
2277    
2278  C<< my $fileName = Tracer::EmergencyFileTarget($ip); >>  C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2279    
2280  Return the emergency tracing target file name. This is the file that receives  Return the emergency tracing target file name. This is the file that receives
2281  the tracing output for file-based tracing.  the tracing output for file-based tracing.
2282    
2283  =over 4  =over 4
2284    
2285  =item ip  =item tkey
2286    
2287  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for the current program.
 method.  
2288    
2289  =item RETURN  =item RETURN
2290    
2291  Returns the name of the file to contain the emergency tracing information.  Returns the name of the file to contain the trace output.
2292    
2293  =back  =back
2294    
# Line 2061  Line 2296 
2296    
2297  sub EmergencyFileTarget {  sub EmergencyFileTarget {
2298      # Get the parameters.      # Get the parameters.
2299      my ($ip) = @_;      my ($tkey) = @_;
2300      # Compute the emergency tracing file name.      # Compute the emergency tracing file name.
2301      return "$FIG_Config::temp/Emergency$ip.log";      return "$FIG_Config::temp/trace$tkey.log";
2302  }  }
2303    
2304  =head3 EmergencyTracingDest  =head3 EmergencyTracingDest
2305    
2306  C<< my $dest = Tracer::EmergencyTracingDest($ip, $myDest); >>  C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2307    
2308  This method converts an emergency tracing destination to a real  This method converts an emergency tracing destination to a real
2309  tracing destination. The main difference is that if the  tracing destination. The main difference is that if the
2310  destination is C<FILE> or C<APPEND>, we convert it to file  destination is C<FILE> or C<APPEND>, we convert it to file
2311  output.  output. If the destination is C<DUAL>, we convert it to file
2312    and standard output.
2313    
2314  =over 4  =over 4
2315    
2316  =item ip  =item tkey
2317    
2318  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for this environment.
 method.  
2319    
2320  =item myDest  =item myDest
2321    
# Line 2096  Line 2331 
2331    
2332  sub EmergencyTracingDest {  sub EmergencyTracingDest {
2333      # Get the parameters.      # Get the parameters.
2334      my ($ip, $myDest) = @_;      my ($tkey, $myDest) = @_;
2335      # Declare the return variable.      # Declare the return variable.
2336      my $retVal;      my $retVal = $myDest;
2337      # Process according to the destination value.      # Process according to the destination value.
2338      if ($myDest eq 'FILE') {      if ($myDest eq 'FILE') {
2339          $retVal = ">" . EmergencyFileTarget($ip);          $retVal = ">" . EmergencyFileTarget($tkey);
2340      } elsif ($myDest eq 'APPEND') {      } elsif ($myDest eq 'APPEND') {
2341          $retVal = ">>" . EmergencyFileTarget($ip);          $retVal = ">>" . EmergencyFileTarget($tkey);
2342      } else {      } elsif ($myDest eq 'DUAL') {
2343          $retVal = $myDest;          $retVal = "+>" . EmergencyFileTarget($tkey);
2344      }      }
2345      # Return the result.      # Return the result.
2346      return $retVal;      return $retVal;
# Line 2113  Line 2348 
2348    
2349  =head3 Emergency  =head3 Emergency
2350    
2351  C<< Emergency($cgi, $hours, $dest, $level, @modules); >>  C<< Emergency($key, $hours, $dest, $level, @modules); >>
2352    
2353  Turn on emergency tracing. This method can only be invoked over the web and is  Turn on emergency tracing. This method is normally invoked over the web from
2354  should not be called if debug mode is off. The caller specifies the duration of the  a debugging console, but it can also be called by the C<trace.pl> script.
2355  emergency in hours, the desired tracing destination, the trace level,  The caller specifies the duration of the emergency in hours, the desired tracing
2356  and a list of the trace modules to activate. For the duration, when a user  destination, the trace level, and a list of the trace modules to activate.
2357  from the specified remote web location invokes a Sprout CGI script, tracing  For the length of the duration, when a program in an environment with the
2358  will be turned on automatically. See L</TSetup> for more about tracing  specified tracing key active invokes a Sprout CGI script, tracing will be
2359  setup and L</ScriptSetup> for more about emergency tracing.  turned on automatically. See L</TSetup> for more about tracing setup and
2360    L</ETracing> for more about emergency tracing.
2361    
2362  =over 4  =over 4
2363    
2364  =item cgi  =item tkey
2365    
2366  A CGI query object.  The tracing key. This is used to identify the control file and the trace file.
2367    
2368  =item hours  =item hours
2369    
# Line 2152  Line 2388 
2388    
2389  sub Emergency {  sub Emergency {
2390      # Get the parameters.      # Get the parameters.
2391      my ($cgi, $hours, $dest, $level, @modules) = @_;      my ($tkey, $hours, $dest, $level, @modules) = @_;
     # Get the IP address.  
     my $ip = EmergencyIP($cgi);  
2392      # Create the emergency file.      # Create the emergency file.
2393      my $specFile = EmergencyFileName($ip);      my $specFile = EmergencyFileName($tkey);
2394      my $outHandle = Open(undef, ">$specFile");      my $outHandle = Open(undef, ">$specFile");
2395      print $outHandle join("\n",$hours, $dest, $level, @modules, "");      print $outHandle join("\n",$hours, $dest, $level, @modules, "");
2396  }  }
2397    
2398  =head3 EmergencyIP  =head3 EmergencyKey
2399    
2400  C<< my $ip = EmergencyIP($cgi); >>  C<< my $tkey = EmergencyKey($parameter); >>
2401    
2402  Return the IP address to be used for emergency tracing. If at smoe point we need  Return the Key to be used for emergency tracing. This could be an IP address,
2403  to change the way we compute the IP address, or we decide to use something else,   a session ID, or a user name, depending on the environment.
 all we need to do is change this method.  
2404    
2405  =over 4  =over 4
2406    
2407  =item cgi  =item parameter
2408    
2409  CGI query object.  Parameter defining the method for finding the tracing key. If it is a scalar,
2410    then it is presumed to be the tracing key itself. If it is a CGI object, then
2411    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2412    taken from the C<TRACING> environment variable.
2413    
2414  =item RETURN  =item RETURN
2415    
2416  Returns the IP address to be used for labelling emergency tracing.  Returns the key to be used for labels in emergency tracing.
2417    
2418  =back  =back
2419    
2420  =cut  =cut
2421    
2422  sub EmergencyIP {  sub EmergencyKey {
2423      # Get the parameters.      # Get the parameters.
2424      my ($cgi) = @_;      my ($parameter) = @_;
2425        # Declare the return variable.
2426        my $retVal;
2427        # Determine the parameter type.
2428        if (! defined $parameter) {
2429            # Here we're supposed to check the environment.
2430            $retVal = $ENV{TRACING};
2431        } else {
2432            my $ptype = ref $parameter;
2433            if ($ptype eq 'CGI') {
2434                # Here we were invoked from a web page. Look for a cookie.
2435                $retVal = $parameter->cookie('IP');
2436            } elsif (! $ptype) {
2437                # Here the key was passed in.
2438                $retVal = $parameter;
2439            }
2440        }
2441        # If no luck finding a key, use the PID.
2442        if (! defined $retVal) {
2443            $retVal = $$;
2444        }
2445      # Return the result.      # Return the result.
2446      return $cgi->remote_addr();      return $retVal;
2447  }  }
2448    
2449    
# Line 2324  Line 2580 
2580              # Here the tracing output it to a file. We code it as a hyperlink so the user              # Here the tracing output it to a file. We code it as a hyperlink so the user
2581              # can copy the file name into the clipboard easily.              # can copy the file name into the clipboard easily.
2582              my $actualDest = $1;              my $actualDest = $1;
2583              $traceHtml = "<p>Tracing output to <a href=\"$actualDest\">$actualDest</a>.</p>\n";              $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2584          } else {          } else {
2585              # Here we have one of the special destinations.              # Here we have one of the special destinations.
2586              $traceHtml = "<P>Tracing output type is $Destination.</p>\n";              $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
# Line 2354  Line 2610 
2610  sub Insure {  sub Insure {
2611      my ($dirName) = @_;      my ($dirName) = @_;
2612      if (! -d $dirName) {      if (! -d $dirName) {
2613          Trace("Creating $dirName directory.") if T(2);          Trace("Creating $dirName directory.") if T(File => 2);
2614          eval { mkpath $dirName; };          eval { mkpath $dirName; };
2615          if ($@) {          if ($@) {
2616              Confess("Error creating $dirName: $@");              Confess("Error creating $dirName: $@");
# Line 2383  Line 2639 
2639      if (! -d $dirName) {      if (! -d $dirName) {
2640          Confess("Cannot change to directory $dirName: no such directory.");          Confess("Cannot change to directory $dirName: no such directory.");
2641      } else {      } else {
2642          Trace("Changing to directory $dirName.") if T(4);          Trace("Changing to directory $dirName.") if T(File => 4);
2643          my $okFlag = chdir $dirName;          my $okFlag = chdir $dirName;
2644          if (! $okFlag) {          if (! $okFlag) {
2645              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
# Line 2562  Line 2818 
2818          my $gid = getgrnam($group);          my $gid = getgrnam($group);
2819          # Get the mask for tracing.          # Get the mask for tracing.
2820          my $traceMask = sprintf("%04o", $mask) . "($mask)";          my $traceMask = sprintf("%04o", $mask) . "($mask)";
2821          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);
2822          my $fixCount = 0;          my $fixCount = 0;
2823          my $lookCount = 0;          my $lookCount = 0;
2824          # @dirs will be a stack of directories to be processed.          # @dirs will be a stack of directories to be processed.
# Line 2577  Line 2833 
2833              if ($dir =~ m!/([^/]+)$!) {              if ($dir =~ m!/([^/]+)$!) {
2834                  $simpleName = $1;                  $simpleName = $1;
2835              }              }
2836              Trace("Simple directory name for $dir is $simpleName.") if T(4);              Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2837              # Search for a match.              # Search for a match.
2838              my $match = 0;              my $match = 0;
2839              my $i;              my $i;
# Line 2602  Line 2858 
2858                      Trace("Checking member $thisMem.") if T(4);                      Trace("Checking member $thisMem.") if T(4);
2859                      $lookCount++;                      $lookCount++;
2860                      if ($lookCount % 1000 == 0) {                      if ($lookCount % 1000 == 0) {
2861                          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);
2862                      }                      }
2863                      # Fix the group.                      # Fix the group.
2864                      chown -1, $gid, $thisMem;                      chown -1, $gid, $thisMem;
# Line 2629  Line 2885 
2885                  }                  }
2886              }              }
2887          }          }
2888          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2889      };      };
2890      # Check for an error.      # Check for an error.
2891      if ($@) {      if ($@) {
# Line 2732  Line 2988 
2988      my ($handle) = @_;      my ($handle) = @_;
2989      # Declare the return variable.      # Declare the return variable.
2990      my @retVal = ();      my @retVal = ();
2991        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2992      # Read from the file.      # Read from the file.
2993      my $line = <$handle>;      my $line = <$handle>;
2994      # Only proceed if we found something.      # Only proceed if we found something.
2995      if (defined $line) {      if (defined $line) {
2996          # Remove the new-line.          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2997          chomp $line;          # upload control and have a nonstandard EOL combination.
2998            $line =~ s/(\r|\n)+$//;
2999            # Here we do some fancy tracing to help in debugging complicated EOL marks.
3000            if (T(File => 4)) {
3001                my $escapedLine = $line;
3002                $escapedLine =~ s/\n/\\n/g;
3003                $escapedLine =~ s/\r/\\r/g;
3004                $escapedLine =~ s/\t/\\t/g;
3005                Trace("Line read: -->$escapedLine<--");
3006            }
3007          # If the line is empty, return a single empty string; otherwise, parse          # If the line is empty, return a single empty string; otherwise, parse
3008          # it into fields.          # it into fields.
3009          if ($line eq "") {          if ($line eq "") {
# Line 2745  Line 3011 
3011          } else {          } else {
3012              push @retVal, split /\t/,$line;              push @retVal, split /\t/,$line;
3013          }          }
3014        } else {
3015            # Trace the reason the read failed.
3016            Trace("End of file: $!") if T(File => 3);
3017      }      }
3018      # Return the result.      # Return the result.
3019      return @retVal;      return @retVal;
# Line 2752  Line 3021 
3021    
3022  =head3 PutLine  =head3 PutLine
3023    
3024  C<< Tracer::PutLine($handle, \@fields); >>  C<< Tracer::PutLine($handle, \@fields, $eol); >>
3025    
3026  Write a line of data to a tab-delimited file. The specified field values will be  Write a line of data to a tab-delimited file. The specified field values will be
3027  output in tab-separated form, with a trailing new-line.  output in tab-separated form, with a trailing new-line.
# Line 2767  Line 3036 
3036    
3037  List of field values.  List of field values.
3038    
3039    =item eol (optional)
3040    
3041    End-of-line character (default is "\n").
3042    
3043  =back  =back
3044    
3045  =cut  =cut
3046    
3047  sub PutLine {  sub PutLine {
3048      # Get the parameters.      # Get the parameters.
3049      my ($handle, $fields) = @_;      my ($handle, $fields, $eol) = @_;
3050      # Write the data.      # Write the data.
3051      print $handle join("\t", @{$fields}) . "\n";      print $handle join("\t", @{$fields}) . ($eol || "\n");
3052  }  }
3053    
3054  =head3 GenerateURL  =head3 GenerateURL
# Line 2790  Line 3063 
3063    
3064  would return  would return
3065    
3066      form.cgi?type=1&string=%22high%20pass%22%20or%20highway      form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3067    
3068  =over 4  =over 4
3069    
# Line 2820  Line 3093 
3093      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3094      # If the list is nonempty, tack it on.      # If the list is nonempty, tack it on.
3095      if (@parmList) {      if (@parmList) {
3096          $retVal .= "?" . join("&", @parmList);          $retVal .= "?" . join(";", @parmList);
3097        }
3098        # Return the result.
3099        return $retVal;
3100    }
3101    
3102    =head3 ApplyURL
3103    
3104    C<< Tracer::ApplyURL($table, $target, $url); >>
3105    
3106    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3107    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3108    URL column will be deleted by this process and the target column will be HTML-escaped.
3109    
3110    This provides a simple way to process the results of a database query into something
3111    displayable by combining a URL with text.
3112    
3113    =over 4
3114    
3115    =item table
3116    
3117    Reference to a list of lists. The elements in the containing list will be updated by
3118    this method.
3119    
3120    =item target
3121    
3122    The index of the column to be converted into HTML.
3123    
3124    =item url
3125    
3126    The index of the column containing the URL. Note that the URL must have a recognizable
3127    C<http:> at the beginning.
3128    
3129    =back
3130    
3131    =cut
3132    
3133    sub ApplyURL {
3134        # Get the parameters.
3135        my ($table, $target, $url) = @_;
3136        # Loop through the table.
3137        for my $row (@{$table}) {
3138            # Apply the URL to the target cell.
3139            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3140            # Delete the URL from the row.
3141            delete $row->[$url];
3142        }
3143    }
3144    
3145    =head3 CombineURL
3146    
3147    C<< my $combinedHtml = Tracer::CombineURL($text, $url); >>
3148    
3149    This method will convert the specified text into HTML hyperlinked to the specified
3150    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3151    is defined and begins with an C<http:> header.
3152    
3153    =over 4
3154    
3155    =item text
3156    
3157    Text to return. This will be HTML-escaped automatically.
3158    
3159    =item url
3160    
3161    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3162    will be returned without any hyperlinking.
3163    
3164    =item RETURN
3165    
3166    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3167    doesn't look right, the HTML-escaped text will be returned without any further
3168    modification.
3169    
3170    =back
3171    
3172    =cut
3173    
3174    sub CombineURL {
3175        # Get the parameters.
3176        my ($text, $url) = @_;
3177        # Declare the return variable.
3178        my $retVal = CGI::escapeHTML($text);
3179        # Verify the URL.
3180        if (defined($url) && $url =~ m!http://!i) {
3181            # It's good, so we apply it to the text.
3182            $retVal = "<a href=\"$url\">$retVal</a>";
3183      }      }
3184      # Return the result.      # Return the result.
3185      return $retVal;      return $retVal;
3186  }  }
3187    
3188    
3189  1;  1;

Legend:
Removed from v.1.69  
changed lines
  Added in v.1.89

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3