[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.75, Fri Oct 6 00:41:44 2006 UTC
# Line 19  Line 19 
19    
20      require Exporter;      require Exporter;
21      @ISA = ('Exporter');      @ISA = ('Exporter');
22      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup ScriptSetup ScriptFinish Insure ChDir);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);
23      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
# Line 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  To set up tracing, you call the L</TSetup> method. The method takes as input a trace level, a list  Many programs have customized tracing configured using the L</TSetup> method. This is no longer
76  of category names, and a set of options. The trace level and list of category names are  the preferred method, but a knowledge of how custom tracing works can make the more modern
77    L</Emergency Tracing> easier to understand.
78    
79    To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
80    a list of category names, and a destination. The trace level and list of category names are
81  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
82    
83  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
84    
85  sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and  sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and
86  specifies that messages should be output as HTML paragraphs.  specifies that messages should be sent to the standard output.
87    
88  To turn on tracing for ALL categories, use an asterisk. The call below sets every category to  To turn on tracing for ALL categories, use an asterisk. The call below sets every category to
89  level 3 and writes the output to the standard error output. This sort of thing might be  level 3 and writes the output to the standard error output. This sort of thing might be
90  useful in a CGI environment.  useful in a CGI environment.
91    
92  C<< TSetup('3 *', 'WARN'); >>      TSetup('3 *', 'WARN');
93    
94  In addition to HTML and file output for trace messages, you can specify that the trace messages  In addition standard error and file output for trace messages, you can specify that the trace messages
95  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach
96  is useful if you are building a web page. Instead of having the trace messages interspersed with  is useful if you are building a web page. Instead of having the trace messages interspersed with
97  the page output, they can be gathered together and displayed at the end of the page. This makes  the page output, they can be gathered together and displayed at the end of the page. This makes
98  it easier to debug page formatting problems.  it easier to debug page formatting problems.
99    
100  Finally, you can specify that all trace messages be emitted as warnings.  Finally, you can specify that all trace messages be emitted to a file, or the standard output and
101    a file at the same time. To trace to a file, specify the filename with an output character in front
102    of it.
103    
104        TSetup('4 SQL', ">$fileName");
105    
106    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
107    bracket.
108    
109        TSetup('3 *', "+>$fileName");
110    
111  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.
112  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.
113  Thus, debugging information is available and easily retrieved even when the application is  Thus, debugging information is available and easily retrieved even when the application is
114  being used out in the field.  being used out in the field.
115    
116    =head3 Trace Levels
117    
118  There is no hard and fast rule on how to use trace levels. The following is therefore only  There is no hard and fast rule on how to use trace levels. The following is therefore only
119  a suggestion.  a suggestion.
120    
# Line 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    =head3 Debugging Control Panel
190    
191    The debugging control panel provides several tools to assist in development of
192    SEED and Sprout software. You access the debugging control panel from the URL
193    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
194    for example, the panel access point for the development NMPDR system is
195    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
196    find out what the password is. From this page, you can also specify a tracing
197    key. If you don't specify a key, one will be generated for you.
198    
199    =head4 Emergency Tracing Form
200    
201    At the bottom of the debugging control panel is a form that allows you to
202    specify a trace level and tracing categories. Special and common categories
203    are listed with check boxes. You can hold your mouse over a check box to see
204    what its category does. In general, however, a category name is the same as
205    the name of the package in which the trace message occurs.
206    
207    Additional categories can be entered in an input box, delimited by spaces or commas.
208    
209    The B<Activate> button turns on Emergency tracing at the level you specify with the
210    specified categories active. The B<Terminate> button turns tracing off. The
211    B<Show File> button displays the current contents of the trace file. The tracing
212    form at the bottom of the control panel is designed for emergency tracing, so it
213    will only affect programs that call L</ETracing>, L</StandardScript>,
214    or L</StandardSetup>.
215    
216    =head4 Script Form
217    
218    The top form of the debugging control panel allows you to enter a tiny script and
219    have the output generated in a formatted table. Certain object variables are
220    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
221    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
222    
223    The last line of the script must be a scalar, but it can be a reference to a hash,
224    a list, a list of lists, and various other combinations. If you select the appropriate
225    data type in the dropdown box, the output will be formatted accordingly. The form
226    also has controls for specifying tracing. These controls override any emergency
227    tracing in effect.
228    
229    =head4 Database Query Forms
230    
231    The forms between the script form and the emergency tracing form allow you to
232    make queries against the database. The FIG query form allows simple queries against
233    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
234    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
235    package, and it takes five parameters.
236    
237        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
238    
239    Each of the five parameters corresponds to a text box on the query form:
240    
241    =over 4
242    
243    =item Objects
244    
245    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
246    
247    =item Filter
248    
249    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
250    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
251    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
252    field, I<objectName> is the name of the entity or relationship object containing the field, and
253    I<number> is the 1-based position of the object in the object list. Any parameters
254    specified in the filter clause should be specified in the B<Params> field.
255    The fields in a filter clause can come from primary entity relations,
256    relationship relations, or secondary entity relations; however, all of the
257    entities and relationships involved must be included in the list of object names.
258    
259    =item Params
260    
261    List of the parameters to be substituted in for the parameters marks in the filter clause. This
262    is a comma-separated list without any quoting or escaping.
263    
264    =item fields
265    
266    Comma-separated list of the fields to be returned in each element of the list returned. Fields
267    are specified in the same manner as in the filter clause.
268    
269    =item count
270    
271    Maximum number of records to return. If omitted or 0, all available records will be returned.
272    
273    =back
274    
275    B<GetAll> automatically joins together the entities and relationships listed in the object
276    names. This simplifies the coding of the filter clause, but it means that some queries are
277    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
278    that has yet to be addressed.
279    
280  =cut  =cut
281    
282  # Declare the configuration variables.  # Declare the configuration variables.
# Line 200  Line 356 
356          }          }
357          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
358              open TRACEFILE, $target;              open TRACEFILE, $target;
359              print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
360              close TRACEFILE;              close TRACEFILE;
361              $Destination = ">$target";              $Destination = ">$target";
362          } else {          } else {
# Line 233  Line 389 
389      ["Sprout", "SproutLoad", "ERDB"]      ["Sprout", "SproutLoad", "ERDB"]
390    
391  This would cause trace messages in the specified three packages to appear in  This would cause trace messages in the specified three packages to appear in
392  the output. There are threer special tracing categories that are automatically  the output. There are two special tracing categories that are automatically
393  handled by this method. In other words, if you used L</TSetup> you would need  handled by this method. In other words, if you used L</TSetup> you would need
394  to include these categories manually, but if you use this method they are turned  to include these categories manually, but if you use this method they are turned
395  on automatically.  on automatically.
396    
397  =over 4  =over 4
398    
 =item FIG  
   
 Turns on trace messages inside the B<FIG> package.  
   
399  =item SQL  =item SQL
400    
401  Traces SQL commands and activity.  Traces SQL commands and activity.
# Line 308  Line 460 
460  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
461  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
462  above code fragment. The tracing would be set to level 2, and the categories  above code fragment. The tracing would be set to level 2, and the categories
463  would be C<FIG>, C<Tracer>, and <DocUtils>. C<FIG> and C<Tracer> are standard,  would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
464  and C<DocUtils> was included because it came in within the first parameter  and C<DocUtils> was included because it came in within the first parameter
465  to this method. The I<$options> hash would be  to this method. The I<$options> hash would be
466    
# Line 333  Line 485 
485  C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to  C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
486  simplify starting a command in the background.  simplify starting a command in the background.
487    
488    The user name is also used as the tracing key for L</Emergency Tracing>.
489    Specifying a value of C<E> for the trace level causes emergency tracing to
490    be used instead of custom tracing. If the user name is not specified,
491    the tracing key is taken from the C<Tracing> environment variable. If there
492    is no value for that variable, the tracing key will be computed from the PID.
493    
494  Finally, if the special option C<-h> is specified, the option names will  Finally, if the special option C<-h> is specified, the option names will
495  be traced at level 0 and the program will exit without processing.  be traced at level 0 and the program will exit without processing.
496  This provides a limited help capability. For example, if the user enters  This provides a limited help capability. For example, if the user enters
# Line 342  Line 500 
500  he would see the following output.  he would see the following output.
501    
502      TransactFeatures [options] command transactionDirectory IDfile      TransactFeatures [options] command transactionDirectory IDfile
503          -trace    tracing level (default 2)          -trace    tracing level (default E)
504          -sql      trace SQL commands          -sql      trace SQL commands
505          -safe     use database transactions          -safe     use database transactions
506          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
# Line 357  Line 515 
515      { trace => [0, "tracing level (default 0)"],      { trace => [0, "tracing level (default 0)"],
516         ...         ...
517    
518  would set the default trace level to 0 instead of 2, while  would set the default trace level to 0 instead of E, while
519    
520      { trace => ["2-", "tracing level (default 2)"],      { trace => ["2-", "tracing level (default 2)"],
521         ...         ...
522    
523  would leave the default at 2, but trace only to the log file, not to the  would set the default to 2, but trace only to the log file, not to the
524  standard output.  standard output.
525    
526  The parameters to this method are as follows.  The parameters to this method are as follows.
# Line 409  Line 567 
567  sub StandardSetup {  sub StandardSetup {
568      # Get the parameters.      # Get the parameters.
569      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
570        # Get the default tracing key.
571        my $tkey = EmergencyKey();
572      # Add the tracing options.      # Add the tracing options.
573      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
574          $options->{trace} = [2, "tracing level"];          $options->{trace} = ['E', "tracing level (E for emergency tracing)"];
575      }      }
576      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
577      $options->{h} = [0, "display command-line options"];      $options->{h} = [0, "display command-line options"];
578      $options->{user} = [$$, "trace log file name suffix"];      $options->{user} = [$tkey, "tracing key"];
579      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
580      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
581      # contains the default values rather than the default value      # contains the default values rather than the default value
# Line 440  Line 600 
600          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
601          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
602      }      }
603      # Now we want to set up tracing. First, we need to know if SQL is to      # Now we want to set up tracing. First, we need to know if the user
604      # be traced.      # wants emergency tracing.
605        if ($retOptions->{trace} eq 'E') {
606            ETracing($retOptions->{user});
607        } else {
608            # Here the tracing is controlled from the command line.
609      my @cats = @{$categories};      my @cats = @{$categories};
610      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
611          push @cats, "SQL";          push @cats, "SQL";
612      }      }
613      # Add the default categories.      # Add the default categories.
614      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
615      # Next, we create the category string by joining the categories.      # Next, we create the category string by joining the categories.
616      my $cats = join(" ", @cats);      my $cats = join(" ", @cats);
617      # Check to determine whether or not the caller wants to turn off tracing      # Check to determine whether or not the caller wants to turn off tracing
# Line 482  Line 646 
646      }      }
647      # Now set up the tracing.      # Now set up the tracing.
648      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
649        }
650      # Check for the "h" option. If it is specified, dump the command-line      # Check for the "h" option. If it is specified, dump the command-line
651      # options and exit the program.      # options and exit the program.
652      if ($retOptions->{h}) {      if ($retOptions->{h}) {
653          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
654          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
655          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
656              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
657              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
658              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
659                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
660              }              }
661              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
662          }          }
663          exit(0);          exit(0);
664      }      }
# Line 767  Line 932 
932      return $value;      return $value;
933  }  }
934    
935    =head3 ParseTraceDate
936    
937    C<< my $time = Tracer::ParseTraceDate($dateString); >>
938    
939    Convert a date from the trace file into a PERL timestamp.
940    
941    =over 4
942    
943    =item dateString
944    
945    The date string from the trace file. The format of the string is determined by the
946    L</Now> method.
947    
948    =item RETURN
949    
950    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
951    the time string is invalid.
952    
953    =cut
954    
955    sub ParseTraceDate {
956        # Get the parameters.
957        my ($dateString) = @_;
958        # Declare the return variable.
959        my $retVal;
960        # Parse the date.
961        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
962            # Create a time object.
963            $retVal = timelocal($6, $5, $4, $2, $1, $3);
964        }
965        # Return the result.
966        return $retVal;
967    }
968    
969  =head3 LogErrors  =head3 LogErrors
970    
971  C<< Tracer::LogErrors($fileName); >>  C<< Tracer::LogErrors($fileName); >>
# Line 969  Line 1168 
1168      # Get the timestamp.      # Get the timestamp.
1169      my $timeStamp = Now();      my $timeStamp = Now();
1170      # 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.
1171      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);
1172      # Process according to the destination.      # Process according to the destination.
1173      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1174          # Write the message to the standard output.          # Write the message to the standard output.
# Line 1720  Line 1919 
1919    
1920  C<< if (Tracer::DebugMode) { ...code... } >>  C<< if (Tracer::DebugMode) { ...code... } >>
1921    
1922  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.  
1923    
1924  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1925  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1926  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1927  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1928  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.  
1929    
1930  =cut  =cut
1931    
# Line 1741  Line 1938 
1938      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1939          $retVal = 1;          $retVal = 1;
1940      } else {      } else {
1941          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1942          my $pageString = PageBuilder::Build("<<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1943      }      }
1944      # Return the determination indicator.      # Return the determination indicator.
1945      return $retVal;      return $retVal;
# Line 1895  Line 2091 
2091    
2092  =head3 ScriptSetup  =head3 ScriptSetup
2093    
2094  C<< my ($query, $varHash) = ScriptSetup(); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2095    
2096  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2097  the CGI object followed by a pre-built variable hash.  the CGI object followed by a pre-built variable hash.
2098    
2099  The C<Trace> query parameter is used to determine whether or not tracing is active and  The C<Trace> form parameter is used to determine whether or not tracing is active and
2100  which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying  which trace modules (other than C<Tracer> itself) should be turned on. Specifying
2101  the C<CGI> trace module will trace parameter and environment information. Parameters are  the C<CGI> trace module will trace parameter and environment information. Parameters are
2102  traced at level 3 and environment variables at level 4. At the end of the script, the  traced at level 3 and environment variables at level 4. To trace to a file instead of to
2103  client should call L</ScriptFinish> to output the web page.  the web page, set C<TF> to 1. At the end of the script, the client should call
2104    L</ScriptFinish> to output the web page.
2105    
2106    In some situations, it is not practical to invoke tracing via form parameters. For this
2107    situation, you can turn on emergency tracing from the debugging control panel.
2108    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2109    method, which includes every program that uses this method or L</StandardSetup>.
2110    
2111    =over 4
2112    
2113    =item noTrace (optional)
2114    
2115    If specified, tracing will be suppressed. This is useful if the script wants to set up
2116    tracing manually.
2117    
2118    =item RETURN
2119    
2120    Returns a two-element list consisting of a CGI query object and a variable hash for
2121    the output page.
2122    
2123    =back
2124    
2125  =cut  =cut
2126    
2127  sub ScriptSetup {  sub ScriptSetup {
2128        # Get the parameters.
2129        my ($noTrace) = @_;
2130      # Get the CGI query object.      # Get the CGI query object.
2131      my $query = CGI->new();      my $cgi = CGI->new();
2132      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2133      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");  
     }  
2134      # Create the variable hash.      # Create the variable hash.
2135      my $varHash = { DebugData => '' };      my $varHash = { results => '' };
2136      # Return the query object and variable hash.      # Return the query object and variable hash.
2137      return ($query, $varHash);      return ($cgi, $varHash);
2138    }
2139    
2140    =head3 ETracing
2141    
2142    C<< ETracing($parameter); >>
2143    
2144    Set up emergency tracing. Emergency tracing is tracing that is turned
2145    on automatically for any program that calls this method. The emergency
2146    tracing parameters are stored in a a file identified by a tracing key.
2147    If this method is called with a CGI object, then the tracing key is
2148    taken from a cookie. If it is called with no parameters, then the tracing
2149    key is taken from an environment variable. If it is called with a string,
2150    the tracing key is that string.
2151    
2152    =over 4
2153    
2154    =item parameter
2155    
2156    A parameter from which the tracing key is computed. If it is a scalar,
2157    that scalar is used as the tracing key. If it is a CGI object, the
2158    tracing key is taken from the C<IP> cookie. If it is omitted, the
2159    tracing key is taken from the C<TRACING> environment variable. If it
2160    is a CGI object and emergency tracing is not on, the C<Trace> and
2161    C<TF> parameters will be used to determine the type of tracing.
2162    
2163    =back
2164    
2165    =cut
2166    
2167    sub ETracing {
2168        # Get the parameter.
2169        my ($parameter) = @_;
2170        # Check for CGI mode.
2171        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2172        # Default to no tracing except errors.
2173        my ($tracing, $dest) = ("0", "WARN");
2174        # Check for emergency tracing.
2175        my $tkey = EmergencyKey($parameter);
2176        my $emergencyFile = EmergencyFileName($tkey);
2177        if (-e $emergencyFile) {
2178            # We have the file. Read in the data.
2179            my @tracing = GetFile($emergencyFile);
2180            # Pull off the time limit.
2181            my $expire = shift @tracing;
2182            # Convert it to seconds.
2183            $expire *= 3600;
2184            # Check the file data.
2185            my $stat = stat($emergencyFile);
2186            my ($now) = gettimeofday;
2187            if ($now - $stat->mtime > $expire) {
2188                # Delete the expired file.
2189                unlink $emergencyFile;
2190            } else {
2191                # Emergency tracing is on. Pull off the destination and
2192                # the trace level;
2193                $dest = shift @tracing;
2194                my $level = shift @tracing;
2195                # Convert the destination to a real tracing destination.
2196                # temp directory.
2197                $dest = EmergencyTracingDest($tkey, $dest);
2198                # Insure Tracer is specified.
2199                my %moduleHash = map { $_ => 1 } @tracing;
2200                $moduleHash{Tracer} = 1;
2201                # Set the trace parameter.
2202                $tracing = join(" ", $level, sort keys %moduleHash);
2203            }
2204        } elsif (defined $cgi) {
2205            # There's no emergency tracing, but we have a CGI object, so check
2206            # for tracing from the form parameters.
2207            if ($cgi->param('Trace')) {
2208                # Here the user has requested tracing via a form.
2209                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2210                $tracing = $cgi->param('Trace') . " Tracer";
2211            }
2212        }
2213        # Setup the tracing we've determined from all the stuff above.
2214        TSetup($tracing, $dest);
2215        # If we're a web script, trace the parameter and environment data.
2216        if (defined $cgi) {
2217            TraceParms($cgi);
2218        }
2219    }
2220    
2221    =head3 EmergencyFileName
2222    
2223    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2224    
2225    Return the emergency tracing file name. This is the file that specifies
2226    the tracing information.
2227    
2228    =over 4
2229    
2230    =item tkey
2231    
2232    Tracing key for the current program.
2233    
2234    =item RETURN
2235    
2236    Returns the name of the file to contain the emergency tracing information.
2237    
2238    =back
2239    
2240    =cut
2241    
2242    sub EmergencyFileName {
2243        # Get the parameters.
2244        my ($tkey) = @_;
2245        # Compute the emergency tracing file name.
2246        return "$FIG_Config::temp/Emergency$tkey.txt";
2247    }
2248    
2249    =head3 EmergencyFileTarget
2250    
2251    C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2252    
2253    Return the emergency tracing target file name. This is the file that receives
2254    the tracing output for file-based tracing.
2255    
2256    =over 4
2257    
2258    =item tkey
2259    
2260    Tracing key for the current program.
2261    
2262    =item RETURN
2263    
2264    Returns the name of the file to contain the trace output.
2265    
2266    =back
2267    
2268    =cut
2269    
2270    sub EmergencyFileTarget {
2271        # Get the parameters.
2272        my ($tkey) = @_;
2273        # Compute the emergency tracing file name.
2274        return "$FIG_Config::temp/trace$tkey.log";
2275  }  }
2276    
2277    =head3 EmergencyTracingDest
2278    
2279    C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2280    
2281    This method converts an emergency tracing destination to a real
2282    tracing destination. The main difference is that if the
2283    destination is C<FILE> or C<APPEND>, we convert it to file
2284    output.
2285    
2286    =over 4
2287    
2288    =item tkey
2289    
2290    Tracing key for this environment.
2291    
2292    =item myDest
2293    
2294    Destination from the emergency tracing file.
2295    
2296    =item RETURN
2297    
2298    Returns a destination that can be passed into L</TSetup>.
2299    
2300    =back
2301    
2302    =cut
2303    
2304    sub EmergencyTracingDest {
2305        # Get the parameters.
2306        my ($tkey, $myDest) = @_;
2307        # Declare the return variable.
2308        my $retVal;
2309        # Process according to the destination value.
2310        if ($myDest eq 'FILE') {
2311            $retVal = ">" . EmergencyFileTarget($tkey);
2312        } elsif ($myDest eq 'APPEND') {
2313            $retVal = ">>" . EmergencyFileTarget($tkey);
2314        } else {
2315            $retVal = $myDest;
2316        }
2317        # Return the result.
2318        return $retVal;
2319    }
2320    
2321    =head3 Emergency
2322    
2323    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2324    
2325    Turn on emergency tracing. This method can only be invoked over the web and is
2326    should not be called if debug mode is off. The caller specifies the duration of the
2327    emergency in hours, the desired tracing destination, the trace level,
2328    and a list of the trace modules to activate. For the length of the duration, when a
2329    program in an environment with the specified tracing key active invokes a Sprout
2330    CGI script, tracing will be turned on automatically. See L</TSetup> for more
2331    about tracing setup and L</ETracing> for more about emergency tracing.
2332    
2333    =over 4
2334    
2335    =item tkey
2336    
2337    The tracing key. This is used to identify the control file and the trace file.
2338    
2339    =item hours
2340    
2341    Number of hours to keep emergency tracing alive.
2342    
2343    =item dest
2344    
2345    Tracing destination. If no path information is specified for a file
2346    destination, it is put in the FIG temporary directory.
2347    
2348    =item level
2349    
2350    Tracing level. A higher level means more trace messages.
2351    
2352    =item modules
2353    
2354    A list of the tracing modules to activate.
2355    
2356    =back
2357    
2358    =cut
2359    
2360    sub Emergency {
2361        # Get the parameters.
2362        my ($tkey, $hours, $dest, $level, @modules) = @_;
2363        # Create the emergency file.
2364        my $specFile = EmergencyFileName($tkey);
2365        my $outHandle = Open(undef, ">$specFile");
2366        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2367    }
2368    
2369    =head3 EmergencyKey
2370    
2371    C<< my $tkey = EmergencyKey($parameter); >>
2372    
2373    Return the Key to be used for emergency tracing. This could be an IP address,
2374     a session ID, or a user name, depending on the environment.
2375    
2376    =over 4
2377    
2378    =item parameter
2379    
2380    Parameter defining the method for finding the tracing key. If it is a scalar,
2381    then it is presumed to be the tracing key itself. If it is a CGI object, then
2382    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2383    taken from the C<TRACING> environment variable.
2384    
2385    =item RETURN
2386    
2387    Returns the key to be used for labels in emergency tracing.
2388    
2389    =back
2390    
2391    =cut
2392    
2393    sub EmergencyKey {
2394        # Get the parameters.
2395        my ($parameter) = @_;
2396        # Declare the return variable.
2397        my $retVal;
2398        # Determine the parameter type.
2399        if (! defined $parameter) {
2400            # Here we're supposed to check the environment.
2401            $retVal = $ENV{TRACING};
2402        } else {
2403            my $ptype = ref $parameter;
2404            if ($ptype eq 'CGI') {
2405                # Here we were invoked from a web page. Look for a cookie.
2406                $retVal = $parameter->cookie('IP');
2407            } elsif (! $ptype) {
2408                # Here the key was passed in.
2409                $retVal = $parameter;
2410            }
2411        }
2412        # If no luck finding a key, use the PID.
2413        if (! defined $retVal) {
2414            $retVal = $$;
2415        }
2416        # Return the result.
2417        return $retVal;
2418    }
2419    
2420    
2421  =head3 TraceParms  =head3 TraceParms
2422    
2423  C<< Tracer::TraceParms($query); >>  C<< Tracer::TraceParms($cgi); >>
2424    
2425  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
2426  at level CGI => 4.  at level CGI => 4.
2427    
2428  =over 4  =over 4
2429    
2430  =item query  =item cgi
2431    
2432  CGI query object containing the parameters to trace.  CGI query object containing the parameters to trace.
2433    
# Line 1948  Line 2437 
2437    
2438  sub TraceParms {  sub TraceParms {
2439      # Get the parameters.      # Get the parameters.
2440      my ($query) = @_;      my ($cgi) = @_;
2441      if (T(CGI => 3)) {      if (T(CGI => 3)) {
2442          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
2443          my @names = $query->param;          my @names = $cgi->param;
2444          for my $parmName (sort @names) {          for my $parmName (sort @names) {
2445              # Note we skip "Trace", which is for our use only.              # Note we skip the Trace parameters, which are for our use only.
2446              if ($parmName ne 'Trace') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
2447                  my @values = $query->param($parmName);                  my @values = $cgi->param($parmName);
2448                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("CGI: $parmName = " . join(", ", @values));
2449              }              }
2450          }          }
         # 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");  
2451          # Display the request method.          # Display the request method.
2452          my $method = $query->request_method();          my $method = $cgi->request_method();
2453          Trace("Method: $method");          Trace("Method: $method");
2454      }      }
2455      if (T(CGI => 4)) {      if (T(CGI => 4)) {
# Line 2002  Line 2484 
2484      use FIG;      use FIG;
2485      # ... more uses ...      # ... more uses ...
2486    
2487      my ($query, $varHash) = ScriptSetup();      my ($cgi, $varHash) = ScriptSetup();
2488      eval {      eval {
2489          # ... get data from $query, put it in $varHash ...          # ... get data from $cgi, put it in $varHash ...
2490      };      };
2491      if ($@) {      if ($@) {
2492          Trace("Script Error: $@") if T(0);          Trace("Script Error: $@") if T(0);
# Line 2052  Line 2534 
2534          $outputString = $webData;          $outputString = $webData;
2535      }      }
2536      # Check for trace messages.      # Check for trace messages.
2537      if ($Destination eq "QUEUE") {      if ($Destination ne "NONE" && $TraceLevel > 0) {
2538          # 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
2539          # 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
2540          # end-tag.          # end-tag.
# Line 2060  Line 2542 
2542          if ($outputString =~ m#</body>#gi) {          if ($outputString =~ m#</body>#gi) {
2543              $pos = (pos $outputString) - 7;              $pos = (pos $outputString) - 7;
2544          }          }
2545          substr $outputString, $pos, 0, QTrace('Html');          # If the trace messages were queued, we unroll them. Otherwise, we display the
2546            # destination.
2547            my $traceHtml;
2548            if ($Destination eq "QUEUE") {
2549                $traceHtml = QTrace('Html');
2550            } elsif ($Destination =~ /^>>(.+)$/) {
2551                # Here the tracing output it to a file. We code it as a hyperlink so the user
2552                # can copy the file name into the clipboard easily.
2553                my $actualDest = $1;
2554                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2555            } else {
2556                # Here we have one of the special destinations.
2557                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2558            }
2559            substr $outputString, $pos, 0, $traceHtml;
2560      }      }
2561      # Write the output string.      # Write the output string.
2562      print $outputString;      print $outputString;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3