[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.39, Fri Feb 24 19:45:29 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 ScriptSetup ScriptFinish Insure);      @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);
26      use CGI;      use CGI;
27        use Cwd;
28      use FIG_Config;      use FIG_Config;
29      use PageBuilder;      use PageBuilder;
30      use Digest::MD5;      use Digest::MD5;
31      use File::Basename;      use File::Basename;
32      use File::Path;      use File::Path;
33        use File::stat;
34        use LWP::UserAgent;
35        use Time::HiRes 'gettimeofday';
36        use URI::Escape;
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 56  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  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
75  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
76    L</Emergency Tracing> easier to understand.
77    
78    To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
79    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 116  Line 144 
144    
145  =back  =back
146    
147    The format of trace messages is important because some utilities analyze trace files.
148    There are three fields-- the time stamp, the category name, and the text.
149    The time stamp is between square brackets and the category name between angle brackets.
150    After the category name there is a colon (C<:>) followed by the message text.
151    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    
281  # Declare the configuration variables.  # Declare the configuration variables.
# Line 195  Line 355 
355          }          }
356          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
357              open TRACEFILE, $target;              open TRACEFILE, $target;
358              print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
359              close TRACEFILE;              close TRACEFILE;
360              $Destination = ">$target";              $Destination = ">$target";
361          } else {          } else {
# Line 228  Line 388 
388      ["Sprout", "SproutLoad", "ERDB"]      ["Sprout", "SproutLoad", "ERDB"]
389    
390  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
391  the output. There are threer special tracing categories that are automatically  the output. There are two special tracing categories that are automatically
392  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
393  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
394  on automatically.  on automatically.
395    
396  =over 4  =over 4
397    
 =item FIG  
   
 Turns on trace messages inside the B<FIG> package.  
   
398  =item SQL  =item SQL
399    
400  Traces SQL commands and activity.  Traces SQL commands and activity.
# Line 275  Line 431 
431  of a keyword, the value is separated from the option name by an equal sign. You  of a keyword, the value is separated from the option name by an equal sign. You
432  can see this last in the command-line example above.  can see this last in the command-line example above.
433    
434    You can specify a different default trace level by setting C<$options->{trace}>
435    prior to calling this method.
436    
437  An example at this point would help. Consider, for example, the command-line utility  An example at this point would help. Consider, for example, the command-line utility
438  C<TransactFeatures>. It accepts a list of positional parameters plus the options  C<TransactFeatures>. It accepts a list of positional parameters plus the options
439  C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute  C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
# Line 300  Line 459 
459  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
460  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
461  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
462  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,
463  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
464  to this method. The I<$options> hash would be  to this method. The I<$options> hash would be
465    
# Line 314  Line 473 
473  need to be added in the future, they can be processed by this method without  need to be added in the future, they can be processed by this method without
474  upsetting the command-line utilities.  upsetting the command-line utilities.
475    
476    If the C<background> option is specified on the command line, then the
477    standard and error outputs will be directed to files in the temporary
478    directory, using the same suffix as the trace file. So, if the command
479    line specified
480    
481        -user=Bruce -background
482    
483    then the trace output would go to C<traceBruce.log>, the standard output to
484    C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
485    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 323  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
506          -start    start with this genome          -start    start with this genome
507          -tblFiles output TBL files containing the corrected IDs          -tblFiles output TBL files containing the corrected IDs
508    
509    The caller has the option of modifying the tracing scheme by placing a value
510    for C<trace> in the incoming options hash. The default value can be overridden,
511    or the tracing to the standard output can be turned off by suffixing a minus
512    sign to the trace level. So, for example,
513    
514        { trace => [0, "tracing level (default 0)"],
515           ...
516    
517    would set the default trace level to 0 instead of E, while
518    
519        { trace => ["2-", "tracing level (default 2)"],
520           ...
521    
522    would set the default to 2, but trace only to the log file, not to the
523    standard output.
524    
525  The parameters to this method are as follows.  The parameters to this method are as follows.
526    
527  =over 4  =over 4
# Line 347  Line 539 
539  by specifying the options as command-line switches prefixed by a hyphen.  by specifying the options as command-line switches prefixed by a hyphen.
540  Tracing-related options may be added to this hash. If the C<-h> option is  Tracing-related options may be added to this hash. If the C<-h> option is
541  specified on the command line, the option descriptions will be used to  specified on the command line, the option descriptions will be used to
542  explain the options.  explain the options. To turn off tracing to the standard output, add a
543    minus sign to the value for C<trace> (see above).
544    
545  =item parmHelp  =item parmHelp
546    
547  A string that vaguely describes the positional parameters. This is used  A string that vaguely describes the positional parameters. This is used
548  if the user specifies the C<-h> option.  if the user specifies the C<-h> option.
549    
550  =item ARGV  =item argv
551    
552  List of command line parameters, including the option switches, which must  List of command line parameters, including the option switches, which must
553  precede the positional parameters and be prefixed by a hyphen.  precede the positional parameters and be prefixed by a hyphen.
# Line 373  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      $options->{trace} = [2, "tracing level"];      if (! exists $options->{trace}) {
573            $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"];
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
581      # and the description. While we're at it, we'll memorize the      # and the description. While we're at it, we'll memorize the
# Line 392  Line 590 
590      }      }
591      # Parse the command line.      # Parse the command line.
592      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
593      # Now we want to set up tracing. First, we need to know if SQL is to      # Get the logfile suffix.
594      # be traced.      my $suffix = $retOptions->{user};
595        # Check for background mode.
596        if ($retOptions->{background}) {
597            my $outFileName = "$FIG_Config::temp/out$suffix.log";
598            my $errFileName = "$FIG_Config::temp/err$suffix.log";
599            open STDOUT, ">$outFileName";
600            open STDERR, ">$errFileName";
601        }
602        # Now we want to set up tracing. First, we need to know if the user
603        # 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";
611      }      }
612      # Add the default categories.      # Add the default categories.
613      push @cats, "Tracer", "FIG";          push @cats, "Tracer";
614      # Next, we create the category string by prefixing the trace level          # Next, we create the category string by joining the categories.
615      # and joining the categories.          my $cats = join(" ", @cats);
616      my $cats = join(" ", $parseOptions{trace}, @cats);          # Check to determine whether or not the caller wants to turn off tracing
617            # to the standard output.
618            my $traceLevel = $retOptions->{trace};
619            my $textOKFlag = 1;
620            if ($traceLevel =~ /^(.)-/) {
621                $traceLevel = $1;
622                $textOKFlag = 0;
623            }
624            # Now we set up the trace mode.
625            my $traceMode;
626            # Verify that we can open a file in the FIG temporary directory.
627            my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
628            if (open TESTTRACE, ">$traceFileName") {
629                # Here we can trace to a file.
630                $traceMode = ">$traceFileName";
631                if ($textOKFlag) {
632                    # Echo to standard output if the text-OK flag is set.
633                    $traceMode = "+$traceMode";
634                }
635                # Close the test file.
636                close TESTTRACE;
637            } else {
638                # Here we can't trace to a file. We trace to the standard output if it's
639                # okay, and the error log otherwise.
640                if ($textOKFlag) {
641                    $traceMode = "TEXT";
642                } else {
643                    $traceMode = "WARN";
644                }
645            }
646      # Now set up the tracing.      # Now set up the tracing.
647      my $suffix = $retOptions->{user};          TSetup("$traceLevel $cats", $traceMode);
648      TSetup($cats, "+>$FIG_Config::temp/trace$suffix.log");      }
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}) {
652          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
653          Trace("$1 [options] $parmHelp") if T(0);          print "$1 [options] $parmHelp\n";
654          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
655              my $name = Pad($key, $longestName, 0, ' ');              my $name = Pad($key, $longestName, 0, ' ');
656              my $desc = $options->{$key}->[1];              my $desc = $options->{$key}->[1];
657              if ($options->{$key}->[0]) {              if ($options->{$key}->[0]) {
658                  $desc .= " (default " . $options->{$key}->[0] . ")";                  $desc .= " (default " . $options->{$key}->[0] . ")";
659              }              }
660              Trace("  $name $desc") if T(0);              print "  $name $desc\n";
661          }          }
662          exit(0);          exit(0);
663      }      }
# Line 893  Line 1133 
1133      # Get the timestamp.      # Get the timestamp.
1134      my $timeStamp = Now();      my $timeStamp = Now();
1135      # 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.
1136      my $formatted = "$timeStamp <$LastCategory>: " . Strip($message);      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);
1137      # Process according to the destination.      # Process according to the destination.
1138      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1139          # Write the message to the standard output.          # Write the message to the standard output.
# Line 1275  Line 1515 
1515      return @inputList;      return @inputList;
1516  }  }
1517    
1518    =head3 Percent
1519    
1520    C<< my $percent = Tracer::Percent($number, $base); >>
1521    
1522    Returns the percent of the base represented by the given number. If the base
1523    is zero, returns zero.
1524    
1525    =over 4
1526    
1527    =item number
1528    
1529    Percent numerator.
1530    
1531    =item base
1532    
1533    Percent base.
1534    
1535    =item RETURN
1536    
1537    Returns the percentage of the base represented by the numerator.
1538    
1539    =back
1540    
1541    =cut
1542    
1543    sub Percent {
1544        # Get the parameters.
1545        my ($number, $base) = @_;
1546        # Declare the return variable.
1547        my $retVal = 0;
1548        # Compute the percent.
1549        if ($base != 0) {
1550            $retVal = $number * 100 / $base;
1551        }
1552        # Return the result.
1553        return $retVal;
1554    }
1555    
1556  =head3 GetFile  =head3 GetFile
1557    
1558  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
# Line 1308  Line 1586 
1586      # Declare the return variable.      # Declare the return variable.
1587      my @retVal = ();      my @retVal = ();
1588      # Open the file for input.      # Open the file for input.
1589      my $ok = open INPUTFILE, "<$fileName";      my $handle = Open(undef, "<$fileName");
     if (!$ok) {  
         # If we had an error, trace it. We will automatically return a null value.  
         Trace("Could not open \"$fileName\" for input: $!") if T(0);  
     } else {  
1590          # Read the whole file into the return variable, stripping off any terminator          # Read the whole file into the return variable, stripping off any terminator
1591          # characters.          # characters.
1592          my $lineCount = 0;          my $lineCount = 0;
1593          while (my $line = <INPUTFILE>) {      while (my $line = <$handle>) {
1594              $lineCount++;              $lineCount++;
1595              $line = Strip($line);              $line = Strip($line);
1596              push @retVal, $line;              push @retVal, $line;
1597          }          }
1598          # Close it.          # Close it.
1599          close INPUTFILE;      close $handle;
1600          my $actualLines = @retVal;          my $actualLines = @retVal;
     }  
1601      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
1602      if (wantarray) {      if (wantarray) {
1603          return @retVal;          return @retVal;
# Line 1333  Line 1606 
1606      }      }
1607  }  }
1608    
1609    =head3 PutFile
1610    
1611    C<< Tracer::PutFile($fileName, \@lines); >>
1612    
1613    Write out a file from a list of lines of text.
1614    
1615    =over 4
1616    
1617    =item fileName
1618    
1619    Name of the output file.
1620    
1621    =item lines
1622    
1623    Reference to a list of text lines. The lines will be written to the file in order, with trailing
1624    new-line characters. Alternatively, may be a string, in which case the string will be written without
1625    modification.
1626    
1627    =back
1628    
1629    =cut
1630    
1631    sub PutFile {
1632        # Get the parameters.
1633        my ($fileName, $lines) = @_;
1634        # Open the output file.
1635        my $handle = Open(undef, ">$fileName");
1636        if (ref $lines ne 'ARRAY') {
1637            # Here we have a scalar, so we write it raw.
1638            print $handle $lines;
1639        } else {
1640            # Write the lines one at a time.
1641            for my $line (@{$lines}) {
1642                print $handle "$line\n";
1643            }
1644        }
1645        # Close the output file.
1646        close $handle;
1647    }
1648    
1649  =head3 QTrace  =head3 QTrace
1650    
1651  C<< my $data = QTrace($format); >>  C<< my $data = QTrace($format); >>
# Line 1533  Line 1846 
1846    
1847  =head3 AddToListMap  =head3 AddToListMap
1848    
1849  C<< Tracer::AddToListMap(\%hash, $key, $value); >>  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>
1850    
1851  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list  Add a key-value pair to a hash of lists. If no value exists for the key, a singleton list
1852  is created for the key. Otherwise, the new value is pushed onto the list.  is created for the key. Otherwise, the new value is pushed onto the list.
# Line 1548  Line 1861 
1861    
1862  Key for which the value is to be added.  Key for which the value is to be added.
1863    
1864  =item value  =item value1, value2, ... valueN
1865    
1866  Value to add to the key's value list.  List of values to add to the key's value list.
1867    
1868  =back  =back
1869    
# Line 1558  Line 1871 
1871    
1872  sub AddToListMap {  sub AddToListMap {
1873      # Get the parameters.      # Get the parameters.
1874      my ($hash, $key, $value) = @_;      my ($hash, $key, @values) = @_;
1875      # Process according to whether or not the key already has a value.      # Process according to whether or not the key already has a value.
1876      if (! exists $hash->{$key}) {      if (! exists $hash->{$key}) {
1877          $hash->{$key} = [$value];          $hash->{$key} = [@values];
1878      } else {      } else {
1879          push @{$hash->{$key}}, $value;          push @{$hash->{$key}}, @values;
1880      }      }
1881  }  }
1882    
# Line 1571  Line 1884 
1884    
1885  C<< if (Tracer::DebugMode) { ...code... } >>  C<< if (Tracer::DebugMode) { ...code... } >>
1886    
1887  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.  
1888    
1889  Certain CGI scripts are too dangerous to exist in the production  Certain CGI scripts are too dangerous to exist in the production
1890  environment. This method provides a simple way to prevent them  environment. This method provides a simple way to prevent them
1891  from working unless they are explicitly turned on by creating a password  from working unless they are explicitly turned on by creating a password
1892  cookie via the B<SetPassword> script.  If debugging mode  cookie via the B<SetPassword> script.  If debugging mode
1893  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.  
1894    
1895  =cut  =cut
1896    
# Line 1592  Line 1903 
1903      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {      if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1904          $retVal = 1;          $retVal = 1;
1905      } else {      } else {
1906          # Here debug mode is off, so we generate an error page.          # Here debug mode is off, so we generate an error.
1907          my $pageString = PageBuilder::Build("<Html/ErrorPage.html", {}, "Html");          Confess("Cannot use this facility without logging in.");
         print $pageString;  
1908      }      }
1909      # Return the determination indicator.      # Return the determination indicator.
1910      return $retVal;      return $retVal;
# Line 1746  Line 2056 
2056    
2057  =head3 ScriptSetup  =head3 ScriptSetup
2058    
2059  C<< my ($query, $varHash) = ScriptSetup(); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2060    
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> and C<FIG>) 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. 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
2068  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
2069    L</ScriptFinish> to output the web page.
2070    
2071    In some situations, it is not practical to invoke tracing via form parameters. For this
2072    situation, you can turn on emergency tracing from the debugging control panel.
2073    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2074    method, which includes every program that uses this method or L</StandardSetup>.
2075    
2076    =over 4
2077    
2078    =item noTrace (optional)
2079    
2080    If specified, tracing will be suppressed. This is useful if the script wants to set up
2081    tracing manually.
2082    
2083    =item RETURN
2084    
2085    Returns a two-element list consisting of a CGI query object and a variable hash for
2086    the output page.
2087    
2088    =back
2089    
2090  =cut  =cut
2091    
2092  sub ScriptSetup {  sub ScriptSetup {
2093        # Get the parameters.
2094        my ($noTrace) = @_;
2095      # Get the CGI query object.      # Get the CGI query object.
2096      my $query = CGI->new();      my $cgi = CGI->new();
2097      # Check for tracing. Set it up if the user asked for it.      # Set up tracing if it's not suppressed.
2098      if ($query->param('Trace')) {      ETracing($cgi) unless $noTrace;
2099          # Set up tracing to be queued for display at the bottom of the web page.      # Create the variable hash.
2100          TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");      my $varHash = { results => '' };
2101          # Trace the parameter and environment data.      # Return the query object and variable hash.
2102        return ($cgi, $varHash);
2103    }
2104    
2105    =head3 ETracing
2106    
2107    C<< ETracing($parameter); >>
2108    
2109    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
2118    
2119    =item parameter
2120    
2121    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
2129    
2130    =cut
2131    
2132    sub ETracing {
2133        # Get the parameter.
2134        my ($parameter) = @_;
2135        # Check for CGI mode.
2136        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2137        # Default to no tracing except errors.
2138        my ($tracing, $dest) = ("0", "WARN");
2139        # Check for emergency tracing.
2140        my $tkey = EmergencyKey($parameter);
2141        my $emergencyFile = EmergencyFileName($tkey);
2142        if (-e $emergencyFile) {
2143            # We have the file. Read in the data.
2144            my @tracing = GetFile($emergencyFile);
2145            # Pull off the time limit.
2146            my $expire = shift @tracing;
2147            # Convert it to seconds.
2148            $expire *= 3600;
2149            # Check the file data.
2150            my $stat = stat($emergencyFile);
2151            my ($now) = gettimeofday;
2152            if ($now - $stat->mtime > $expire) {
2153                # Delete the expired file.
2154                unlink $emergencyFile;
2155            } else {
2156                # Emergency tracing is on. Pull off the destination and
2157                # the trace level;
2158                $dest = shift @tracing;
2159                my $level = shift @tracing;
2160                # Convert the destination to a real tracing destination.
2161                # temp directory.
2162                $dest = EmergencyTracingDest($tkey, $dest);
2163                # Insure Tracer is specified.
2164                my %moduleHash = map { $_ => 1 } @tracing;
2165                $moduleHash{Tracer} = 1;
2166                # Set the trace parameter.
2167                $tracing = join(" ", $level, sort keys %moduleHash);
2168            }
2169        } 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.
2174                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2175                $tracing = $cgi->param('Trace') . " Tracer";
2176            }
2177        }
2178        # Setup the tracing we've determined from all the stuff above.
2179        TSetup($tracing, $dest);
2180        # If we're a web script, trace the parameter and environment data.
2181        if (defined $cgi) {
2182            TraceParms($cgi);
2183        }
2184    }
2185    
2186    =head3 EmergencyFileName
2187    
2188    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2189    
2190    Return the emergency tracing file name. This is the file that specifies
2191    the tracing information.
2192    
2193    =over 4
2194    
2195    =item tkey
2196    
2197    Tracing key for the current program.
2198    
2199    =item RETURN
2200    
2201    Returns the name of the file to contain the emergency tracing information.
2202    
2203    =back
2204    
2205    =cut
2206    
2207    sub EmergencyFileName {
2208        # Get the parameters.
2209        my ($tkey) = @_;
2210        # Compute the emergency tracing file name.
2211        return "$FIG_Config::temp/Emergency$tkey.txt";
2212    }
2213    
2214    =head3 EmergencyFileTarget
2215    
2216    C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2217    
2218    Return the emergency tracing target file name. This is the file that receives
2219    the tracing output for file-based tracing.
2220    
2221    =over 4
2222    
2223    =item tkey
2224    
2225    Tracing key for the current program.
2226    
2227    =item RETURN
2228    
2229    Returns the name of the file to contain the trace output.
2230    
2231    =back
2232    
2233    =cut
2234    
2235    sub EmergencyFileTarget {
2236        # Get the parameters.
2237        my ($tkey) = @_;
2238        # Compute the emergency tracing file name.
2239        return "$FIG_Config::temp/trace$tkey.log";
2240    }
2241    
2242    =head3 EmergencyTracingDest
2243    
2244    C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2245    
2246    This method converts an emergency tracing destination to a real
2247    tracing destination. The main difference is that if the
2248    destination is C<FILE> or C<APPEND>, we convert it to file
2249    output.
2250    
2251    =over 4
2252    
2253    =item tkey
2254    
2255    Tracing key for this environment.
2256    
2257    =item myDest
2258    
2259    Destination from the emergency tracing file.
2260    
2261    =item RETURN
2262    
2263    Returns a destination that can be passed into L</TSetup>.
2264    
2265    =back
2266    
2267    =cut
2268    
2269    sub EmergencyTracingDest {
2270        # Get the parameters.
2271        my ($tkey, $myDest) = @_;
2272        # Declare the return variable.
2273        my $retVal;
2274        # Process according to the destination value.
2275        if ($myDest eq 'FILE') {
2276            $retVal = ">" . EmergencyFileTarget($tkey);
2277        } elsif ($myDest eq 'APPEND') {
2278            $retVal = ">>" . EmergencyFileTarget($tkey);
2279        } else {
2280            $retVal = $myDest;
2281        }
2282        # Return the result.
2283        return $retVal;
2284    }
2285    
2286    =head3 Emergency
2287    
2288    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2289    
2290    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
2292    emergency in hours, the desired tracing destination, the trace level,
2293    and a list of the trace modules to activate. For the length of the duration, when a
2294    program in an environment with the specified tracing key active invokes a Sprout
2295    CGI script, tracing will be turned on automatically. See L</TSetup> for more
2296    about tracing setup and L</ETracing> for more about emergency tracing.
2297    
2298    =over 4
2299    
2300    =item tkey
2301    
2302    The tracing key. This is used to identify the control file and the trace file.
2303    
2304    =item hours
2305    
2306    Number of hours to keep emergency tracing alive.
2307    
2308    =item dest
2309    
2310    Tracing destination. If no path information is specified for a file
2311    destination, it is put in the FIG temporary directory.
2312    
2313    =item level
2314    
2315    Tracing level. A higher level means more trace messages.
2316    
2317    =item modules
2318    
2319    A list of the tracing modules to activate.
2320    
2321    =back
2322    
2323    =cut
2324    
2325    sub Emergency {
2326        # Get the parameters.
2327        my ($tkey, $hours, $dest, $level, @modules) = @_;
2328        # Create the emergency file.
2329        my $specFile = EmergencyFileName($tkey);
2330        my $outHandle = Open(undef, ">$specFile");
2331        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2332    }
2333    
2334    =head3 EmergencyKey
2335    
2336    C<< my $tkey = EmergencyKey($parameter); >>
2337    
2338    Return the Key to be used for emergency tracing. This could be an IP address,
2339     a session ID, or a user name, depending on the environment.
2340    
2341    =over 4
2342    
2343    =item parameter
2344    
2345    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
2351    
2352    Returns the key to be used for labels in emergency tracing.
2353    
2354    =back
2355    
2356    =cut
2357    
2358    sub EmergencyKey {
2359        # Get the parameters.
2360        my ($parameter) = @_;
2361        # Declare the return variable.
2362        my $retVal;
2363        # Determine the parameter type.
2364        if (! defined $parameter) {
2365            # Here we're supposed to check the environment.
2366            $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.
2382        return $retVal;
2383    }
2384    
2385    
2386    =head3 TraceParms
2387    
2388    C<< Tracer::TraceParms($cgi); >>
2389    
2390    Trace the CGI parameters at trace level CGI => 3 and the environment variables
2391    at level CGI => 4.
2392    
2393    =over 4
2394    
2395    =item cgi
2396    
2397    CGI query object containing the parameters to trace.
2398    
2399    =back
2400    
2401    =cut
2402    
2403    sub TraceParms {
2404        # Get the parameters.
2405        my ($cgi) = @_;
2406          if (T(CGI => 3)) {          if (T(CGI => 3)) {
2407              # Here we want to trace the parameter data.              # Here we want to trace the parameter data.
2408              my @names = $query->param;          my @names = $cgi->param;
2409              for my $parmName (sort @names) {              for my $parmName (sort @names) {
2410                  # Note we skip "Trace", which is for our use only.              # Note we skip the Trace parameters, which are for our use only.
2411                  if ($parmName ne 'Trace') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
2412                      my @values = $query->param($parmName);                  my @values = $cgi->param($parmName);
2413                      Trace("CGI: $parmName = " . join(", ", @values));                      Trace("CGI: $parmName = " . join(", ", @values));
2414                  }                  }
2415              }              }
2416            # Display the request method.
2417            my $method = $cgi->request_method();
2418            Trace("Method: $method");
2419          }          }
2420          if (T(CGI => 4)) {          if (T(CGI => 4)) {
2421              # Here we want the environment data too.              # Here we want the environment data too.
# Line 1784  Line 2423 
2423                  Trace("ENV: $envName = $ENV{$envName}");                  Trace("ENV: $envName = $ENV{$envName}");
2424              }              }
2425          }          }
     } else {  
         # Here tracing is to be turned off. All we allow is errors traced into the  
         # error log.  
         TSetup("0", "WARN");  
     }  
     # Create the variable hash.  
     my $varHash = { DebugData => '' };  
     # If we're in DEBUG mode, set up the debug mode data for forms.  
     if (Tracer::DebugMode) {  
         $varHash->{DebugData} = GetFile("Html/DebugFragment.html");  
     }  
     # Return the query object and variable hash.  
     return ($query, $varHash);  
2426  }  }
2427    
2428  =head3 ScriptFinish  =head3 ScriptFinish
# Line 1823  Line 2449 
2449      use FIG;      use FIG;
2450      # ... more uses ...      # ... more uses ...
2451    
2452      my ($query, $varHash) = ScriptSetup();      my ($cgi, $varHash) = ScriptSetup();
2453      eval {      eval {
2454          # ... get data from $query, put it in $varHash ...          # ... get data from $cgi, put it in $varHash ...
2455      };      };
2456      if ($@) {      if ($@) {
2457          Trace("Script Error: $@") if T(0);          Trace("Script Error: $@") if T(0);
# Line 1860  Line 2486 
2486      # Check for a template file situation.      # Check for a template file situation.
2487      my $outputString;      my $outputString;
2488      if (defined $varHash) {      if (defined $varHash) {
2489          # Here we have a template file. We need to apply the variables to the template.          # Here we have a template file. We need to determine the template type.
2490          $outputString = PageBuilder::Build("<$webData", $varHash, "Html");          my $template;
2491            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
2492                $template = "$FIG_Config::template_url/$webData";
2493            } else {
2494                $template = "<<$webData";
2495            }
2496            $outputString = PageBuilder::Build($template, $varHash, "Html");
2497      } else {      } else {
2498          # Here the user gave us a raw string.          # Here the user gave us a raw string.
2499          $outputString = $webData;          $outputString = $webData;
2500      }      }
2501      # Check for trace messages.      # Check for trace messages.
2502      if ($Destination eq "QUEUE") {      if ($Destination ne "NONE" && $TraceLevel > 0) {
2503          # 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
2504          # 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
2505          # end-tag.          # end-tag.
# Line 1875  Line 2507 
2507          if ($outputString =~ m#</body>#gi) {          if ($outputString =~ m#</body>#gi) {
2508              $pos = (pos $outputString) - 7;              $pos = (pos $outputString) - 7;
2509          }          }
2510          substr $outputString, $pos, 0, QTrace('Html');          # If the trace messages were queued, we unroll them. Otherwise, we display the
2511            # destination.
2512            my $traceHtml;
2513            if ($Destination eq "QUEUE") {
2514                $traceHtml = QTrace('Html');
2515            } elsif ($Destination =~ /^>>(.+)$/) {
2516                # Here the tracing output it to a file. We code it as a hyperlink so the user
2517                # can copy the file name into the clipboard easily.
2518                my $actualDest = $1;
2519                $traceHtml = "<p>Tracing output to <a href=\"$actualDest\">$actualDest</a>.</p>\n";
2520            } else {
2521                # Here we have one of the special destinations.
2522                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2523            }
2524            substr $outputString, $pos, 0, $traceHtml;
2525      }      }
2526      # Write the output string.      # Write the output string.
2527      print $outputString;      print $outputString;
# Line 1901  Line 2547 
2547      my ($dirName) = @_;      my ($dirName) = @_;
2548      if (! -d $dirName) {      if (! -d $dirName) {
2549          Trace("Creating $dirName directory.") if T(2);          Trace("Creating $dirName directory.") if T(2);
2550          mkpath $dirName;          eval { mkpath $dirName; };
2551            if ($@) {
2552                Confess("Error creating $dirName: $@");
2553            }
2554        }
2555    }
2556    
2557    =head3 ChDir
2558    
2559    C<< ChDir($dirName); >>
2560    
2561    Change to the specified directory.
2562    
2563    =over 4
2564    
2565    =item dirName
2566    
2567    Name of the directory to which we want to change.
2568    
2569    =back
2570    
2571    =cut
2572    
2573    sub ChDir {
2574        my ($dirName) = @_;
2575        if (! -d $dirName) {
2576            Confess("Cannot change to directory $dirName: no such directory.");
2577        } else {
2578            Trace("Changing to directory $dirName.") if T(4);
2579            my $okFlag = chdir $dirName;
2580            if (! $okFlag) {
2581                Confess("Error switching to directory $dirName.");
2582            }
2583        }
2584    }
2585    
2586    =head3 SendSMS
2587    
2588    C<< my $msgID = Tracer::SendSMS($phoneNumber, $msg); >>
2589    
2590    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
2591    user name, password, and API ID for the relevant account in the hash reference variable
2592    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
2593    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
2594    is C<2561022>, then the FIG_Config file must contain
2595    
2596        $phone =  { user => 'BruceTheHumanPet',
2597                    password => 'silly',
2598                    api_id => '2561022' };
2599    
2600    The original purpose of this method was to insure Bruce would be notified immediately when the
2601    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
2602    when you call this method.
2603    
2604    The message ID will be returned if successful, and C<undef> if an error occurs.
2605    
2606    =over 4
2607    
2608    =item phoneNumber
2609    
2610    Phone number to receive the message, in international format. A United States phone number
2611    would be prefixed by "1". A British phone number would be prefixed by "44".
2612    
2613    =item msg
2614    
2615    Message to send to the specified phone.
2616    
2617    =item RETURN
2618    
2619    Returns the message ID if successful, and C<undef> if the message could not be sent.
2620    
2621    =back
2622    
2623    =cut
2624    
2625    sub SendSMS {
2626        # Get the parameters.
2627        my ($phoneNumber, $msg) = @_;
2628        # Declare the return variable. If we do not change it, C<undef> will be returned.
2629        my $retVal;
2630        # Only proceed if we have phone support.
2631        if (! defined $FIG_Config::phone) {
2632            Trace("Phone support not present in FIG_Config.") if T(1);
2633        } else {
2634            # Get the phone data.
2635            my $parms = $FIG_Config::phone;
2636            # Get the Clickatell URL.
2637            my $url = "http://api.clickatell.com/http/";
2638            # Create the user agent.
2639            my $ua = LWP::UserAgent->new;
2640            # Request a Clickatell session.
2641            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
2642                                         password => $parms->{password},
2643                                         api_id => $parms->{api_id},
2644                                         to => $phoneNumber,
2645                                         text => $msg});
2646            # Check for an error.
2647            if (! $resp->is_success) {
2648                Trace("Alert failed.") if T(1);
2649            } else {
2650                # Get the message ID.
2651                my $rstring = $resp->content;
2652                if ($rstring =~ /^ID:\s+(.*)$/) {
2653                    $retVal = $1;
2654                } else {
2655                    Trace("Phone attempt failed with $rstring") if T(1);
2656                }
2657            }
2658        }
2659        # Return the result.
2660        return $retVal;
2661    }
2662    
2663    =head3 CommaFormat
2664    
2665    C<< my $formatted = Tracer::CommaFormat($number); >>
2666    
2667    Insert commas into a number.
2668    
2669    =over 4
2670    
2671    =item number
2672    
2673    A sequence of digits.
2674    
2675    =item RETURN
2676    
2677    Returns the same digits with commas strategically inserted.
2678    
2679    =back
2680    
2681    =cut
2682    
2683    sub CommaFormat {
2684        # Get the parameters.
2685        my ($number) = @_;
2686        # Pad the length up to a multiple of three.
2687        my $padded = "$number";
2688        $padded = " " . $padded while length($padded) % 3 != 0;
2689        # This is a fancy PERL trick. The parentheses in the SPLIT pattern
2690        # cause the delimiters to be included in the output stream. The
2691        # GREP removes the empty strings in between the delimiters.
2692        my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
2693        # Clean out the spaces.
2694        $retVal =~ s/ //g;
2695        # Return the result.
2696        return $retVal;
2697    }
2698    =head3 SetPermissions
2699    
2700    C<< Tracer::SetPermissions($dirName, $group, $mask, %otherMasks); >>
2701    
2702    Set the permissions for a directory and all the files and folders inside it.
2703    In addition, the group ownership will be changed to the specified value.
2704    
2705    This method is more vulnerable than most to permission and compatability
2706    problems, so it does internal error recovery.
2707    
2708    =over 4
2709    
2710    =item dirName
2711    
2712    Name of the directory to process.
2713    
2714    =item group
2715    
2716    Name of the group to be assigned.
2717    
2718    =item mask
2719    
2720    Permission mask. Bits that are C<1> in this mask will be ORed into the
2721    permission bits of any file or directory that does not already have them
2722    set to 1.
2723    
2724    =item otherMasks
2725    
2726    Map of search patterns to permission masks. If a directory name matches
2727    one of the patterns, that directory and all its members and subdirectories
2728    will be assigned the new pattern. For example, the following would
2729    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2730    
2731        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2732    
2733    The list is ordered, so the following would use 0777 for C<tmp1> and
2734    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2735    
2736        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2737                                                       '^tmp' => 0666);
2738    
2739    Note that the pattern matches are all case-insensitive, and only directory
2740    names are matched, not file names.
2741    
2742    =back
2743    
2744    =cut
2745    
2746    sub SetPermissions {
2747        # Get the parameters.
2748        my ($dirName, $group, $mask, @otherMasks) = @_;
2749        # Set up for error recovery.
2750        eval {
2751            # Switch to the specified directory.
2752            ChDir($dirName);
2753            # Get the group ID.
2754            my $gid = getgrnam($group);
2755            # Get the mask for tracing.
2756            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2757            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(2);
2758            my $fixCount = 0;
2759            my $lookCount = 0;
2760            # @dirs will be a stack of directories to be processed.
2761            my @dirs = (getcwd());
2762            while (scalar(@dirs) > 0) {
2763                # Get the current directory.
2764                my $dir = pop @dirs;
2765                # Check for a match to one of the specified directory names. To do
2766                # that, we need to pull the individual part of the name off of the
2767                # whole path.
2768                my $simpleName = $dir;
2769                if ($dir =~ m!/([^/]+)$!) {
2770                    $simpleName = $1;
2771                }
2772                Trace("Simple directory name for $dir is $simpleName.") if T(4);
2773                # Search for a match.
2774                my $match = 0;
2775                my $i;
2776                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2777                    my $pattern = $otherMasks[$i];
2778                    if ($simpleName =~ /$pattern/i) {
2779                        $match = 1;
2780                    }
2781                }
2782                # Check for a match. Note we use $i-1 because the loop added 2
2783                # before terminating due to the match.
2784                if ($match && $otherMasks[$i-1] != $mask) {
2785                    # This directory matches one of the incoming patterns, and it's
2786                    # a different mask, so we process it recursively with that mask.
2787                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2788                } else {
2789                    # Here we can process normally. Get all of the non-hidden members.
2790                    my @submems = OpenDir($dir, 1);
2791                    for my $submem (@submems) {
2792                        # Get the full name.
2793                        my $thisMem = "$dir/$submem";
2794                        Trace("Checking member $thisMem.") if T(4);
2795                        $lookCount++;
2796                        if ($lookCount % 1000 == 0) {
2797                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(3);
2798                        }
2799                        # Fix the group.
2800                        chown -1, $gid, $thisMem;
2801                        # Insure this member is not a symlink.
2802                        if (! -l $thisMem) {
2803                            # Get its info.
2804                            my $fileInfo = stat $thisMem;
2805                            # Only proceed if we got the info. Otherwise, it's a hard link
2806                            # and we want to skip it anyway.
2807                            if ($fileInfo) {
2808                                my $fileMode = $fileInfo->mode;
2809                                if (($fileMode & $mask) != $mask) {
2810                                    # Fix this member.
2811                                    $fileMode |= $mask;
2812                                    chmod $fileMode, $thisMem;
2813                                    $fixCount++;
2814                                }
2815                                # If it's a subdirectory, stack it.
2816                                if (-d $thisMem) {
2817                                    push @dirs, $thisMem;
2818                                }
2819                            }
2820                        }
2821                    }
2822                }
2823            }
2824            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);
2825        };
2826        # Check for an error.
2827        if ($@) {
2828            Confess("SetPermissions error: $@");
2829        }
2830    }
2831    
2832    =head3 CompareLists
2833    
2834    C<< my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex); >>
2835    
2836    Compare two lists of tuples, and return a hash analyzing the differences. The lists
2837    are presumed to be sorted alphabetically by the value in the $keyIndex column.
2838    The return value contains a list of items that are only in the new list
2839    (inserted) and only in the old list (deleted).
2840    
2841    =over 4
2842    
2843    =item newList
2844    
2845    Reference to a list of new tuples.
2846    
2847    =item oldList
2848    
2849    Reference to a list of old tuples.
2850    
2851    =item keyIndex (optional)
2852    
2853    Index into each tuple of its key field. The default is 0.
2854    
2855    =item RETURN
2856    
2857    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
2858    list (inserted) followed by a reference to the list of items that are only in the old
2859    list (deleted).
2860    
2861    =back
2862    
2863    =cut
2864    
2865    sub CompareLists {
2866        # Get the parameters.
2867        my ($newList, $oldList, $keyIndex) = @_;
2868        if (! defined $keyIndex) {
2869            $keyIndex = 0;
2870        }
2871        # Declare the return variables.
2872        my ($inserted, $deleted) = ([], []);
2873        # Loop through the two lists simultaneously.
2874        my ($newI, $oldI) = (0, 0);
2875        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
2876        while ($newI < $newN || $oldI < $oldN) {
2877            # Get the current object in each list. Note that if one
2878            # of the lists is past the end, we'll get undef.
2879            my $newItem = $newList->[$newI];
2880            my $oldItem = $oldList->[$oldI];
2881            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
2882                # The old item is not in the new list, so mark it deleted.
2883                push @{$deleted}, $oldItem;
2884                $oldI++;
2885            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
2886                # The new item is not in the old list, so mark it inserted.
2887                push @{$inserted}, $newItem;
2888                $newI++;
2889            } else {
2890                # The item is in both lists, so push forward.
2891                $oldI++;
2892                $newI++;
2893            }
2894        }
2895        # Return the result.
2896        return ($inserted, $deleted);
2897    }
2898    
2899    =head3 GetLine
2900    
2901    C<< my @data = Tracer::GetLine($handle); >>
2902    
2903    Read a line of data from a tab-delimited file.
2904    
2905    =over 4
2906    
2907    =item handle
2908    
2909    Open file handle from which to read.
2910    
2911    =item RETURN
2912    
2913    Returns a list of the fields in the record read. The fields are presumed to be
2914    tab-delimited. If we are at the end of the file, then an empty list will be
2915    returned. If an empty line is read, a single list item consisting of a null
2916    string will be returned.
2917    
2918    =back
2919    
2920    =cut
2921    
2922    sub GetLine {
2923        # Get the parameters.
2924        my ($handle) = @_;
2925        # Declare the return variable.
2926        my @retVal = ();
2927        # Read from the file.
2928        my $line = <$handle>;
2929        # Only proceed if we found something.
2930        if (defined $line) {
2931            # Remove the new-line.
2932            chomp $line;
2933            # If the line is empty, return a single empty string; otherwise, parse
2934            # it into fields.
2935            if ($line eq "") {
2936                push @retVal, "";
2937            } else {
2938                push @retVal, split /\t/,$line;
2939      }      }
2940  }  }
2941        # Return the result.
2942        return @retVal;
2943    }
2944    
2945    =head3 PutLine
2946    
2947    C<< Tracer::PutLine($handle, \@fields); >>
2948    
2949    Write a line of data to a tab-delimited file. The specified field values will be
2950    output in tab-separated form, with a trailing new-line.
2951    
2952    =over 4
2953    
2954    =item handle
2955    
2956    Output file handle.
2957    
2958    =item fields
2959    
2960    List of field values.
2961    
2962    =back
2963    
2964    =cut
2965    
2966    sub PutLine {
2967        # Get the parameters.
2968        my ($handle, $fields) = @_;
2969        # Write the data.
2970        print $handle join("\t", @{$fields}) . "\n";
2971    }
2972    
2973    =head3 GenerateURL
2974    
2975    C<< my $queryUrl = Tracer::GenerateURL($page, %parameters); >>
2976    
2977    Generate a GET-style URL for the specified page with the specified parameter
2978    names and values. The values will be URL-escaped automatically. So, for
2979    example
2980    
2981        Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
2982    
2983    would return
2984    
2985        form.cgi?type=1&string=%22high%20pass%22%20or%20highway
2986    
2987    =over 4
2988    
2989    =item page
2990    
2991    Page URL.
2992    
2993    =item parameters
2994    
2995    Hash mapping parameter names to parameter values.
2996    
2997    =item RETURN
2998    
2999    Returns a GET-style URL that goes to the specified page and passes in the
3000    specified parameters and values.
3001    
3002    =back
3003    
3004    =cut
3005    
3006    sub GenerateURL {
3007        # Get the parameters.
3008        my ($page, %parameters) = @_;
3009        # Prime the return variable with the page URL.
3010        my $retVal = $page;
3011        # Loop through the parameters, creating parameter elements in a list.
3012        my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3013        # If the list is nonempty, tack it on.
3014        if (@parmList) {
3015            $retVal .= "?" . join("&", @parmList);
3016        }
3017        # Return the result.
3018        return $retVal;
3019    }
3020    
3021  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3