[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.67, Fri Sep 29 15:00:17 2006 UTC revision 1.87, Mon Jun 11 17:34:16 2007 UTC
# Line 19  Line 19 
19    
20      require Exporter;      require Exporter;
21      @ISA = ('Exporter');      @ISA = ('Exporter');
22      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup ScriptSetup ScriptFinish Insure ChDir);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);
23      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
# 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 121  Line 145 
145    
146  =back  =back
147    
148    The format of trace messages is important because some utilities analyze trace files.
149    There are three fields-- the time stamp, the category name, and the text.
150    The time stamp is between square brackets and the category name between angle brackets.
151    After the category name there is a colon (C<:>) followed by the message text.
152    If the square brackets or angle brackets are missing, then the trace management
153    utilities assume that they are encountering a set of pre-formatted lines.
154    
155    Note, however, that this formatting is done automatically by the tracing functions. You
156    only need to know about it if you want to parse a trace file.
157    
158    =head3 Emergency Tracing
159    
160    Sometimes, you need a way for tracing to happen automatically without putting parameters
161    in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
162    from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.
163    Emergency tracing requires you specify a tracing key. For command-line tools, the key is
164    taken from the C<TRACING> environment variable. For web services, the key is taken from
165    a cookie. Either way, the key tells the tracing facility who you are, so that you control
166    the tracing in your environment without stepping on other users.
167    
168    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
169    generate one for you.
170    
171    You can activate and de-activate emergency tracing from the debugging control panel, as
172    well as display the trace file itself.
173    
174    To enable emergency tracing in your code, call
175    
176        ETracing($cgi)
177    
178    from a web script and
179    
180        ETracing()
181    
182    from a command-line script.
183    
184    The web script will look for the tracing key in the cookies, and the command-line
185    script will look for it in the C<TRACING> environment variable. If you are
186    using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
187    will be configured automatically.
188    
189    NOTE: to configure emergency tracing from the command line instead of the Debugging
190    Control Panel (see below), use the C<trace.pl> script.
191    
192    =head3 Debugging Control Panel
193    
194    The debugging control panel provides several tools to assist in development of
195    SEED and Sprout software. You access the debugging control panel from the URL
196    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
197    for example, the panel access point for the development NMPDR system is
198    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
199    find out what the password is. From this page, you can also specify a tracing
200    key. If you don't specify a key, one will be generated for you.
201    
202    =head4 Emergency Tracing Form
203    
204    At the bottom of the debugging control panel is a form that allows you to
205    specify a trace level and tracing categories. Special and common categories
206    are listed with check boxes. You can hold your mouse over a check box to see
207    what its category does. In general, however, a category name is the same as
208    the name of the package in which the trace message occurs.
209    
210    Additional categories can be entered in an input box, delimited by spaces or commas.
211    
212    The B<Activate> button turns on Emergency tracing at the level you specify with the
213    specified categories active. The B<Terminate> button turns tracing off. The
214    B<Show File> button displays the current contents of the trace file. The tracing
215    form at the bottom of the control panel is designed for emergency tracing, so it
216    will only affect programs that call L</ETracing>, L</StandardScript>,
217    or L</StandardSetup>.
218    
219    =head4 Script Form
220    
221    The top form of the debugging control panel allows you to enter a tiny script and
222    have the output generated in a formatted table. Certain object variables are
223    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
224    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
225    
226    The last line of the script must be a scalar, but it can be a reference to a hash,
227    a list, a list of lists, and various other combinations. If you select the appropriate
228    data type in the dropdown box, the output will be formatted accordingly. The form
229    also has controls for specifying tracing. These controls override any emergency
230    tracing in effect.
231    
232    =head4 Database Query Forms
233    
234    The forms between the script form and the emergency tracing form allow you to
235    make queries against the database. The FIG query form allows simple queries against
236    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
237    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
238    package, and it takes five parameters.
239    
240        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
241    
242    Each of the five parameters corresponds to a text box on the query form:
243    
244    =over 4
245    
246    =item Objects
247    
248    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
249    
250    =item Filter
251    
252    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
253    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
254    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
255    field, I<objectName> is the name of the entity or relationship object containing the field, and
256    I<number> is the 1-based position of the object in the object list. Any parameters
257    specified in the filter clause should be specified in the B<Params> field.
258    The fields in a filter clause can come from primary entity relations,
259    relationship relations, or secondary entity relations; however, all of the
260    entities and relationships involved must be included in the list of object names.
261    
262    =item Params
263    
264    List of the parameters to be substituted in for the parameters marks in the filter clause. This
265    is a comma-separated list without any quoting or escaping.
266    
267    =item fields
268    
269    Comma-separated list of the fields to be returned in each element of the list returned. Fields
270    are specified in the same manner as in the filter clause.
271    
272    =item count
273    
274    Maximum number of records to return. If omitted or 0, all available records will be returned.
275    
276    =back
277    
278    B<GetAll> automatically joins together the entities and relationships listed in the object
279    names. This simplifies the coding of the filter clause, but it means that some queries are
280    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
281    that has yet to be addressed.
282    
283  =cut  =cut
284    
285  # Declare the configuration variables.  # Declare the configuration variables.
# Line 200  Line 359 
359          }          }
360          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
361              open TRACEFILE, $target;              open TRACEFILE, $target;
362              print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
363              close TRACEFILE;              close TRACEFILE;
364              $Destination = ">$target";              $Destination = ">$target";
365          } else {          } else {
# Line 233  Line 392 
392      ["Sprout", "SproutLoad", "ERDB"]      ["Sprout", "SproutLoad", "ERDB"]
393    
394  This would cause trace messages in the specified three packages to appear in  This would cause trace messages in the specified three packages to appear in
395  the output. There are threer special tracing categories that are automatically  the output. There are two special tracing categories that are automatically
396  handled by this method. In other words, if you used L</TSetup> you would need  handled by this method. In other words, if you used L</TSetup> you would need
397  to include these categories manually, but if you use this method they are turned  to include these categories manually, but if you use this method they are turned
398  on automatically.  on automatically.
399    
400  =over 4  =over 4
401    
 =item FIG  
   
 Turns on trace messages inside the B<FIG> package.  
   
402  =item SQL  =item SQL
403    
404  Traces SQL commands and activity.  Traces SQL commands and activity.
# Line 293  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 305  Line 460 
460    
461      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
462    
463    Single and double hyphens are equivalent. So, you could also code the
464    above command as
465    
466        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
467    
468  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
469  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
470  above code fragment. The tracing would be set to level 2, and the categories  above code fragment. The tracing would be set to level 2, and the categories
471  would be C<FIG>, C<Tracer>, and <DocUtils>. C<FIG> and C<Tracer> are standard,  would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
472  and C<DocUtils> was included because it came in within the first parameter  and C<DocUtils> was included because it came in within the first parameter
473  to this method. The I<$options> hash would be  to this method. The I<$options> hash would be
474    
# Line 333  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 357  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 409  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 440  Line 608 
608          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
609          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
610      }      }
611      # Now we want to set up tracing. First, we need to know if SQL is to      # Now we want to set up tracing. First, we need to know if the user
612      # be traced.      # wants emergency tracing.
613        if ($retOptions->{trace} eq 'E') {
614            ETracing($retOptions->{user});
615        } else {
616            # Here the tracing is controlled from the command line.
617      my @cats = @{$categories};      my @cats = @{$categories};
618      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
619          push @cats, "SQL";          push @cats, "SQL";
620      }      }
621      # Add the default categories.      # Add the default categories.
622      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
623      # Next, we create the category string by joining the categories.      # Next, we create the category string by joining the categories.
624      my $cats = join(" ", @cats);      my $cats = join(" ", @cats);
625      # Check to determine whether or not the caller wants to turn off tracing      # Check to determine whether or not the caller wants to turn off tracing
# Line 482  Line 654 
654      }      }
655      # Now set up the tracing.      # Now set up the tracing.
656      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
657        }
658      # Check for the "h" option. If it is specified, dump the command-line      # Check for the "h" option. If it is specified, dump the command-line
659      # options and exit the program.      # options and exit the program.
660      if ($retOptions->{h}) {      if ($retOptions->{help}) {
661          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
662          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
663          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
664              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
665              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
666              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
667                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
668              }              }
669              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
670          }          }
671          exit(0);          exit(0);
672      }      }
673        # Trace the options, if applicable.
674        if (T(3)) {
675            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
676            Trace("Selected options: " . join(", ", sort @parms) . ".");
677        }
678      # Return the parsed parameters.      # Return the parsed parameters.
679      return ($retOptions, @retParameters);      return ($retOptions, @retParameters);
680  }  }
# Line 767  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 969  Line 1185 
1185      # Get the timestamp.      # Get the timestamp.
1186      my $timeStamp = Now();      my $timeStamp = Now();
1187      # Format the message. Note we strip off any line terminators at the end.      # Format the message. Note we strip off any line terminators at the end.
1188      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);
1189      # Process according to the destination.      # Process according to the destination.
1190      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1191          # Write the message to the standard output.          # Write the message to the standard output.
# Line 1048  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 1078  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 1092  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 1117  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 1434  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 1469  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 1550  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 @lines = GetFile("$FIG_Config::common_runtime/tool_hdr");
1779            Trace("Tool header has " . scalar(@lines) . " lines.");
1780        }
1781      # Trace the call stack.      # Trace the call stack.
1782      Cluck($message);      Cluck($message);
1783      # Abort the program.      # Abort the program.
# Line 1720  Line 1948 
1948    
1949  C<< if (Tracer::DebugMode) { ...code... } >>  C<< if (Tracer::DebugMode) { ...code... } >>
1950    
1951  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.  
1952    
1953  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1954  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1955  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1956  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1957  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.  
1958    
1959  =cut  =cut
1960    
# Line 1741  Line 1967 
1967      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1968          $retVal = 1;          $retVal = 1;
1969      } else {      } else {
1970          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1971          my $pageString = PageBuilder::Build("<<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1972      }      }
1973      # Return the determination indicator.      # Return the determination indicator.
1974      return $retVal;      return $retVal;
# Line 1895  Line 2120 
2120    
2121  =head3 ScriptSetup  =head3 ScriptSetup
2122    
2123  C<< my ($query, $varHash) = ScriptSetup(); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2124    
2125  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2126  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,
2127    the client should call L</ScriptFinish> to output the web page.
2128    
2129    This method calls L</ETracing> to configure tracing, which allows the tracing
2130    to be configured via the emergency tracing form on the debugging control panel.
2131    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2132    method, which includes every program that uses this method or L</StandardSetup>.
2133    
2134    =over 4
2135    
2136  The C<Trace> query parameter is used to determine whether or not tracing is active and  =item noTrace (optional)
2137  which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  
2138  the C<CGI> trace module will trace parameter and environment information. Parameters are  If specified, tracing will be suppressed. This is useful if the script wants to set up
2139  traced at level 3 and environment variables at level 4. At the end of the script, the  tracing manually.
2140  client should call L</ScriptFinish> to output the web page.  
2141    =item RETURN
2142    
2143    Returns a two-element list consisting of a CGI query object and a variable hash for
2144    the output page.
2145    
2146    =back
2147    
2148  =cut  =cut
2149    
2150  sub ScriptSetup {  sub ScriptSetup {
2151        # Get the parameters.
2152        my ($noTrace) = @_;
2153      # Get the CGI query object.      # Get the CGI query object.
2154      my $query = CGI->new();      my $cgi = CGI->new();
2155      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2156      if ($query->param('Trace')) {      ETracing($cgi) unless $noTrace;
         # Set up tracing.  
         my $ttype = ($query->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");  
         TSetup($query->param('Trace') . " FIG Tracer", $ttype);  
         # Trace the parameter and environment data.  
         TraceParms($query);  
     } else {  
         # Here tracing is to be turned off. All we allow is errors traced into the  
         # error log.  
         TSetup("0", "WARN");  
     }  
2157      # Create the variable hash.      # Create the variable hash.
2158      my $varHash = { DebugData => '' };      my $varHash = { results => '' };
2159      # Return the query object and variable hash.      # Return the query object and variable hash.
2160      return ($query, $varHash);      return ($cgi, $varHash);
2161    }
2162    
2163    =head3 ETracing
2164    
2165    C<< ETracing($parameter); >>
2166    
2167    Set up emergency tracing. Emergency tracing is tracing that is turned
2168    on automatically for any program that calls this method. The emergency
2169    tracing parameters are stored in a a file identified by a tracing key.
2170    If this method is called with a CGI object, then the tracing key is
2171    taken from a cookie. If it is called with no parameters, then the tracing
2172    key is taken from an environment variable. If it is called with a string,
2173    the tracing key is that string.
2174    
2175    =over 4
2176    
2177    =item parameter
2178    
2179    A parameter from which the tracing key is computed. If it is a scalar,
2180    that scalar is used as the tracing key. If it is a CGI object, the
2181    tracing key is taken from the C<IP> cookie. If it is omitted, the
2182    tracing key is taken from the C<TRACING> environment variable. If it
2183    is a CGI object and emergency tracing is not on, the C<Trace> and
2184    C<TF> parameters will be used to determine the type of tracing.
2185    
2186    =back
2187    
2188    =cut
2189    
2190    sub ETracing {
2191        # Get the parameter.
2192        my ($parameter) = @_;
2193        # Check for CGI mode.
2194        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2195        # Default to no tracing except errors.
2196        my ($tracing, $dest) = ("0", "WARN");
2197        # Check for emergency tracing.
2198        my $tkey = EmergencyKey($parameter);
2199        my $emergencyFile = EmergencyFileName($tkey);
2200        if (-e $emergencyFile) {
2201            # We have the file. Read in the data.
2202            my @tracing = GetFile($emergencyFile);
2203            # Pull off the time limit.
2204            my $expire = shift @tracing;
2205            # Convert it to seconds.
2206            $expire *= 3600;
2207            # Check the file data.
2208            my $stat = stat($emergencyFile);
2209            my ($now) = gettimeofday;
2210            if ($now - $stat->mtime > $expire) {
2211                # Delete the expired file.
2212                unlink $emergencyFile;
2213            } else {
2214                # Emergency tracing is on. Pull off the destination and
2215                # the trace level;
2216                $dest = shift @tracing;
2217                my $level = shift @tracing;
2218                # Convert the destination to a real tracing destination.
2219                # temp directory.
2220                $dest = EmergencyTracingDest($tkey, $dest);
2221                # Insure Tracer is specified.
2222                my %moduleHash = map { $_ => 1 } @tracing;
2223                $moduleHash{Tracer} = 1;
2224                # Set the trace parameter.
2225                $tracing = join(" ", $level, sort keys %moduleHash);
2226            }
2227        } elsif (defined $cgi) {
2228            # There's no emergency tracing, but we have a CGI object, so check
2229            # for tracing from the form parameters.
2230            if ($cgi->param('Trace')) {
2231                # Here the user has requested tracing via a form.
2232                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2233                $tracing = $cgi->param('Trace') . " Tracer";
2234            }
2235        }
2236        # Setup the tracing we've determined from all the stuff above.
2237        TSetup($tracing, $dest);
2238        # If we're a web script, trace the parameter and environment data.
2239        if (defined $cgi) {
2240            TraceParms($cgi);
2241        }
2242    }
2243    
2244    =head3 EmergencyFileName
2245    
2246    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2247    
2248    Return the emergency tracing file name. This is the file that specifies
2249    the tracing information.
2250    
2251    =over 4
2252    
2253    =item tkey
2254    
2255    Tracing key for the current program.
2256    
2257    =item RETURN
2258    
2259    Returns the name of the file to contain the emergency tracing information.
2260    
2261    =back
2262    
2263    =cut
2264    
2265    sub EmergencyFileName {
2266        # Get the parameters.
2267        my ($tkey) = @_;
2268        # Compute the emergency tracing file name.
2269        return "$FIG_Config::temp/Emergency$tkey.txt";
2270    }
2271    
2272    =head3 EmergencyFileTarget
2273    
2274    C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2275    
2276    Return the emergency tracing target file name. This is the file that receives
2277    the tracing output for file-based tracing.
2278    
2279    =over 4
2280    
2281    =item tkey
2282    
2283    Tracing key for the current program.
2284    
2285    =item RETURN
2286    
2287    Returns the name of the file to contain the trace output.
2288    
2289    =back
2290    
2291    =cut
2292    
2293    sub EmergencyFileTarget {
2294        # Get the parameters.
2295        my ($tkey) = @_;
2296        # Compute the emergency tracing file name.
2297        return "$FIG_Config::temp/trace$tkey.log";
2298    }
2299    
2300    =head3 EmergencyTracingDest
2301    
2302    C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2303    
2304    This method converts an emergency tracing destination to a real
2305    tracing destination. The main difference is that if the
2306    destination is C<FILE> or C<APPEND>, we convert it to file
2307    output. If the destination is C<DUAL>, we convert it to file
2308    and standard output.
2309    
2310    =over 4
2311    
2312    =item tkey
2313    
2314    Tracing key for this environment.
2315    
2316    =item myDest
2317    
2318    Destination from the emergency tracing file.
2319    
2320    =item RETURN
2321    
2322    Returns a destination that can be passed into L</TSetup>.
2323    
2324    =back
2325    
2326    =cut
2327    
2328    sub EmergencyTracingDest {
2329        # Get the parameters.
2330        my ($tkey, $myDest) = @_;
2331        # Declare the return variable.
2332        my $retVal = $myDest;
2333        # Process according to the destination value.
2334        if ($myDest eq 'FILE') {
2335            $retVal = ">" . EmergencyFileTarget($tkey);
2336        } elsif ($myDest eq 'APPEND') {
2337            $retVal = ">>" . EmergencyFileTarget($tkey);
2338        } elsif ($myDest eq 'DUAL') {
2339            $retVal = "+>" . EmergencyFileTarget($tkey);
2340        }
2341        # Return the result.
2342        return $retVal;
2343  }  }
2344    
2345    =head3 Emergency
2346    
2347    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2348    
2349    Turn on emergency tracing. This method is normally invoked over the web from
2350    a debugging console, but it can also be called by the C<trace.pl> script.
2351    The caller specifies the duration of the emergency in hours, the desired tracing
2352    destination, the trace level, and a list of the trace modules to activate.
2353    For the length of the duration, when a program in an environment with the
2354    specified tracing key active invokes a Sprout CGI script, tracing will be
2355    turned on automatically. See L</TSetup> for more about tracing setup and
2356    L</ETracing> for more about emergency tracing.
2357    
2358    =over 4
2359    
2360    =item tkey
2361    
2362    The tracing key. This is used to identify the control file and the trace file.
2363    
2364    =item hours
2365    
2366    Number of hours to keep emergency tracing alive.
2367    
2368    =item dest
2369    
2370    Tracing destination. If no path information is specified for a file
2371    destination, it is put in the FIG temporary directory.
2372    
2373    =item level
2374    
2375    Tracing level. A higher level means more trace messages.
2376    
2377    =item modules
2378    
2379    A list of the tracing modules to activate.
2380    
2381    =back
2382    
2383    =cut
2384    
2385    sub Emergency {
2386        # Get the parameters.
2387        my ($tkey, $hours, $dest, $level, @modules) = @_;
2388        # Create the emergency file.
2389        my $specFile = EmergencyFileName($tkey);
2390        my $outHandle = Open(undef, ">$specFile");
2391        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2392    }
2393    
2394    =head3 EmergencyKey
2395    
2396    C<< my $tkey = EmergencyKey($parameter); >>
2397    
2398    Return the Key to be used for emergency tracing. This could be an IP address,
2399     a session ID, or a user name, depending on the environment.
2400    
2401    =over 4
2402    
2403    =item parameter
2404    
2405    Parameter defining the method for finding the tracing key. If it is a scalar,
2406    then it is presumed to be the tracing key itself. If it is a CGI object, then
2407    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2408    taken from the C<TRACING> environment variable.
2409    
2410    =item RETURN
2411    
2412    Returns the key to be used for labels in emergency tracing.
2413    
2414    =back
2415    
2416    =cut
2417    
2418    sub EmergencyKey {
2419        # Get the parameters.
2420        my ($parameter) = @_;
2421        # Declare the return variable.
2422        my $retVal;
2423        # Determine the parameter type.
2424        if (! defined $parameter) {
2425            # Here we're supposed to check the environment.
2426            $retVal = $ENV{TRACING};
2427        } else {
2428            my $ptype = ref $parameter;
2429            if ($ptype eq 'CGI') {
2430                # Here we were invoked from a web page. Look for a cookie.
2431                $retVal = $parameter->cookie('IP');
2432            } elsif (! $ptype) {
2433                # Here the key was passed in.
2434                $retVal = $parameter;
2435            }
2436        }
2437        # If no luck finding a key, use the PID.
2438        if (! defined $retVal) {
2439            $retVal = $$;
2440        }
2441        # Return the result.
2442        return $retVal;
2443    }
2444    
2445    
2446  =head3 TraceParms  =head3 TraceParms
2447    
2448  C<< Tracer::TraceParms($query); >>  C<< Tracer::TraceParms($cgi); >>
2449    
2450  Trace the CGI parameters at trace level CGI => 3 and the environment variables  Trace the CGI parameters at trace level CGI => 3 and the environment variables
2451  at level CGI => 4.  at level CGI => 4.
2452    
2453  =over 4  =over 4
2454    
2455  =item query  =item cgi
2456    
2457  CGI query object containing the parameters to trace.  CGI query object containing the parameters to trace.
2458    
# Line 1948  Line 2462 
2462    
2463  sub TraceParms {  sub TraceParms {
2464      # Get the parameters.      # Get the parameters.
2465      my ($query) = @_;      my ($cgi) = @_;
2466      if (T(CGI => 3)) {      if (T(CGI => 3)) {
2467          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
2468          my @names = $query->param;          my @names = $cgi->param;
2469          for my $parmName (sort @names) {          for my $parmName (sort @names) {
2470              # Note we skip "Trace", which is for our use only.              # Note we skip the Trace parameters, which are for our use only.
2471              if ($parmName ne 'Trace') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
2472                  my @values = $query->param($parmName);                  my @values = $cgi->param($parmName);
2473                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("CGI: $parmName = " . join(", ", @values));
2474              }              }
2475          }          }
         # Now output a GET-style URL for this query.  
         my $getURL = $query->url(-relative => 1, -query => 1);  
         # Strip out the Trace parameters.  
         $getURL =~ s/Trace=\d[^;&]+[;&]//;  
         $getURL =~ s/TF=\d[;&]//;  
         # Output the URL.  
         Trace("URL: ../FIG/$getURL");  
2476          # Display the request method.          # Display the request method.
2477          my $method = $query->request_method();          my $method = $cgi->request_method();
2478          Trace("Method: $method");          Trace("Method: $method");
2479      }      }
2480      if (T(CGI => 4)) {      if (T(CGI => 4)) {
# Line 2002  Line 2509 
2509      use FIG;      use FIG;
2510      # ... more uses ...      # ... more uses ...
2511    
2512      my ($query, $varHash) = ScriptSetup();      my ($cgi, $varHash) = ScriptSetup();
2513      eval {      eval {
2514          # ... get data from $query, put it in $varHash ...          # ... get data from $cgi, put it in $varHash ...
2515      };      };
2516      if ($@) {      if ($@) {
2517          Trace("Script Error: $@") if T(0);          Trace("Script Error: $@") if T(0);
# Line 2052  Line 2559 
2559          $outputString = $webData;          $outputString = $webData;
2560      }      }
2561      # Check for trace messages.      # Check for trace messages.
2562      if ($Destination eq "QUEUE") {      if ($Destination ne "NONE" && $TraceLevel > 0) {
2563          # 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
2564          # 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
2565          # end-tag.          # end-tag.
# Line 2060  Line 2567 
2567          if ($outputString =~ m#</body>#gi) {          if ($outputString =~ m#</body>#gi) {
2568              $pos = (pos $outputString) - 7;              $pos = (pos $outputString) - 7;
2569          }          }
2570          substr $outputString, $pos, 0, QTrace('Html');          # If the trace messages were queued, we unroll them. Otherwise, we display the
2571            # destination.
2572            my $traceHtml;
2573            if ($Destination eq "QUEUE") {
2574                $traceHtml = QTrace('Html');
2575            } elsif ($Destination =~ /^>>(.+)$/) {
2576                # Here the tracing output it to a file. We code it as a hyperlink so the user
2577                # can copy the file name into the clipboard easily.
2578                my $actualDest = $1;
2579                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2580            } else {
2581                # Here we have one of the special destinations.
2582                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2583            }
2584            substr $outputString, $pos, 0, $traceHtml;
2585      }      }
2586      # Write the output string.      # Write the output string.
2587      print $outputString;      print $outputString;
# Line 2085  Line 2606 
2606  sub Insure {  sub Insure {
2607      my ($dirName) = @_;      my ($dirName) = @_;
2608      if (! -d $dirName) {      if (! -d $dirName) {
2609          Trace("Creating $dirName directory.") if T(2);          Trace("Creating $dirName directory.") if T(File => 2);
2610          eval { mkpath $dirName; };          eval { mkpath $dirName; };
2611          if ($@) {          if ($@) {
2612              Confess("Error creating $dirName: $@");              Confess("Error creating $dirName: $@");
# Line 2114  Line 2635 
2635      if (! -d $dirName) {      if (! -d $dirName) {
2636          Confess("Cannot change to directory $dirName: no such directory.");          Confess("Cannot change to directory $dirName: no such directory.");
2637      } else {      } else {
2638          Trace("Changing to directory $dirName.") if T(4);          Trace("Changing to directory $dirName.") if T(File => 4);
2639          my $okFlag = chdir $dirName;          my $okFlag = chdir $dirName;
2640          if (! $okFlag) {          if (! $okFlag) {
2641              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
# Line 2293  Line 2814 
2814          my $gid = getgrnam($group);          my $gid = getgrnam($group);
2815          # Get the mask for tracing.          # Get the mask for tracing.
2816          my $traceMask = sprintf("%04o", $mask) . "($mask)";          my $traceMask = sprintf("%04o", $mask) . "($mask)";
2817          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);
2818          my $fixCount = 0;          my $fixCount = 0;
2819          my $lookCount = 0;          my $lookCount = 0;
2820          # @dirs will be a stack of directories to be processed.          # @dirs will be a stack of directories to be processed.
# Line 2308  Line 2829 
2829              if ($dir =~ m!/([^/]+)$!) {              if ($dir =~ m!/([^/]+)$!) {
2830                  $simpleName = $1;                  $simpleName = $1;
2831              }              }
2832              Trace("Simple directory name for $dir is $simpleName.") if T(4);              Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2833              # Search for a match.              # Search for a match.
2834              my $match = 0;              my $match = 0;
2835              my $i;              my $i;
# Line 2333  Line 2854 
2854                      Trace("Checking member $thisMem.") if T(4);                      Trace("Checking member $thisMem.") if T(4);
2855                      $lookCount++;                      $lookCount++;
2856                      if ($lookCount % 1000 == 0) {                      if ($lookCount % 1000 == 0) {
2857                          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);
2858                      }                      }
2859                      # Fix the group.                      # Fix the group.
2860                      chown -1, $gid, $thisMem;                      chown -1, $gid, $thisMem;
# Line 2360  Line 2881 
2881                  }                  }
2882              }              }
2883          }          }
2884          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2885      };      };
2886      # Check for an error.      # Check for an error.
2887      if ($@) {      if ($@) {
# Line 2463  Line 2984 
2984      my ($handle) = @_;      my ($handle) = @_;
2985      # Declare the return variable.      # Declare the return variable.
2986      my @retVal = ();      my @retVal = ();
2987        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2988      # Read from the file.      # Read from the file.
2989      my $line = <$handle>;      my $line = <$handle>;
2990      # Only proceed if we found something.      # Only proceed if we found something.
2991      if (defined $line) {      if (defined $line) {
2992          # Remove the new-line.          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2993          chomp $line;          # upload control and have a nonstandard EOL combination.
2994            $line =~ s/(\r|\n)+$//;
2995            # Here we do some fancy tracing to help in debugging complicated EOL marks.
2996            if (T(File => 4)) {
2997                my $escapedLine = $line;
2998                $escapedLine =~ s/\n/\\n/g;
2999                $escapedLine =~ s/\r/\\r/g;
3000                $escapedLine =~ s/\t/\\t/g;
3001                Trace("Line read: -->$escapedLine<--");
3002            }
3003          # If the line is empty, return a single empty string; otherwise, parse          # If the line is empty, return a single empty string; otherwise, parse
3004          # it into fields.          # it into fields.
3005          if ($line eq "") {          if ($line eq "") {
# Line 2476  Line 3007 
3007          } else {          } else {
3008              push @retVal, split /\t/,$line;              push @retVal, split /\t/,$line;
3009          }          }
3010        } else {
3011            # Trace the reason the read failed.
3012            Trace("End of file: $!") if T(File => 3);
3013      }      }
3014      # Return the result.      # Return the result.
3015      return @retVal;      return @retVal;
# Line 2483  Line 3017 
3017    
3018  =head3 PutLine  =head3 PutLine
3019    
3020  C<< Tracer::PutLine($handle, \@fields); >>  C<< Tracer::PutLine($handle, \@fields, $eol); >>
3021    
3022  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
3023  output in tab-separated form, with a trailing new-line.  output in tab-separated form, with a trailing new-line.
# Line 2498  Line 3032 
3032    
3033  List of field values.  List of field values.
3034    
3035    =item eol (optional)
3036    
3037    End-of-line character (default is "\n").
3038    
3039  =back  =back
3040    
3041  =cut  =cut
3042    
3043  sub PutLine {  sub PutLine {
3044      # Get the parameters.      # Get the parameters.
3045      my ($handle, $fields) = @_;      my ($handle, $fields, $eol) = @_;
3046      # Write the data.      # Write the data.
3047      print $handle join("\t", @{$fields}) . "\n";      print $handle join("\t", @{$fields}) . ($eol || "\n");
3048  }  }
3049    
3050  =head3 GenerateURL  =head3 GenerateURL
# Line 2521  Line 3059 
3059    
3060  would return  would return
3061    
3062      form.cgi?type=1&string=%22high%20pass%22%20or%20highway      form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3063    
3064  =over 4  =over 4
3065    
# Line 2551  Line 3089 
3089      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3090      # If the list is nonempty, tack it on.      # If the list is nonempty, tack it on.
3091      if (@parmList) {      if (@parmList) {
3092          $retVal .= "?" . join("&", @parmList);          $retVal .= "?" . join(";", @parmList);
3093      }      }
3094      # Return the result.      # Return the result.
3095      return $retVal;      return $retVal;
3096  }  }
3097    
3098    =head3 ApplyURL
3099    
3100    C<< Tracer::ApplyURL($table, $target, $url); >>
3101    
3102    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3103    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3104    URL column will be deleted by this process and the target column will be HTML-escaped.
3105    
3106    This provides a simple way to process the results of a database query into something
3107    displayable by combining a URL with text.
3108    
3109    =over 4
3110    
3111    =item table
3112    
3113    Reference to a list of lists. The elements in the containing list will be updated by
3114    this method.
3115    
3116    =item target
3117    
3118    The index of the column to be converted into HTML.
3119    
3120    =item url
3121    
3122    The index of the column containing the URL. Note that the URL must have a recognizable
3123    C<http:> at the beginning.
3124    
3125    =back
3126    
3127    =cut
3128    
3129    sub ApplyURL {
3130        # Get the parameters.
3131        my ($table, $target, $url) = @_;
3132        # Loop through the table.
3133        for my $row (@{$table}) {
3134            # Apply the URL to the target cell.
3135            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3136            # Delete the URL from the row.
3137            delete $row->[$url];
3138        }
3139    }
3140    
3141    =head3 CombineURL
3142    
3143    C<< my $combinedHtml = Tracer::CombineURL($text, $url); >>
3144    
3145    This method will convert the specified text into HTML hyperlinked to the specified
3146    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3147    is defined and begins with an C<http:> header.
3148    
3149    =over 4
3150    
3151    =item text
3152    
3153    Text to return. This will be HTML-escaped automatically.
3154    
3155    =item url
3156    
3157    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3158    will be returned without any hyperlinking.
3159    
3160    =item RETURN
3161    
3162    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3163    doesn't look right, the HTML-escaped text will be returned without any further
3164    modification.
3165    
3166    =back
3167    
3168    =cut
3169    
3170    sub CombineURL {
3171        # Get the parameters.
3172        my ($text, $url) = @_;
3173        # Declare the return variable.
3174        my $retVal = CGI::escapeHTML($text);
3175        # Verify the URL.
3176        if (defined($url) && $url =~ m!http://!i) {
3177            # It's good, so we apply it to the text.
3178            $retVal = "<a href=\"$url\">$retVal</a>";
3179        }
3180        # Return the result.
3181        return $retVal;
3182    }
3183    
3184    
3185  1;  1;

Legend:
Removed from v.1.67  
changed lines
  Added in v.1.87

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3