[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.71, Mon Oct 2 06:34:57 2006 UTC revision 1.72, Tue Oct 3 02:30:05 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 EmergencyIP ScriptSetup ScriptFinish Insure ChDir Emergency);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);
23      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
# Line 37  Line 37 
37    
38  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
39    
40  =head2 Introduction  =head2 Tracing
41    
42  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
43  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.
44  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,
45  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
46  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
47  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
48  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
49  appear. To generate a trace message, use the following syntax.  appear.
50    
51  C<< Trace($message) if T(errors => 4); >>  =head3 Putting Trace Messages in Your Code
52    
53    To generate a trace message, use the following syntax.
54    
55        Trace($message) if T(errors => 4);
56    
57  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>
58  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
59    
60  C<< Trace($message) if T(main => 4); >>      Trace($message) if T(main => 4);
61    
62  will trace if the trace level is 4 or more.  will trace if the trace level is 4 or more.
63    
# Line 61  Line 65 
65  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
66  active and the trace level is 2 or more.  active and the trace level is 2 or more.
67    
68  C<< Trace($message) if T(2); >>      Trace($message) if T(2);
69    
70    In scripts, where no package name is available, the category defaults to C<main>.
71    
72    =head3 Custom Tracing
73    
74    Many programs have customized tracing configured using the L</TSetup> method. This is no longer
75    the preferred method, but a knowledge of how custom tracing works can make the more modern
76    L</Emergency Tracing> easier to understand.
77    
78  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,
79  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
80  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
81    
82  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
83    
84  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
85  specifies that messages should be output as HTML paragraphs.  specifies that messages should be sent to the standard output.
86    
87  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
88  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
89  useful in a CGI environment.  useful in a CGI environment.
90    
91  C<< TSetup('3 *', 'WARN'); >>      TSetup('3 *', 'WARN');
92    
93  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
94  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
95  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
96  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
97  it easier to debug page formatting problems.  it easier to debug page formatting problems.
98    
99  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
100    a file at the same time. To trace to a file, specify the filename with an output character in front
101    of it.
102    
103        TSetup('4 SQL', ">$fileName");
104    
105    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
106    bracket.
107    
108        TSetup('3 *', "+>$fileName");
109    
110  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>.
111  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.
112  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
113  being used out in the field.  being used out in the field.
114    
115    =head3 Trace Levels
116    
117  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
118  a suggestion.  a suggestion.
119    
# Line 122  Line 145 
145  =back  =back
146    
147  The format of trace messages is important because some utilities analyze trace files.  The format of trace messages is important because some utilities analyze trace files.
148  The time stamp is between square brackets, the module name between angle brackets,  There are three fields-- the time stamp, the category name, and the text.
149  a colon (C<:>), and the message text after that. If the square brackets or angle  The time stamp is between square brackets and the category name between angle brackets.
150  brackets are missing, then the trace management utilities assume that they  After the category name there is a colon (C<:>) followed by the message text.
151  are encountering a set of pre-formatted lines.  If the square brackets or angle brackets are missing, then the trace management
152    utilities assume that they are encountering a set of pre-formatted lines.
153    
154    Note, however, that this formatting is done automatically by the tracing functions. You
155    only need to know about it if you want to parse a trace file.
156    
157    =head3 Emergency Tracing
158    
159    Sometimes, you need a way for tracing to happen automatically without putting parameters
160    in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
161    from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.
162    Emergency tracing requires you specify a tracing key. For command-line tools, the key is
163    taken from the C<TRACING> environment variable. For web services, the key is taken from
164    a cookie. Either way, the key tells the tracing facility who you are, so that you control
165    the tracing in your environment without stepping on other users.
166    
167    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
168    generate one for you.
169    
170    You can activate and de-activate emergency tracing from the debugging control panel, as
171    well as display the trace file itself.
172    
173    To enable emergency tracing in your code, call
174    
175        ETracing($cgi)
176    
177    from a web script and
178    
179        ETracing()
180    
181    from a command-line script.
182    
183    The web script will look for the tracing key in the cookies, and the command-line
184    script will look for it in the C<TRACING> environment variable. If you are
185    using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
186    will be configured automatically.
187    
188    =head3 Debugging Control Panel
189    
190    The debugging control panel provides several tools to assist in development of
191    SEED and Sprout software. You access the debugging control panel from the URL
192    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
193    for example, the panel access point for the development NMPDR system is
194    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
195    find out what the password is. From this page, you can also specify a tracing
196    key. If you don't specify a key, one will be generated for you.
197    
198    =head4 Emergency Tracing Form
199    
200    At the bottom of the debugging control panel is a form that allows you to
201    specify a trace level and tracing categories. Special and common categories
202    are listed with check boxes. You can hold your mouse over a check box to see
203    what its category does. In general, however, a category name is the same as
204    the name of the package in which the trace message occurs.
205    
206    Additional categories can be entered in an input box, delimited by spaces or commas.
207    
208    The B<Activate> button turns on Emergency tracing at the level you specify with the
209    specified categories active. The B<Terminate> button turns tracing off. The
210    B<Show File> button displays the current contents of the trace file. The tracing
211    form at the bottom of the control panel is designed for emergency tracing, so it
212    will only affect programs that call L</ETracing>, L</StandardScript>,
213    or L</StandardSetup>.
214    
215    =head4 Script Form
216    
217    The top form of the debugging control panel allows you to enter a tiny script and
218    have the output generated in a formatted table. Certain object variables are
219    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
220    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
221    
222    The last line of the script must be a scalar, but it can be a reference to a hash,
223    a list, a list of lists, and various other combinations. If you select the appropriate
224    data type in the dropdown box, the output will be formatted accordingly. The form
225    also has controls for specifying tracing. These controls override any emergency
226    tracing in effect.
227    
228    =head4 Database Query Forms
229    
230    The forms between the script form and the emergency tracing form allow you to
231    make queries against the database. The FIG query form allows simple queries against
232    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
233    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
234    package, and it takes five parameters.
235    
236        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
237    
238    Each of the five parameters corresponds to a text box on the query form:
239    
240    =over 4
241    
242    =item Objects
243    
244    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
245    
246    =item Filter
247    
248    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
249    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
250    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
251    field, I<objectName> is the name of the entity or relationship object containing the field, and
252    I<number> is the 1-based position of the object in the object list. Any parameters
253    specified in the filter clause should be specified in the B<Params> field.
254    The fields in a filter clause can come from primary entity relations,
255    relationship relations, or secondary entity relations; however, all of the
256    entities and relationships involved must be included in the list of object names.
257    
258    =item Params
259    
260    List of the parameters to be substituted in for the parameters marks in the filter clause. This
261    is a comma-separated list without any quoting or escaping.
262    
263    =item fields
264    
265    Comma-separated list of the fields to be returned in each element of the list returned. Fields
266    are specified in the same manner as in the filter clause.
267    
268    =item count
269    
270    Maximum number of records to return. If omitted or 0, all available records will be returned.
271    
272    =back
273    
274    B<GetAll> automatically joins together the entities and relationships listed in the object
275    names. This simplifies the coding of the filter clause, but it means that some queries are
276    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
277    that has yet to be addressed.
278    
279  =cut  =cut
280    
# Line 335  Line 484 
484  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
485  simplify starting a command in the background.  simplify starting a command in the background.
486    
487    The user name is also used as the tracing key for L</Emergency Tracing>.
488    Specifying a value of C<E> for the trace level causes emergency tracing to
489    be used instead of custom tracing. If the user name is not specified,
490    the tracing key is taken from the C<Tracing> environment variable. If there
491    is no value for that variable, the tracing key will be computed from the PID.
492    
493  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
494  be traced at level 0 and the program will exit without processing.  be traced at level 0 and the program will exit without processing.
495  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 344  Line 499 
499  he would see the following output.  he would see the following output.
500    
501      TransactFeatures [options] command transactionDirectory IDfile      TransactFeatures [options] command transactionDirectory IDfile
502          -trace    tracing level (default 2)          -trace    tracing level (default E)
503          -sql      trace SQL commands          -sql      trace SQL commands
504          -safe     use database transactions          -safe     use database transactions
505          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
# Line 359  Line 514 
514      { trace => [0, "tracing level (default 0)"],      { trace => [0, "tracing level (default 0)"],
515         ...         ...
516    
517  would set the default trace level to 0 instead of 2, while  would set the default trace level to 0 instead of E, while
518    
519      { trace => ["2-", "tracing level (default 2)"],      { trace => ["2-", "tracing level (default 2)"],
520         ...         ...
521    
522  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
523  standard output.  standard output.
524    
525  The parameters to this method are as follows.  The parameters to this method are as follows.
# Line 411  Line 566 
566  sub StandardSetup {  sub StandardSetup {
567      # Get the parameters.      # Get the parameters.
568      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
569        # Get the default tracing key.
570        my $tkey = EmergencyKey();
571      # Add the tracing options.      # Add the tracing options.
572      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
573          $options->{trace} = [2, "tracing level"];          $options->{trace} = ['E', "tracing level (E for emergency tracing)"];
574      }      }
575      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
576      $options->{h} = [0, "display command-line options"];      $options->{h} = [0, "display command-line options"];
577      $options->{user} = [$$, "trace log file name suffix"];      $options->{user} = [$tkey, "tracing key"];
578      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
579      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
580      # contains the default values rather than the default value      # contains the default values rather than the default value
# Line 442  Line 599 
599          open STDOUT, ">$outFileName";          open STDOUT, ">$outFileName";
600          open STDERR, ">$errFileName";          open STDERR, ">$errFileName";
601      }      }
602      # 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
603      # be traced.      # wants emergency tracing.
604        if ($retOptions->{trace} eq 'E') {
605            ETracing($retOptions->{user});
606        } else {
607            # Here the tracing is controlled from the command line.
608      my @cats = @{$categories};      my @cats = @{$categories};
609      if ($retOptions->{sql}) {      if ($retOptions->{sql}) {
610          push @cats, "SQL";          push @cats, "SQL";
# Line 484  Line 645 
645      }      }
646      # Now set up the tracing.      # Now set up the tracing.
647      TSetup("$traceLevel $cats", $traceMode);      TSetup("$traceLevel $cats", $traceMode);
648        }
649      # 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
650      # options and exit the program.      # options and exit the program.
651      if ($retOptions->{h}) {      if ($retOptions->{h}) {
# Line 1899  Line 2061 
2061  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2062  the CGI object followed by a pre-built variable hash.  the CGI object followed by a pre-built variable hash.
2063    
2064  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
2065  which trace modules (other than C<Tracer> itself) should be turned on. Specifying  which trace modules (other than C<Tracer> itself) should be turned on. Specifying
2066  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
2067  traced at level 3 and environment variables at level 4. To trace to a file instead of to  traced at level 3 and environment variables at level 4. To trace to a file instead of to
# Line 1907  Line 2069 
2069  L</ScriptFinish> to output the web page.  L</ScriptFinish> to output the web page.
2070    
2071  In some situations, it is not practical to invoke tracing via form parameters. For this  In some situations, it is not practical to invoke tracing via form parameters. For this
2072  situation, you can turn on emergency tracing by invoking the L</Emergency> method from  situation, you can turn on emergency tracing from the debugging control panel.
2073  a web page. Emergency tracing is detected via a file with the name  Tracing will then be turned on automatically for all programs that use the L</ETracing>
2074  C<Emergency>I<IPaddr>C<.txt> in the FIG temporary directory, where I<IPaddr> is the  method, which includes every program that uses this method or L</StandardSetup>.
 IP address of the remote user who wants tracing turned on. The file contains a time  
 limit in hours on the first line, a tracing destination on the second line, a trace  
 level on the third line, and the tracing modules on subsequent lines.  
2075    
2076  =over 4  =over 4
2077    
# Line 1936  Line 2095 
2095      # Get the CGI query object.      # Get the CGI query object.
2096      my $cgi = CGI->new();      my $cgi = CGI->new();
2097      # Set up tracing if it's not suppressed.      # Set up tracing if it's not suppressed.
2098      CGITrace($cgi) unless $noTrace;      ETracing($cgi) unless $noTrace;
2099      # Create the variable hash.      # Create the variable hash.
2100      my $varHash = { results => '' };      my $varHash = { results => '' };
2101      # Return the query object and variable hash.      # Return the query object and variable hash.
2102      return ($cgi, $varHash);      return ($cgi, $varHash);
2103  }  }
2104    
2105  =head3 CGITrace  =head3 ETracing
2106    
2107  C<< Tracer::CGITrace($cgi); >>  C<< ETracing($parameter); >>
2108    
2109  Set up tracing for a CGI script. See L</ScriptSetup> for more information.  Set up emergency tracing. Emergency tracing is tracing that is turned
2110    on automatically for any program that calls this method. The emergency
2111    tracing parameters are stored in a a file identified by a tracing key.
2112    If this method is called with a CGI object, then the tracing key is
2113    taken from a cookie. If it is called with no parameters, then the tracing
2114    key is taken from an environment variable. If it is called with a string,
2115    the tracing key is that string.
2116    
2117  =over 4  =over 4
2118    
2119  =item cgi  =item parameter
2120    
2121  Ths CGI query object for this script.  A parameter from which the tracing key is computed. If it is a scalar,
2122    that scalar is used as the tracing key. If it is a CGI object, the
2123    tracing key is taken from the C<IP> cookie. If it is omitted, the
2124    tracing key is taken from the C<TRACING> environment variable. If it
2125    is a CGI object and emergency tracing is not on, the C<Trace> and
2126    C<TF> parameters will be used to determine the type of tracing.
2127    
2128  =back  =back
2129    
2130  =cut  =cut
2131    
2132  sub CGITrace {  sub ETracing {
2133      # Get the parameters.      # Get the parameter.
2134      my ($cgi) = @_;      my ($parameter) = @_;
2135        # Check for CGI mode.
2136        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2137      # Default to no tracing except errors.      # Default to no tracing except errors.
2138      my ($tracing, $dest) = ("0", "WARN");      my ($tracing, $dest) = ("0", "WARN");
2139      # Check for emergency tracing.      # Check for emergency tracing.
2140      my $ip = EmergencyIP($cgi);      my $tkey = EmergencyKey($parameter);
2141      my $emergencyFile = EmergencyFileName($ip);      my $emergencyFile = EmergencyFileName($tkey);
2142      if (-e $emergencyFile) {      if (-e $emergencyFile) {
2143          # We have the file. Read in the data.          # We have the file. Read in the data.
2144          my @tracing = GetFile($emergencyFile);          my @tracing = GetFile($emergencyFile);
# Line 1987  Line 2159 
2159              my $level = shift @tracing;              my $level = shift @tracing;
2160              # Convert the destination to a real tracing destination.              # Convert the destination to a real tracing destination.
2161              # temp directory.              # temp directory.
2162              $dest = EmergencyTracingDest($ip, $dest);              $dest = EmergencyTracingDest($tkey, $dest);
2163              # Insure Tracer is specified.              # Insure Tracer is specified.
2164              my %moduleHash = map { $_ => 1 } @tracing;              my %moduleHash = map { $_ => 1 } @tracing;
2165              $moduleHash{Tracer} = 1;              $moduleHash{Tracer} = 1;
2166              # Set the trace parameter.              # Set the trace parameter.
2167              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
             # Make sure the script knows tracing is on.  
             $cgi->param(-name => 'Trace', -value => $tracing);  
             $cgi->param(-name => 'TF', -value => (($dest =~ /^>/) ? 1 : 0));  
2168          }          }
2169      } elsif ($cgi->param('Trace')) {      } elsif (defined $cgi) {
2170            # There's no emergency tracing, but we have a CGI object, so check
2171            # for tracing from the form parameters.
2172            if ($cgi->param('Trace')) {
2173          # Here the user has requested tracing via a form.          # Here the user has requested tracing via a form.
2174          $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");          $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2175          $tracing = $cgi->param('Trace') . " Tracer";          $tracing = $cgi->param('Trace') . " Tracer";
2176      }      }
2177        }
2178      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
2179      TSetup($tracing, $dest);      TSetup($tracing, $dest);
2180      # Trace the parameter and environment data.      # If we're a web script, trace the parameter and environment data.
2181        if (defined $cgi) {
2182      TraceParms($cgi);      TraceParms($cgi);
2183  }  }
2184    }
2185    
2186  =head3 EmergencyFileName  =head3 EmergencyFileName
2187    
2188  C<< my $fileName = Tracer::EmergencyFileName($ip); >>  C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2189    
2190  Return the emergency tracing file name. This is the file that specifies  Return the emergency tracing file name. This is the file that specifies
2191  the tracing information.  the tracing information.
2192    
2193  =over 4  =over 4
2194    
2195  =item ip  =item tkey
2196    
2197  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for the current program.
 method.  
2198    
2199  =item RETURN  =item RETURN
2200    
# Line 2032  Line 2206 
2206    
2207  sub EmergencyFileName {  sub EmergencyFileName {
2208      # Get the parameters.      # Get the parameters.
2209      my ($ip) = @_;      my ($tkey) = @_;
2210      # Compute the emergency tracing file name.      # Compute the emergency tracing file name.
2211      return "$FIG_Config::temp/Emergency$ip.txt";      return "$FIG_Config::temp/Emergency$tkey.txt";
2212  }  }
2213    
2214  =head3 EmergencyFileTarget  =head3 EmergencyFileTarget
2215    
2216  C<< my $fileName = Tracer::EmergencyFileTarget($ip); >>  C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2217    
2218  Return the emergency tracing target file name. This is the file that receives  Return the emergency tracing target file name. This is the file that receives
2219  the tracing output for file-based tracing.  the tracing output for file-based tracing.
2220    
2221  =over 4  =over 4
2222    
2223  =item ip  =item tkey
2224    
2225  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for the current program.
 method.  
2226    
2227  =item RETURN  =item RETURN
2228    
2229  Returns the name of the file to contain the emergency tracing information.  Returns the name of the file to contain the trace output.
2230    
2231  =back  =back
2232    
# Line 2061  Line 2234 
2234    
2235  sub EmergencyFileTarget {  sub EmergencyFileTarget {
2236      # Get the parameters.      # Get the parameters.
2237      my ($ip) = @_;      my ($tkey) = @_;
2238      # Compute the emergency tracing file name.      # Compute the emergency tracing file name.
2239      return "$FIG_Config::temp/Emergency$ip.log";      return "$FIG_Config::temp/trace$tkey.log";
2240  }  }
2241    
2242  =head3 EmergencyTracingDest  =head3 EmergencyTracingDest
2243    
2244  C<< my $dest = Tracer::EmergencyTracingDest($ip, $myDest); >>  C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2245    
2246  This method converts an emergency tracing destination to a real  This method converts an emergency tracing destination to a real
2247  tracing destination. The main difference is that if the  tracing destination. The main difference is that if the
# Line 2077  Line 2250 
2250    
2251  =over 4  =over 4
2252    
2253  =item ip  =item tkey
2254    
2255  IP address of the user who wants tracing, as taken from the C<< $cgi->remote_host() >>  Tracing key for this environment.
 method.  
2256    
2257  =item myDest  =item myDest
2258    
# Line 2096  Line 2268 
2268    
2269  sub EmergencyTracingDest {  sub EmergencyTracingDest {
2270      # Get the parameters.      # Get the parameters.
2271      my ($ip, $myDest) = @_;      my ($tkey, $myDest) = @_;
2272      # Declare the return variable.      # Declare the return variable.
2273      my $retVal;      my $retVal;
2274      # Process according to the destination value.      # Process according to the destination value.
2275      if ($myDest eq 'FILE') {      if ($myDest eq 'FILE') {
2276          $retVal = ">" . EmergencyFileTarget($ip);          $retVal = ">" . EmergencyFileTarget($tkey);
2277      } elsif ($myDest eq 'APPEND') {      } elsif ($myDest eq 'APPEND') {
2278          $retVal = ">>" . EmergencyFileTarget($ip);          $retVal = ">>" . EmergencyFileTarget($tkey);
2279      } else {      } else {
2280          $retVal = $myDest;          $retVal = $myDest;
2281      }      }
# Line 2113  Line 2285 
2285    
2286  =head3 Emergency  =head3 Emergency
2287    
2288  C<< Emergency($cgi, $hours, $dest, $level, @modules); >>  C<< Emergency($key, $hours, $dest, $level, @modules); >>
2289    
2290  Turn on emergency tracing. This method can only be invoked over the web and is  Turn on emergency tracing. This method can only be invoked over the web and is
2291  should not be called if debug mode is off. The caller specifies the duration of the  should not be called if debug mode is off. The caller specifies the duration of the
2292  emergency in hours, the desired tracing destination, the trace level,  emergency in hours, the desired tracing destination, the trace level,
2293  and a list of the trace modules to activate. For the duration, when a user  and a list of the trace modules to activate. For the length of the duration, when a
2294  from the specified remote web location invokes a Sprout CGI script, tracing  program in an environment with the specified tracing key active invokes a Sprout
2295  will be turned on automatically. See L</TSetup> for more about tracing  CGI script, tracing will be turned on automatically. See L</TSetup> for more
2296  setup and L</ScriptSetup> for more about emergency tracing.  about tracing setup and L</ETracing> for more about emergency tracing.
2297    
2298  =over 4  =over 4
2299    
2300  =item cgi  =item tkey
2301    
2302  A CGI query object.  The tracing key. This is used to identify the control file and the trace file.
2303    
2304  =item hours  =item hours
2305    
# Line 2152  Line 2324 
2324    
2325  sub Emergency {  sub Emergency {
2326      # Get the parameters.      # Get the parameters.
2327      my ($cgi, $hours, $dest, $level, @modules) = @_;      my ($tkey, $hours, $dest, $level, @modules) = @_;
     # Get the IP address.  
     my $ip = EmergencyIP($cgi);  
2328      # Create the emergency file.      # Create the emergency file.
2329      my $specFile = EmergencyFileName($ip);      my $specFile = EmergencyFileName($tkey);
2330      my $outHandle = Open(undef, ">$specFile");      my $outHandle = Open(undef, ">$specFile");
2331      print $outHandle join("\n", $hours, $dest, $level, @modules, "");      print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2332  }  }
2333    
2334  =head3 EmergencyIP  =head3 EmergencyKey
2335    
2336  C<< my $ip = EmergencyIP($cgi); >>  C<< my $tkey = EmergencyKey($parameter); >>
2337    
2338  Return the IP address to be used for emergency tracing. In actual fact, this is not an  Return the Key to be used for emergency tracing. This could be an IP address,
2339  IP address but a session ID stored in a cookie. It used to be an IP address, but those   a session ID, or a user name, depending on the environment.
 are too fluid.  
2340    
2341  =over 4  =over 4
2342    
2343  =item cgi  =item parameter
2344    
2345  CGI query object.  Parameter defining the method for finding the tracing key. If it is a scalar,
2346    then it is presumed to be the tracing key itself. If it is a CGI object, then
2347    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2348    taken from the C<TRACING> environment variable.
2349    
2350  =item RETURN  =item RETURN
2351    
2352  Returns the IP address to be used for labelling emergency tracing.  Returns the key to be used for labels in emergency tracing.
2353    
2354  =back  =back
2355    
2356  =cut  =cut
2357    
2358  sub EmergencyIP {  sub EmergencyKey {
2359      # Get the parameters.      # Get the parameters.
2360      my ($cgi) = @_;      my ($parameter) = @_;
2361      # Look for a cookie.      # Declare the return variable.
2362      my $retVal = $cgi->cookie('IP');      my $retVal;
2363      # If no cookie, return the remote host address. This will probably not      # Determine the parameter type.
2364      # work, but that's okay, since the lack of a cookie means the      if (! defined $parameter) {
2365      # tracing is not turned on.          # Here we're supposed to check the environment.
2366      $retVal = $cgi->remote_host() if ! $retVal;          $retVal = $ENV{TRACING};
2367        } else {
2368            my $ptype = ref $parameter;
2369            if ($ptype eq 'CGI') {
2370                # Here we were invoked from a web page. Look for a cookie.
2371                $retVal = $parameter->cookie('IP');
2372            } elsif (! $ptype) {
2373                # Here the key was passed in.
2374                $retVal = $parameter;
2375            }
2376        }
2377        # If no luck finding a key, use the PID.
2378        if (! defined $retVal) {
2379            $retVal = $$;
2380        }
2381      # Return the result.      # Return the result.
2382      return $retVal;      return $retVal;
2383  }  }

Legend:
Removed from v.1.71  
changed lines
  Added in v.1.72

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3