[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.6, Mon Mar 7 02:01:51 2005 UTC revision 1.75, Fri Oct 6 00:41:44 2006 UTC
# Line 1  Line 1 
1    #
2    # Copyright (c) 2003-2006 University of Chicago and Fellowship
3    # for Interpretations of Genomes. All Rights Reserved.
4    #
5    # This file is part of the SEED Toolkit.
6    #
7    # The SEED Toolkit is free software. You can redistribute
8    # it and/or modify it under the terms of the SEED Toolkit
9    # Public License.
10    #
11    # You should have received a copy of the SEED Toolkit Public License
12    # along with this program; if not write to the University of Chicago
13    # at info@ci.uchicago.edu or the Fellowship for Interpretation of
14    # Genomes at veronika@thefig.info or download a copy from
15    # http://www.theseed.org/LICENSE.TXT.
16    #
17    
18  package Tracer;  package Tracer;
19    
20          require Exporter;          require Exporter;
21          @ISA = ('Exporter');          @ISA = ('Exporter');
22          @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert);      @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);      @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;
29        use PageBuilder;
30        use Digest::MD5;
31        use File::Basename;
32        use File::Path;
33        use File::stat;
34        use LWP::UserAgent;
35        use Time::HiRes 'gettimeofday';
36        use URI::Escape;
37        use Time::Local;
38    
39  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
40    
41  =head2 Introduction  =head2 Tracing
42    
43  This package provides simple tracing for debugging and reporting purposes. To use it simply call the  This package provides simple tracing for debugging and reporting purposes. To use it simply call the
44  L</TSetup> method to set the options and call L</Trace> to write out trace messages. Each trace  L</TSetup> or L</ETracing> method to set the options and call L</Trace> to write out trace messages.
45  message has a I<trace level> and I<category> associated with it. In addition, the tracing package itself  L</TSetup> and L</ETracing> both establish a I<trace level> and a list of I<categories>. Similarly,
46  has a list of categories and a single trace level set by the B<TSetup> method. Only messages whose trace  each trace message has a I<trace level> and I<category> associated with it. Only messages whose trace
47  level is less than or equal to this package's trace level and whose category is activated will  level is less than or equal to the setup trace level and whose category is activated will
48  be written. Thus, a higher trace level on a message indicates that the message  be written. Thus, a higher trace level on a message indicates that the message
49  is less likely to be seen. A higher trace level passed to B<Setup> means more trace messages will  is less likely to be seen, while a higher trace level passed to B<TSetup> means more trace messages will
50  appear. To generate a trace message, use the following syntax.  appear.
51    
52    =head3 Putting Trace Messages in Your Code
53    
54  C<< Trace($message) if T(errors => 4); >>  To generate a trace message, use the following syntax.
55    
56        Trace($message) if T(errors => 4);
57    
58  This statement will produce a trace message if the trace level is 4 or more and the C<errors>  This statement will produce a trace message if the trace level is 4 or more and the C<errors>
59  category is active. Note that the special category C<main> is always active, so  category is active. There is a special category C<main> that is always active, so
60    
61  C<< Trace($message) if T(main => 4); >>      Trace($message) if T(main => 4);
62    
63  will trace if the trace level is 4 or more.  will trace if the trace level is 4 or more.
64    
# Line 34  Line 66 
66  following call is made in the B<Sprout> package, it will appear if the C<Sprout> category is  following call is made in the B<Sprout> package, it will appear if the C<Sprout> category is
67  active and the trace level is 2 or more.  active and the trace level is 2 or more.
68    
69  C<< Trace($message) if T(2); >>      Trace($message) if T(2);
70    
71    In scripts, where no package name is available, the category defaults to C<main>.
72    
73  To set up tracing, you call the C</Setup> method. The method takes as input a trace level, a list  =head3 Custom Tracing
74  of category names, and a set of options. The trace level and list of category names are  
75    Many programs have customized tracing configured using the L</TSetup> method. This is no longer
76    the preferred method, but a knowledge of how custom tracing works can make the more modern
77    L</Emergency Tracing> easier to understand.
78    
79    To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
80    a list of category names, and a destination. The trace level and list of category names are
81  specified as a space-delimited string. Thus  specified as a space-delimited string. Thus
82    
83  C<< TSetup('3 errors Sprout ERDB', 'HTML'); >>      TSetup('3 errors Sprout ERDB', 'TEXT');
84    
85    sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and
86    specifies that messages should be sent to the standard output.
87    
88    To turn on tracing for ALL categories, use an asterisk. The call below sets every category to
89    level 3 and writes the output to the standard error output. This sort of thing might be
90    useful in a CGI environment.
91    
92  sets the trace level to 3, activated the C<errors>, C<Sprout>, and C<ERDB> categories, and      TSetup('3 *', 'WARN');
 specifies that messages should be output as HTML paragraphs. The idea is to make it easier to  
 input tracing configuration on a web form.  
93    
94  In addition to HTML and file output for trace messages, you can specify that the trace messages  In addition standard error and file output for trace messages, you can specify that the trace messages
95  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach  be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach
96  is useful if you are building a web page. Instead of having the trace messages interspersed with  is useful if you are building a web page. Instead of having the trace messages interspersed with
97  the page output, they can be gathered together and displayed at the end of the page. This makes  the page output, they can be gathered together and displayed at the end of the page. This makes
98  it easier to debug page formatting problems.  it easier to debug page formatting problems.
99    
100  Finally, you can specify that all trace messages be emitted as warnings.  Finally, you can specify that all trace messages be emitted to a file, or the standard output and
101    a file at the same time. To trace to a file, specify the filename with an output character in front
102    of it.
103    
104        TSetup('4 SQL', ">$fileName");
105    
106    To trace to the standard output and a file at the same time, put a C<+> in front of the angle
107    bracket.
108    
109        TSetup('3 *', "+>$fileName");
110    
111  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.  The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.
112  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.  Tracer calls can be left in the code with minimal overhead and then turned on only when needed.
113  Thus, debugging information is available and easily retrieved even when the application is  Thus, debugging information is available and easily retrieved even when the application is
114  being used out in the field.  being used out in the field.
115    
116    =head3 Trace Levels
117    
118    There is no hard and fast rule on how to use trace levels. The following is therefore only
119    a suggestion.
120    
121    =over 4
122    
123    =item Error 0
124    
125    Message indicates an error that may lead to incorrect results or that has stopped the
126    application entirely.
127    
128    =item Warning 1
129    
130    Message indicates something that is unexpected but that probably did not interfere
131    with program execution.
132    
133    =item Notice 2
134    
135    Message indicates the beginning or end of a major task.
136    
137    =item Information 3
138    
139    Message indicates a subtask. In the FIG system, a subtask generally relates to a single
140    genome. This would be a big loop that is not expected to execute more than 500 times or so.
141    
142    =item Detail 4
143    
144    Message indicates a low-level loop iteration.
145    
146    =back
147    
148    The format of trace messages is important because some utilities analyze trace files.
149    There are three fields-- the time stamp, the category name, and the text.
150    The time stamp is between square brackets and the category name between angle brackets.
151    After the category name there is a colon (C<:>) followed by the message text.
152    If the square brackets or angle brackets are missing, then the trace management
153    utilities assume that they are encountering a set of pre-formatted lines.
154    
155    Note, however, that this formatting is done automatically by the tracing functions. You
156    only need to know about it if you want to parse a trace file.
157    
158    =head3 Emergency Tracing
159    
160    Sometimes, you need a way for tracing to happen automatically without putting parameters
161    in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
162    from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.
163    Emergency tracing requires you specify a tracing key. For command-line tools, the key is
164    taken from the C<TRACING> environment variable. For web services, the key is taken from
165    a cookie. Either way, the key tells the tracing facility who you are, so that you control
166    the tracing in your environment without stepping on other users.
167    
168    The key can be anything you want. If you don't have a key, the C<SetPassword> page will
169    generate one for you.
170    
171    You can activate and de-activate emergency tracing from the debugging control panel, as
172    well as display the trace file itself.
173    
174    To enable emergency tracing in your code, call
175    
176        ETracing($cgi)
177    
178    from a web script and
179    
180        ETracing()
181    
182    from a command-line script.
183    
184    The web script will look for the tracing key in the cookies, and the command-line
185    script will look for it in the C<TRACING> environment variable. If you are
186    using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
187    will be configured automatically.
188    
189    =head3 Debugging Control Panel
190    
191    The debugging control panel provides several tools to assist in development of
192    SEED and Sprout software. You access the debugging control panel from the URL
193    C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,
194    for example, the panel access point for the development NMPDR system is
195    C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to
196    find out what the password is. From this page, you can also specify a tracing
197    key. If you don't specify a key, one will be generated for you.
198    
199    =head4 Emergency Tracing Form
200    
201    At the bottom of the debugging control panel is a form that allows you to
202    specify a trace level and tracing categories. Special and common categories
203    are listed with check boxes. You can hold your mouse over a check box to see
204    what its category does. In general, however, a category name is the same as
205    the name of the package in which the trace message occurs.
206    
207    Additional categories can be entered in an input box, delimited by spaces or commas.
208    
209    The B<Activate> button turns on Emergency tracing at the level you specify with the
210    specified categories active. The B<Terminate> button turns tracing off. The
211    B<Show File> button displays the current contents of the trace file. The tracing
212    form at the bottom of the control panel is designed for emergency tracing, so it
213    will only affect programs that call L</ETracing>, L</StandardScript>,
214    or L</StandardSetup>.
215    
216    =head4 Script Form
217    
218    The top form of the debugging control panel allows you to enter a tiny script and
219    have the output generated in a formatted table. Certain object variables are
220    predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),
221    and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.
222    
223    The last line of the script must be a scalar, but it can be a reference to a hash,
224    a list, a list of lists, and various other combinations. If you select the appropriate
225    data type in the dropdown box, the output will be formatted accordingly. The form
226    also has controls for specifying tracing. These controls override any emergency
227    tracing in effect.
228    
229    =head4 Database Query Forms
230    
231    The forms between the script form and the emergency tracing form allow you to
232    make queries against the database. The FIG query form allows simple queries against
233    a single FIG table. The Sprout query form uses the B<GetAll> method to do a
234    multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>
235    package, and it takes five parameters.
236    
237        GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);
238    
239    Each of the five parameters corresponds to a text box on the query form:
240    
241    =over 4
242    
243    =item Objects
244    
245    Comma-separated list containing the names of the entity and relationship objects to be retrieved.
246    
247    =item Filter
248    
249    WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
250    be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form
251    B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a
252    field, I<objectName> is the name of the entity or relationship object containing the field, and
253    I<number> is the 1-based position of the object in the object list. Any parameters
254    specified in the filter clause should be specified in the B<Params> field.
255    The fields in a filter clause can come from primary entity relations,
256    relationship relations, or secondary entity relations; however, all of the
257    entities and relationships involved must be included in the list of object names.
258    
259    =item Params
260    
261    List of the parameters to be substituted in for the parameters marks in the filter clause. This
262    is a comma-separated list without any quoting or escaping.
263    
264    =item fields
265    
266    Comma-separated list of the fields to be returned in each element of the list returned. Fields
267    are specified in the same manner as in the filter clause.
268    
269    =item count
270    
271    Maximum number of records to return. If omitted or 0, all available records will be returned.
272    
273    =back
274    
275    B<GetAll> automatically joins together the entities and relationships listed in the object
276    names. This simplifies the coding of the filter clause, but it means that some queries are
277    not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation
278    that has yet to be addressed.
279    
280  =cut  =cut
281    
282  # Declare the configuration variables.  # Declare the configuration variables.
283    
284  my $Destination = "NONE";       # Description of where to send the trace output.  my $Destination = "NONE";       # Description of where to send the trace output.
285    my $TeeFlag = 0;            # TRUE if output is going to a file and to the
286                                # standard output
287  my %Categories = ( main => 1 );  my %Categories = ( main => 1 );
288                                                          # hash of active category names                                                          # hash of active category names
289  my $TraceLevel = 0;                     # trace level; a higher trace level produces more  my $TraceLevel = 0;                     # trace level; a higher trace level produces more
290                                                          # messages                                                          # messages
291  my @Queue = ();                         # queued list of trace messages.  my @Queue = ();                         # queued list of trace messages.
292    my $LastCategory = "main";  # name of the last category interrogated
293    my $SetupCount = 0;         # number of times TSetup called
294    my $AllTrace = 0;           # TRUE if we are tracing all categories.
295    
296  =head2 Public Methods  =head2 Public Methods
297    
# Line 90  Line 313 
313    
314  The destination for the trace output. To send the trace output to a file, specify the file  The destination for the trace output. To send the trace output to a file, specify the file
315  name preceded by a ">" symbol. If a double symbol is used (">>"), then the data is appended  name preceded by a ">" symbol. If a double symbol is used (">>"), then the data is appended
316  to the file. Otherwise the file is cleared before tracing begins. In addition to sending  to the file. Otherwise the file is cleared before tracing begins. Precede the first ">"
317  the trace messages to a file, you can specify a special destination. C<HTML> will cause  symbol with a C<+> to echo output to a file AND to the standard output. In addition to
318  tracing to the standard output with each line formatted as an HTML paragraph. C<TEXT>  sending the trace messages to a file, you can specify a special destination. C<HTML> will
319    cause tracing to the standard output with each line formatted as an HTML paragraph. C<TEXT>
320  will cause tracing to the standard output as ordinary text. C<ERROR> will cause trace  will cause tracing to the standard output as ordinary text. C<ERROR> will cause trace
321  messages to be sent to the standard error output as ordinary text. C<QUEUE> will cause trace  messages to be sent to the standard error output as ordinary text. C<QUEUE> will cause trace
322  messages to be stored in a queue for later retrieval by the L</QTrace> method. C<WARN> will  messages to be stored in a queue for later retrieval by the L</QTrace> method. C<WARN> will
# Line 110  Line 334 
334          my @categoryData = split /\s+/, $categoryList;          my @categoryData = split /\s+/, $categoryList;
335          # Extract the trace level.          # Extract the trace level.
336          $TraceLevel = shift @categoryData;          $TraceLevel = shift @categoryData;
337          # Build the category hash.      # Presume category-based tracing until we learn otherwise.
338        $AllTrace = 0;
339        # Build the category hash. Note that if we find a "*", we turn on non-category
340        # tracing. We must also clear away any pre-existing data.
341        %Categories = ( main => 1 );
342          for my $category (@categoryData) {          for my $category (@categoryData) {
343                  $Categories{$category} = 1;          if ($category eq '*') {
344                $AllTrace = 1;
345            } else {
346                $Categories{lc $category} = 1;
347            }
348          }          }
349          # Now we need to process the destination information. The most important special          # Now we need to process the destination information. The most important special
350          # case is the single ">", which requires we clear the file first. After doing      # cases are the single ">", which requires we clear the file first, and the
351          # so, we tack on another ">" sign so that future trace messages are appended.      # "+" prefix which indicates a double echo.
352        if ($target =~ m/^\+?>>?/) {
353            if ($target =~ m/^\+/) {
354                $TeeFlag = 1;
355                $target = substr($target, 1);
356            }
357          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
358                  open TRACEFILE, $target;                  open TRACEFILE, $target;
359                  print TRACEFILE Now() . " Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";
360                  close TRACEFILE;                  close TRACEFILE;
361                  $Destination = ">$target";                  $Destination = ">$target";
362          } else {          } else {
363                $Destination = $target;
364            }
365        } else {
366                  $Destination = uc($target);                  $Destination = uc($target);
367          }          }
368        # Increment the setup counter.
369        $SetupCount++;
370    }
371    
372    =head3 StandardSetup
373    
374    C<< my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV); >>
375    
376    This method performs standard command-line parsing and tracing setup. The return
377    values are a hash of the command-line options and a list of the positional
378    parameters. Tracing is automatically set up and the command-line options are
379    validated.
380    
381    This is a complex method that does a lot of grunt work. The parameters can
382    be more easily understood, however, once they are examined individually.
383    
384    The I<categories> parameter is the most obtuse. It is a reference to a list of
385    special-purpose tracing categories. Most tracing categories are PERL package
386    names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
387    B<ERDB>, and B<SproutLoad> packages, you would specify the categories
388    
389        ["Sprout", "SproutLoad", "ERDB"]
390    
391    This would cause trace messages in the specified three packages to appear in
392    the output. There are two special tracing categories that are automatically
393    handled by this method. In other words, if you used L</TSetup> you would need
394    to include these categories manually, but if you use this method they are turned
395    on automatically.
396    
397    =over 4
398    
399    =item SQL
400    
401    Traces SQL commands and activity.
402    
403    =item Tracer
404    
405    Traces error messages and call stacks.
406    
407    =back
408    
409    C<SQL> is only turned on if the C<-sql> option is specified in the command line.
410    The trace level is specified using the C<-trace> command-line option. For example,
411    the following command line for C<TransactFeatures> turns on SQL tracing and runs
412    all tracing at level 3.
413    
414        TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
415    
416    Standard tracing is output to the standard output and echoed to the file
417    C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
418    process ID. You can also specify the C<user> parameter to put a user ID
419    instead of a process ID in the trace file name. So, for example
420    
421    The default trace level is 2. To get all messages, specify a trace level of 4.
422    For a genome-by-genome update, use 3.
423    
424        TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
425    
426    would send the trace output to C<traceBruce.log> in the temporary directory.
427    
428    The I<options> parameter is a reference to a hash containing the command-line
429    options, their default values, and an explanation of what they mean. Command-line
430    options may be in the form of switches or keywords. In the case of a switch, the
431    option value is 1 if it is specified and 0 if it is not specified. In the case
432    of a keyword, the value is separated from the option name by an equal sign. You
433    can see this last in the command-line example above.
434    
435    You can specify a different default trace level by setting C<$options->{trace}>
436    prior to calling this method.
437    
438    An example at this point would help. Consider, for example, the command-line utility
439    C<TransactFeatures>. It accepts a list of positional parameters plus the options
440    C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
441    the following code.
442    
443        my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
444                            { safe => [0, "use database transactions"],
445                              noAlias => [0, "do not expect aliases in CHANGE transactions"],
446                              start => [' ', "start with this genome"],
447                              tblFiles => [0, "output TBL files containing the corrected IDs"] },
448                            "command transactionDirectory IDfile",
449                          @ARGV);
450    
451    
452    The call to C<ParseCommand> specifies the default values for the options and
453    stores the actual options in a hash that is returned as C<$options>. The
454    positional parameters are returned in C<@parameters>.
455    
456    The following is a sample command line for C<TransactFeatures>.
457    
458        TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
459    
460    In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
461    parameters, and would find themselves in I<@parameters> after executing the
462    above code fragment. The tracing would be set to level 2, and the categories
463    would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
464    and C<DocUtils> was included because it came in within the first parameter
465    to this method. The I<$options> hash would be
466    
467        { trace => 2, sql => 0, safe => 0,
468          noAlias => 1, start => ' ', tblFiles => 0 }
469    
470    Use of C<StandardSetup> in this way provides a simple way of performing
471    standard tracing setup and command-line parsing. Note that the caller is
472    not even aware of the command-line switches C<-trace> and C<-sql>, which
473    are used by this method to control the tracing. If additional tracing features
474    need to be added in the future, they can be processed by this method without
475    upsetting the command-line utilities.
476    
477    If the C<background> option is specified on the command line, then the
478    standard and error outputs will be directed to files in the temporary
479    directory, using the same suffix as the trace file. So, if the command
480    line specified
481    
482        -user=Bruce -background
483    
484    then the trace output would go to C<traceBruce.log>, the standard output to
485    C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
486    simplify starting a command in the background.
487    
488    The user name is also used as the tracing key for L</Emergency Tracing>.
489    Specifying a value of C<E> for the trace level causes emergency tracing to
490    be used instead of custom tracing. If the user name is not specified,
491    the tracing key is taken from the C<Tracing> environment variable. If there
492    is no value for that variable, the tracing key will be computed from the PID.
493    
494    Finally, if the special option C<-h> is specified, the option names will
495    be traced at level 0 and the program will exit without processing.
496    This provides a limited help capability. For example, if the user enters
497    
498        TransactFeatures -h
499    
500    he would see the following output.
501    
502        TransactFeatures [options] command transactionDirectory IDfile
503            -trace    tracing level (default E)
504            -sql      trace SQL commands
505            -safe     use database transactions
506            -noAlias  do not expect aliases in CHANGE transactions
507            -start    start with this genome
508            -tblFiles output TBL files containing the corrected IDs
509    
510    The caller has the option of modifying the tracing scheme by placing a value
511    for C<trace> in the incoming options hash. The default value can be overridden,
512    or the tracing to the standard output can be turned off by suffixing a minus
513    sign to the trace level. So, for example,
514    
515        { trace => [0, "tracing level (default 0)"],
516           ...
517    
518    would set the default trace level to 0 instead of E, while
519    
520        { trace => ["2-", "tracing level (default 2)"],
521           ...
522    
523    would set the default to 2, but trace only to the log file, not to the
524    standard output.
525    
526    The parameters to this method are as follows.
527    
528    =over 4
529    
530    =item categories
531    
532    Reference to a list of tracing category names. These should be names of
533    packages whose internal workings will need to be debugged to get the
534    command working.
535    
536    =item options
537    
538    Reference to a hash containing the legal options for the current command mapped
539    to their default values and descriptions. The user can override the defaults
540    by specifying the options as command-line switches prefixed by a hyphen.
541    Tracing-related options may be added to this hash. If the C<-h> option is
542    specified on the command line, the option descriptions will be used to
543    explain the options. To turn off tracing to the standard output, add a
544    minus sign to the value for C<trace> (see above).
545    
546    =item parmHelp
547    
548    A string that vaguely describes the positional parameters. This is used
549    if the user specifies the C<-h> option.
550    
551    =item argv
552    
553    List of command line parameters, including the option switches, which must
554    precede the positional parameters and be prefixed by a hyphen.
555    
556    =item RETURN
557    
558    Returns a list. The first element of the list is the reference to a hash that
559    maps the command-line option switches to their values. These will either be the
560    default values or overrides specified on the command line. The remaining
561    elements of the list are the position parameters, in order.
562    
563    =back
564    
565    =cut
566    
567    sub StandardSetup {
568        # Get the parameters.
569        my ($categories, $options, $parmHelp, @argv) = @_;
570        # Get the default tracing key.
571        my $tkey = EmergencyKey();
572        # Add the tracing options.
573        if (! exists $options->{trace}) {
574            $options->{trace} = ['E', "tracing level (E for emergency tracing)"];
575        }
576        $options->{sql} = [0, "turn on SQL tracing"];
577        $options->{h} = [0, "display command-line options"];
578        $options->{user} = [$tkey, "tracing key"];
579        $options->{background} = [0, "spool standard and error output"];
580        # Create a parsing hash from the options hash. The parsing hash
581        # contains the default values rather than the default value
582        # and the description. While we're at it, we'll memorize the
583        # length of the longest option name.
584        my $longestName = 0;
585        my %parseOptions = ();
586        for my $key (keys %{$options}) {
587            if (length $key > $longestName) {
588                $longestName = length $key;
589            }
590            $parseOptions{$key} = $options->{$key}->[0];
591        }
592        # Parse the command line.
593        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
594        # Get the logfile suffix.
595        my $suffix = $retOptions->{user};
596        # Check for background mode.
597        if ($retOptions->{background}) {
598            my $outFileName = "$FIG_Config::temp/out$suffix.log";
599            my $errFileName = "$FIG_Config::temp/err$suffix.log";
600            open STDOUT, ">$outFileName";
601            open STDERR, ">$errFileName";
602        }
603        # Now we want to set up tracing. First, we need to know if the user
604        # wants emergency tracing.
605        if ($retOptions->{trace} eq 'E') {
606            ETracing($retOptions->{user});
607        } else {
608            # Here the tracing is controlled from the command line.
609            my @cats = @{$categories};
610            if ($retOptions->{sql}) {
611                push @cats, "SQL";
612            }
613            # Add the default categories.
614            push @cats, "Tracer";
615            # Next, we create the category string by joining the categories.
616            my $cats = join(" ", @cats);
617            # Check to determine whether or not the caller wants to turn off tracing
618            # to the standard output.
619            my $traceLevel = $retOptions->{trace};
620            my $textOKFlag = 1;
621            if ($traceLevel =~ /^(.)-/) {
622                $traceLevel = $1;
623                $textOKFlag = 0;
624            }
625            # Now we set up the trace mode.
626            my $traceMode;
627            # Verify that we can open a file in the FIG temporary directory.
628            my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
629            if (open TESTTRACE, ">$traceFileName") {
630                # Here we can trace to a file.
631                $traceMode = ">$traceFileName";
632                if ($textOKFlag) {
633                    # Echo to standard output if the text-OK flag is set.
634                    $traceMode = "+$traceMode";
635                }
636                # Close the test file.
637                close TESTTRACE;
638            } else {
639                # Here we can't trace to a file. We trace to the standard output if it's
640                # okay, and the error log otherwise.
641                if ($textOKFlag) {
642                    $traceMode = "TEXT";
643                } else {
644                    $traceMode = "WARN";
645                }
646            }
647            # Now set up the tracing.
648            TSetup("$traceLevel $cats", $traceMode);
649        }
650        # Check for the "h" option. If it is specified, dump the command-line
651        # options and exit the program.
652        if ($retOptions->{h}) {
653            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
654            print "$1 [options] $parmHelp\n";
655            for my $key (sort keys %{$options}) {
656                my $name = Pad($key, $longestName, 0, ' ');
657                my $desc = $options->{$key}->[1];
658                if ($options->{$key}->[0]) {
659                    $desc .= " (default " . $options->{$key}->[0] . ")";
660                }
661                print "  $name $desc\n";
662            }
663            exit(0);
664        }
665        # Return the parsed parameters.
666        return ($retOptions, @retParameters);
667    }
668    
669    =head3 Setups
670    
671    C<< my $count = Tracer::Setups(); >>
672    
673    Return the number of times L</TSetup> has been called.
674    
675    This method allows for the creation of conditional tracing setups where, for example, we
676    may want to set up tracing if nobody else has done it before us.
677    
678    =cut
679    
680    sub Setups {
681        return $SetupCount;
682    }
683    
684    =head3 Open
685    
686    C<< my $handle = Open($fileHandle, $fileSpec, $message); >>
687    
688    Open a file.
689    
690    The I<$fileSpec> is essentially the second argument of the PERL C<open>
691    function. The mode is specified using Unix-like shell information. So, for
692    example,
693    
694        Open(\*LOGFILE, '>>/usr/spool/news/twitlog', "Could not open twit log.");
695    
696    would open for output appended to the specified file, and
697    
698        Open(\*DATASTREAM, "| sort -u >$outputFile", "Could not open $outputFile.");
699    
700    would open a pipe that sorts the records written and removes duplicates. Note
701    the use of file handle syntax in the Open call. To use anonymous file handles,
702    code as follows.
703    
704        my $logFile = Open(undef, '>>/usr/spool/news/twitlog', "Could not open twit log.");
705    
706    The I<$message> parameter is used if the open fails. If it is set to C<0>, then
707    the open returns TRUE if successful and FALSE if an error occurred. Otherwise, a
708    failed open will throw an exception and the third parameter will be used to construct
709    an error message. If the parameter is omitted, a standard message is constructed
710    using the file spec.
711    
712        Could not open "/usr/spool/news/twitlog"
713    
714    Note that the mode characters are automatically cleaned from the file name.
715    The actual error message from the file system will be captured and appended to the
716    message in any case.
717    
718        Could not open "/usr/spool/news/twitlog": file not found.
719    
720    In some versions of PERL the only error message we get is a number, which
721    corresponds to the C++ C<errno> value.
722    
723        Could not open "/usr/spool/news/twitlog": 6.
724    
725    =over 4
726    
727    =item fileHandle
728    
729    File handle. If this parameter is C<undef>, a file handle will be generated
730    and returned as the value of this method.
731    
732    =item fileSpec
733    
734    File name and mode, as per the PERL C<open> function.
735    
736    =item message (optional)
737    
738    Error message to use if the open fails. If omitted, a standard error message
739    will be generated. In either case, the error information from the file system
740    is appended to the message. To specify a conditional open that does not throw
741    an error if it fails, use C<0>.
742    
743    =item RETURN
744    
745    Returns the name of the file handle assigned to the file, or C<undef> if the
746    open failed.
747    
748    =back
749    
750    =cut
751    
752    sub Open {
753        # Get the parameters.
754        my ($fileHandle, $fileSpec, $message) = @_;
755        # Attempt to open the file.
756        my $rv = open $fileHandle, $fileSpec;
757        # If the open failed, generate an error message.
758        if (! $rv) {
759            # Save the system error message.
760            my $sysMessage = $!;
761            # See if we need a default message.
762            if (!$message) {
763                # Clean any obvious mode characters and leading spaces from the
764                # filename.
765                my ($fileName) = FindNamePart($fileSpec);
766                $message = "Could not open \"$fileName\"";
767            }
768            # Terminate with an error using the supplied message and the
769            # error message from the file system.
770            Confess("$message: $!");
771        }
772        # Return the file handle.
773        return $fileHandle;
774    }
775    
776    =head3 FindNamePart
777    
778    C<< my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec); >>
779    
780    Extract the portion of a file specification that contains the file name.
781    
782    A file specification is the string passed to an C<open> call. It specifies the file
783    mode and name. In a truly complex situation, it can specify a pipe sequence. This
784    method assumes that the file name is whatever follows the first angle bracket
785    sequence.  So, for example, in the following strings the file name is
786    C</usr/fig/myfile.txt>.
787    
788        >>/usr/fig/myfile.txt
789        </usr/fig/myfile.txt
790        | sort -u > /usr/fig/myfile.txt
791    
792    If the method cannot find a file name using its normal methods, it will return the
793    whole incoming string.
794    
795    =over 4
796    
797    =item fileSpec
798    
799    File specification string from which the file name is to be extracted.
800    
801    =item RETURN
802    
803    Returns a three-element list. The first element contains the file name portion of
804    the specified string, or the whole string if a file name cannot be found via normal
805    methods. The second element contains the start position of the file name portion and
806    the third element contains the length.
807    
808    =back
809    
810    =cut
811    #: Return Type $;
812    sub FindNamePart {
813        # Get the parameters.
814        my ($fileSpec) = @_;
815        # Default to the whole input string.
816        my ($retVal, $pos, $len) = ($fileSpec, 0, length $fileSpec);
817        # Parse out the file name if we can.
818        if ($fileSpec =~ m/(<|>>?)(.+?)(\s*)$/) {
819            $retVal = $2;
820            $len = length $retVal;
821            $pos = (length $fileSpec) - (length $3) - $len;
822        }
823        # Return the result.
824        return ($retVal, $pos, $len);
825    }
826    
827    =head3 OpenDir
828    
829    C<< my @files = OpenDir($dirName, $filtered, $flag); >>
830    
831    Open a directory and return all the file names. This function essentially performs
832    the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
833    set to TRUE, all filenames beginning with a period (C<.>), dollar sign (C<$>),
834    or pound sign (C<#>) and all filenames ending with a tilde C<~>) will be
835    filtered out of the return list. If the directory does not open and I<$flag> is not
836    set, an exception is thrown. So, for example,
837    
838        my @files = OpenDir("/Volumes/fig/contigs", 1);
839    
840    is effectively the same as
841    
842        opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");
843        my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);
844    
845    Similarly, the following code
846    
847        my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);
848    
849    Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and
850    automatically returns an empty list if the directory fails to open.
851    
852    =over 4
853    
854    =item dirName
855    
856    Name of the directory to open.
857    
858    =item filtered
859    
860    TRUE if files whose names begin with a period (C<.>) should be automatically removed
861    from the list, else FALSE.
862    
863    =item flag
864    
865    TRUE if a failure to open is okay, else FALSE
866    
867    =back
868    
869    =cut
870    #: Return Type @;
871    sub OpenDir {
872        # Get the parameters.
873        my ($dirName, $filtered, $flag) = @_;
874        # Declare the return variable.
875        my @retVal = ();
876        # Open the directory.
877        if (opendir(my $dirHandle, $dirName)) {
878            # The directory opened successfully. Get the appropriate list according to the
879            # strictures of the filter parameter.
880            if ($filtered) {
881                @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;
882            } else {
883                @retVal = readdir $dirHandle;
884            }
885        } elsif (! $flag) {
886            # Here the directory would not open and it's considered an error.
887            Confess("Could not open directory $dirName.");
888        }
889        # Return the result.
890        return @retVal;
891  }  }
892    
893  =head3 SetLevel  =head3 SetLevel
# Line 169  Line 932 
932          return $value;          return $value;
933  }  }
934    
935    =head3 ParseTraceDate
936    
937    C<< my $time = Tracer::ParseTraceDate($dateString); >>
938    
939    Convert a date from the trace file into a PERL timestamp.
940    
941    =over 4
942    
943    =item dateString
944    
945    The date string from the trace file. The format of the string is determined by the
946    L</Now> method.
947    
948    =item RETURN
949    
950    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
951    the time string is invalid.
952    
953    =cut
954    
955    sub ParseTraceDate {
956        # Get the parameters.
957        my ($dateString) = @_;
958        # Declare the return variable.
959        my $retVal;
960        # Parse the date.
961        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
962            # Create a time object.
963            $retVal = timelocal($6, $5, $4, $2, $1, $3);
964        }
965        # Return the result.
966        return $retVal;
967    }
968    
969  =head3 LogErrors  =head3 LogErrors
970    
971  C<< Tracer::LogErrors($fileName); >>  C<< Tracer::LogErrors($fileName); >>
# Line 370  Line 1167 
1167          my ($message) = @_;          my ($message) = @_;
1168          # Get the timestamp.          # Get the timestamp.
1169          my $timeStamp = Now();          my $timeStamp = Now();
1170          # Format the message.      # Format the message. Note we strip off any line terminators at the end.
1171          my $formatted = "$timeStamp $message";      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);
1172          # Process according to the destination.          # Process according to the destination.
1173          if ($Destination eq "TEXT") {          if ($Destination eq "TEXT") {
1174                  # Write the message to the standard output.                  # Write the message to the standard output.
# Line 391  Line 1188 
1188         warn $message;         warn $message;
1189          } elsif ($Destination =~ m/^>>/) {          } elsif ($Destination =~ m/^>>/) {
1190                  # Write the trace message to an output file.                  # Write the trace message to an output file.
1191                  open TRACING, $Destination;          (open TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
1192                  print TRACING "$formatted\n";                  print TRACING "$formatted\n";
1193                  close TRACING;                  close TRACING;
1194            # If the Tee flag is on, echo it to the standard output.
1195            if ($TeeFlag) {
1196                print "$formatted\n";
1197            }
1198          }          }
1199  }  }
1200    
# Line 436  Line 1237 
1237                  my ($category, $traceLevel) = @_;                  my ($category, $traceLevel) = @_;
1238                  if (!defined $traceLevel) {                  if (!defined $traceLevel) {
1239                          # Here we have no category, so we need to get the calling package.                          # Here we have no category, so we need to get the calling package.
1240                # The calling package is normally the first parameter. If it is
1241                # omitted, the first parameter will be the tracelevel. So, the
1242                # first thing we do is shift the so-called category into the
1243                # $traceLevel variable where it belongs.
1244                          $traceLevel = $category;                          $traceLevel = $category;
1245                          my ($package, $fileName, $line) = caller;                          my ($package, $fileName, $line) = caller;
1246              # If there is no calling package, we default to "main".              # If there is no calling package, we default to "main".
# Line 445  Line 1250 
1250                                  $category = $package;                                  $category = $package;
1251                          }                          }
1252                  }                  }
1253                  # Use the package and tracelevel to compute the result.          # Save the category name.
1254                  $retVal = ($traceLevel <= $TraceLevel && exists $Categories{$category});          $LastCategory = $category;
1255            # Convert it to lower case before we hash it.
1256            $category = lc $category;
1257            # Use the category and tracelevel to compute the result.
1258            if (ref $traceLevel) {
1259                Confess("Bad trace level.");
1260            } elsif (ref $TraceLevel) {
1261                Confess("Bad trace config.");
1262            }
1263            $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));
1264      }      }
1265          # Return the computed result.          # Return the computed result.
1266      return $retVal;      return $retVal;
# Line 528  Line 1342 
1342          return ($optionTable, @retVal);          return ($optionTable, @retVal);
1343  }  }
1344    
1345    =head3 Escape
1346    
1347    C<< my $codedString = Tracer::Escape($realString); >>
1348    
1349    Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines
1350    replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
1351    result is to reverse the effect of L</UnEscape>.
1352    
1353    =over 4
1354    
1355    =item realString
1356    
1357    String to escape.
1358    
1359    =item RETURN
1360    
1361    Escaped equivalent of the real string.
1362    
1363    =back
1364    
1365    =cut
1366    
1367    sub Escape {
1368        # Get the parameter.
1369        my ($realString) = @_;
1370        # Initialize the return variable.
1371        my $retVal = "";
1372        # Loop through the parameter string, looking for sequences to escape.
1373        while (length $realString > 0) {
1374            # Look for the first sequence to escape.
1375            if ($realString =~ /^(.*?)([\n\t\r\\])/) {
1376                # Here we found it. The text preceding the sequence is in $1. The sequence
1377                # itself is in $2. First, move the clear text to the return variable.
1378                $retVal .= $1;
1379                # Strip the processed section off the real string.
1380                $realString = substr $realString, (length $2) + (length $1);
1381                # Get the matched character.
1382                my $char = $2;
1383                # If we have a CR, we are done.
1384                if ($char ne "\r") {
1385                    # It's not a CR, so encode the escape sequence.
1386                    $char =~ tr/\t\n/tn/;
1387                    $retVal .= "\\" . $char;
1388                }
1389            } else {
1390                # Here there are no more escape sequences. The rest of the string is
1391                # transferred unmodified.
1392                $retVal .= $realString;
1393                $realString = "";
1394            }
1395        }
1396        # Return the result.
1397        return $retVal;
1398    }
1399    
1400  =head3 UnEscape  =head3 UnEscape
1401    
1402  C<< my $realString = Tracer::UnEscape($codedString); >>  C<< my $realString = Tracer::UnEscape($codedString); >>
1403    
1404  Replace escape sequences with their actual equivalents. C<\b> will be replaced by a space,  Replace escape sequences with their actual equivalents. C<\t> will be replaced by
1405  C<\t> by a tab, C<\n> by a new-line character, and C<\\> by a back-slash.  a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will
1406    be deleted.
1407    
1408  =over 4  =over 4
1409    
# Line 555  Line 1425 
1425          my ($codedString) = @_;          my ($codedString) = @_;
1426          # Initialize the return variable.          # Initialize the return variable.
1427          my $retVal = "";          my $retVal = "";
1428        # Only proceed if the incoming string is nonempty.
1429        if (defined $codedString) {
1430          # Loop through the parameter string, looking for escape sequences. We can't do          # Loop through the parameter string, looking for escape sequences. We can't do
1431          # translating because it causes problems with the escaped slash. ("\\b" becomes          # translating because it causes problems with the escaped slash. ("\\t" becomes
1432          # "\ " no matter what we do.)          # "\<tab>" no matter what we do.)
1433          while (length $codedString > 0) {          while (length $codedString > 0) {
1434                  # Look for the first escape sequence.                  # Look for the first escape sequence.
1435                  if ($codedString =~ /^(.*?)\\(\\|b|n|t)/) {              if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {
1436                          # Here we found it. The text preceding the sequence is in $1. The sequence                          # Here we found it. The text preceding the sequence is in $1. The sequence
1437                          # itself is in $2. First, move the clear text to the return variable.                          # itself is in $2. First, move the clear text to the return variable.
1438                          $retVal .= $1;                          $retVal .= $1;
1439                          $codedString = substr $codedString, (2 + length $1);                          $codedString = substr $codedString, (2 + length $1);
1440                          # Decode the escape sequence.                  # Get the escape value.
1441                          my $char = $2;                          my $char = $2;
1442                          $char =~ tr/\\btn/\\ \t\n/;                  # If we have a "\r", we are done.
1443                    if ($char ne 'r') {
1444                        # Here it's not an 'r', so we convert it.
1445                        $char =~ tr/\\tn/\\\t\n/;
1446                          $retVal .= $char;                          $retVal .= $char;
1447                    }
1448                  } else {                  } else {
1449                          # Here there are no more escape sequences. The rest of the string is                          # Here there are no more escape sequences. The rest of the string is
1450                          # transferred unmodified.                          # transferred unmodified.
# Line 576  Line 1452 
1452                          $codedString = "";                          $codedString = "";
1453                  }                  }
1454          }          }
1455        }
1456          # Return the result.          # Return the result.
1457          return $retVal;          return $retVal;
1458  }  }
# Line 673  Line 1550 
1550          return @inputList;          return @inputList;
1551  }  }
1552    
1553    =head3 Percent
1554    
1555    C<< my $percent = Tracer::Percent($number, $base); >>
1556    
1557    Returns the percent of the base represented by the given number. If the base
1558    is zero, returns zero.
1559    
1560    =over 4
1561    
1562    =item number
1563    
1564    Percent numerator.
1565    
1566    =item base
1567    
1568    Percent base.
1569    
1570    =item RETURN
1571    
1572    Returns the percentage of the base represented by the numerator.
1573    
1574    =back
1575    
1576    =cut
1577    
1578    sub Percent {
1579        # Get the parameters.
1580        my ($number, $base) = @_;
1581        # Declare the return variable.
1582        my $retVal = 0;
1583        # Compute the percent.
1584        if ($base != 0) {
1585            $retVal = $number * 100 / $base;
1586        }
1587        # Return the result.
1588        return $retVal;
1589    }
1590    
1591  =head3 GetFile  =head3 GetFile
1592    
1593  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
1594    
1595  Return the entire contents of a file.      or
1596    
1597    C<< my $fileContents = Tracer::GetFile($fileName); >>
1598    
1599    Return the entire contents of a file. In list context, line-ends are removed and
1600    each line is a list element. In scalar context, line-ends are replaced by C<\n>.
1601    
1602  =over 4  =over 4
1603    
# Line 688  Line 1608 
1608  =item RETURN  =item RETURN
1609    
1610  In a list context, returns the entire file as a list with the line terminators removed.  In a list context, returns the entire file as a list with the line terminators removed.
1611  In a scalar context, returns the entire file as a string.  In a scalar context, returns the entire file as a string. If an error occurs opening
1612    the file, an empty list will be returned.
1613    
1614  =back  =back
1615    
# Line 700  Line 1621 
1621          # Declare the return variable.          # Declare the return variable.
1622          my @retVal = ();          my @retVal = ();
1623          # Open the file for input.          # Open the file for input.
1624          my $ok = open INPUTFILE, "<$fileName";      my $handle = Open(undef, "<$fileName");
1625          if (!$ok) {      # Read the whole file into the return variable, stripping off any terminator
                 # 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 {  
                 # Read the whole file into the return variable, stripping off an terminator  
1626          # characters.          # characters.
1627          my $lineCount = 0;          my $lineCount = 0;
1628                  while (my $line = <INPUTFILE>) {      while (my $line = <$handle>) {
1629              $lineCount++;              $lineCount++;
1630              $line =~ s/(\r|\n)+$//g;          $line = Strip($line);
1631                          push @retVal, $line;                          push @retVal, $line;
1632                  }                  }
1633                  # Close it.                  # Close it.
1634                  close INPUTFILE;      close $handle;
1635          my $actualLines = @retVal;          my $actualLines = @retVal;
         Trace("$lineCount lines read from $fileName. $actualLines processed.") if T(0);  
         }  
1636          # Return the file's contents in the desired format.          # Return the file's contents in the desired format.
1637      if (wantarray) {      if (wantarray) {
1638              return @retVal;              return @retVal;
# Line 726  Line 1641 
1641      }      }
1642  }  }
1643    
1644    =head3 PutFile
1645    
1646    C<< Tracer::PutFile($fileName, \@lines); >>
1647    
1648    Write out a file from a list of lines of text.
1649    
1650    =over 4
1651    
1652    =item fileName
1653    
1654    Name of the output file.
1655    
1656    =item lines
1657    
1658    Reference to a list of text lines. The lines will be written to the file in order, with trailing
1659    new-line characters. Alternatively, may be a string, in which case the string will be written without
1660    modification.
1661    
1662    =back
1663    
1664    =cut
1665    
1666    sub PutFile {
1667        # Get the parameters.
1668        my ($fileName, $lines) = @_;
1669        # Open the output file.
1670        my $handle = Open(undef, ">$fileName");
1671        if (ref $lines ne 'ARRAY') {
1672            # Here we have a scalar, so we write it raw.
1673            print $handle $lines;
1674        } else {
1675            # Write the lines one at a time.
1676            for my $line (@{$lines}) {
1677                print $handle "$line\n";
1678            }
1679        }
1680        # Close the output file.
1681        close $handle;
1682    }
1683    
1684  =head3 QTrace  =head3 QTrace
1685    
1686  C<< my $data = QTrace($format); >>  C<< my $data = QTrace($format); >>
# Line 747  Line 1702 
1702          my ($format) = @_;          my ($format) = @_;
1703          # Create the return variable.          # Create the return variable.
1704          my $retVal = "";          my $retVal = "";
1705        # Only proceed if there is an actual queue.
1706        if (@Queue) {
1707          # Process according to the format.          # Process according to the format.
1708          if ($format =~ m/^HTML$/i) {          if ($format =~ m/^HTML$/i) {
1709                  # Convert the queue into an HTML list.                  # Convert the queue into an HTML list.
# Line 762  Line 1719 
1719          }          }
1720          # Clear the queue.          # Clear the queue.
1721          @Queue = ();          @Queue = ();
1722        }
1723          # Return the formatted list.          # Return the formatted list.
1724          return $retVal;          return $retVal;
1725  }  }
# Line 770  Line 1728 
1728    
1729  C<< Confess($message); >>  C<< Confess($message); >>
1730    
1731  Trace the call stack and abort the program with the specified message. The stack  Trace the call stack and abort the program with the specified message. When used with
 trace will only appear if the trace level for this package is 1 or more. When used with  
1732  the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.  the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.
1733  So, for example  So, for example
1734    
# Line 793  Line 1750 
1750          # Get the parameters.          # Get the parameters.
1751          my ($message) = @_;          my ($message) = @_;
1752          # Trace the call stack.          # Trace the call stack.
1753          Cluck($message) if T(1);      Cluck($message);
1754          # Abort the program.          # Abort the program.
1755          croak(">>> $message");          croak(">>> $message");
1756  }  }
# Line 803  Line 1760 
1760  C<< Assert($condition1, $condition2, ... $conditionN); >>  C<< Assert($condition1, $condition2, ... $conditionN); >>
1761    
1762  Return TRUE if all the conditions are true. This method can be used in conjunction with  Return TRUE if all the conditions are true. This method can be used in conjunction with
1763  the OR operator and the L</Confess> method, B<Assert> can function as a debugging assert.  the OR operator and the L</Confess> method as a debugging assert.
1764  So, for example  So, for example
1765    
1766  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>
# Line 924  Line 1881 
1881    
1882  =head3 AddToListMap  =head3 AddToListMap
1883    
1884  C<< Tracer::AddToListMap(\%hash, $key, $value); >>  C<< Tracer::AddToListMap(\%hash, $key, $value1, $value2, ... valueN); >>
1885    
1886  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
1887  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 939  Line 1896 
1896    
1897  Key for which the value is to be added.  Key for which the value is to be added.
1898    
1899  =item value  =item value1, value2, ... valueN
1900    
1901  Value to add to the key's value list.  List of values to add to the key's value list.
1902    
1903  =back  =back
1904    
# Line 949  Line 1906 
1906    
1907  sub AddToListMap {  sub AddToListMap {
1908      # Get the parameters.      # Get the parameters.
1909      my ($hash, $key, $value) = @_;      my ($hash, $key, @values) = @_;
1910      # Process according to whether or not the key already has a value.      # Process according to whether or not the key already has a value.
1911      if (! exists $hash->{$key}) {      if (! exists $hash->{$key}) {
1912          $hash->{$key} = [$value];          $hash->{$key} = [@values];
1913        } else {
1914            push @{$hash->{$key}}, @values;
1915        }
1916    }
1917    
1918    =head3 DebugMode
1919    
1920    C<< if (Tracer::DebugMode) { ...code... } >>
1921    
1922    Return TRUE if debug mode has been turned on, else abort.
1923    
1924    Certain CGI scripts are too dangerous to exist in the production
1925    environment. This method provides a simple way to prevent them
1926    from working unless they are explicitly turned on by creating a password
1927    cookie via the B<SetPassword> script.  If debugging mode
1928    is not turned on, an error will occur.
1929    
1930    =cut
1931    
1932    sub DebugMode {
1933        # Declare the return variable.
1934        my $retVal = 0;
1935        # Check the debug configuration.
1936        my $password = CGI::cookie("DebugMode");
1937        my $encrypted = Digest::MD5::md5_hex($password);
1938        if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {
1939            $retVal = 1;
1940        } else {
1941            # Here debug mode is off, so we generate an error.
1942            Confess("Cannot use this facility without logging in.");
1943        }
1944        # Return the determination indicator.
1945        return $retVal;
1946    }
1947    
1948    =head3 Strip
1949    
1950    C<< my $string = Tracer::Strip($line); >>
1951    
1952    Strip all line terminators off a string. This is necessary when dealing with files
1953    that may have been transferred back and forth several times among different
1954    operating environments.
1955    
1956    =over 4
1957    
1958    =item line
1959    
1960    Line of text to be stripped.
1961    
1962    =item RETURN
1963    
1964    The same line of text with all the line-ending characters chopped from the end.
1965    
1966    =back
1967    
1968    =cut
1969    
1970    sub Strip {
1971        # Get a copy of the parameter string.
1972        my ($string) = @_;
1973        my $retVal = (defined $string ? $string : "");
1974        # Strip the line terminator characters.
1975        $retVal =~ s/(\r|\n)+$//g;
1976        # Return the result.
1977        return $retVal;
1978    }
1979    
1980    =head3 Pad
1981    
1982    C<< my $paddedString = Tracer::Pad($string, $len, $left, $padChar); >>
1983    
1984    Pad a string to a specified length. The pad character will be a
1985    space, and the padding will be on the right side unless specified
1986    in the third parameter.
1987    
1988    =over 4
1989    
1990    =item string
1991    
1992    String to be padded.
1993    
1994    =item len
1995    
1996    Desired length of the padded string.
1997    
1998    =item left (optional)
1999    
2000    TRUE if the string is to be left-padded; otherwise it will be padded on the right.
2001    
2002    =item padChar (optional)
2003    
2004    Character to use for padding. The default is a space.
2005    
2006    =item RETURN
2007    
2008    Returns a copy of the original string with the pad character added to the
2009    specified end so that it achieves the desired length.
2010    
2011    =back
2012    
2013    =cut
2014    
2015    sub Pad {
2016        # Get the parameters.
2017        my ($string, $len, $left, $padChar) = @_;
2018        # Compute the padding character.
2019        if (! defined $padChar) {
2020            $padChar = " ";
2021        }
2022        # Compute the number of spaces needed.
2023        my $needed = $len - length $string;
2024        # Copy the string into the return variable.
2025        my $retVal = $string;
2026        # Only proceed if padding is needed.
2027        if ($needed > 0) {
2028            # Create the pad string.
2029            my $pad = $padChar x $needed;
2030            # Affix it to the return value.
2031            if ($left) {
2032                $retVal = $pad . $retVal;
2033            } else {
2034                $retVal .= $pad;
2035            }
2036        }
2037        # Return the result.
2038        return $retVal;
2039    }
2040    
2041    =head3 EOF
2042    
2043    This is a constant that is lexically greater than any useful string.
2044    
2045    =cut
2046    
2047    sub EOF {
2048        return "\xFF\xFF\xFF\xFF\xFF";
2049    }
2050    
2051    =head3 TICK
2052    
2053    C<< my @results = TICK($commandString); >>
2054    
2055    Perform a back-tick operation on a command. If this is a Windows environment, any leading
2056    dot-slash (C<./> will be removed. So, for example, if you were doing
2057    
2058        `./protein.cgi`
2059    
2060    from inside a CGI script, it would work fine in Unix, but would issue an error message
2061    in Windows complaining that C<'.'> is not a valid command. If instead you code
2062    
2063        TICK("./protein.cgi")
2064    
2065    it will work correctly in both environments.
2066    
2067    =over 4
2068    
2069    =item commandString
2070    
2071    The command string to pass to the system.
2072    
2073    =item RETURN
2074    
2075    Returns the standard output from the specified command, as a list.
2076    
2077    =back
2078    
2079    =cut
2080    #: Return Type @;
2081    sub TICK {
2082        # Get the parameters.
2083        my ($commandString) = @_;
2084        # Chop off the dot-slash if this is Windows.
2085        if ($FIG_Config::win_mode) {
2086            $commandString =~ s!^\./!!;
2087        }
2088        # Activate the command and return the result.
2089        return `$commandString`;
2090    }
2091    
2092    =head3 ScriptSetup
2093    
2094    C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2095    
2096    Perform standard tracing and debugging setup for scripts. The value returned is
2097    the CGI object followed by a pre-built variable hash.
2098    
2099    The C<Trace> form parameter is used to determine whether or not tracing is active and
2100    which trace modules (other than C<Tracer> itself) should be turned on. Specifying
2101    the C<CGI> trace module will trace parameter and environment information. Parameters are
2102    traced at level 3 and environment variables at level 4. To trace to a file instead of to
2103    the web page, set C<TF> to 1. At the end of the script, the client should call
2104    L</ScriptFinish> to output the web page.
2105    
2106    In some situations, it is not practical to invoke tracing via form parameters. For this
2107    situation, you can turn on emergency tracing from the debugging control panel.
2108    Tracing will then be turned on automatically for all programs that use the L</ETracing>
2109    method, which includes every program that uses this method or L</StandardSetup>.
2110    
2111    =over 4
2112    
2113    =item noTrace (optional)
2114    
2115    If specified, tracing will be suppressed. This is useful if the script wants to set up
2116    tracing manually.
2117    
2118    =item RETURN
2119    
2120    Returns a two-element list consisting of a CGI query object and a variable hash for
2121    the output page.
2122    
2123    =back
2124    
2125    =cut
2126    
2127    sub ScriptSetup {
2128        # Get the parameters.
2129        my ($noTrace) = @_;
2130        # Get the CGI query object.
2131        my $cgi = CGI->new();
2132        # Set up tracing if it's not suppressed.
2133        ETracing($cgi) unless $noTrace;
2134        # Create the variable hash.
2135        my $varHash = { results => '' };
2136        # Return the query object and variable hash.
2137        return ($cgi, $varHash);
2138    }
2139    
2140    =head3 ETracing
2141    
2142    C<< ETracing($parameter); >>
2143    
2144    Set up emergency tracing. Emergency tracing is tracing that is turned
2145    on automatically for any program that calls this method. The emergency
2146    tracing parameters are stored in a a file identified by a tracing key.
2147    If this method is called with a CGI object, then the tracing key is
2148    taken from a cookie. If it is called with no parameters, then the tracing
2149    key is taken from an environment variable. If it is called with a string,
2150    the tracing key is that string.
2151    
2152    =over 4
2153    
2154    =item parameter
2155    
2156    A parameter from which the tracing key is computed. If it is a scalar,
2157    that scalar is used as the tracing key. If it is a CGI object, the
2158    tracing key is taken from the C<IP> cookie. If it is omitted, the
2159    tracing key is taken from the C<TRACING> environment variable. If it
2160    is a CGI object and emergency tracing is not on, the C<Trace> and
2161    C<TF> parameters will be used to determine the type of tracing.
2162    
2163    =back
2164    
2165    =cut
2166    
2167    sub ETracing {
2168        # Get the parameter.
2169        my ($parameter) = @_;
2170        # Check for CGI mode.
2171        my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);
2172        # Default to no tracing except errors.
2173        my ($tracing, $dest) = ("0", "WARN");
2174        # Check for emergency tracing.
2175        my $tkey = EmergencyKey($parameter);
2176        my $emergencyFile = EmergencyFileName($tkey);
2177        if (-e $emergencyFile) {
2178            # We have the file. Read in the data.
2179            my @tracing = GetFile($emergencyFile);
2180            # Pull off the time limit.
2181            my $expire = shift @tracing;
2182            # Convert it to seconds.
2183            $expire *= 3600;
2184            # Check the file data.
2185            my $stat = stat($emergencyFile);
2186            my ($now) = gettimeofday;
2187            if ($now - $stat->mtime > $expire) {
2188                # Delete the expired file.
2189                unlink $emergencyFile;
2190      } else {      } else {
2191          push @{$hash->{$key}}, $value;              # Emergency tracing is on. Pull off the destination and
2192                # the trace level;
2193                $dest = shift @tracing;
2194                my $level = shift @tracing;
2195                # Convert the destination to a real tracing destination.
2196                # temp directory.
2197                $dest = EmergencyTracingDest($tkey, $dest);
2198                # Insure Tracer is specified.
2199                my %moduleHash = map { $_ => 1 } @tracing;
2200                $moduleHash{Tracer} = 1;
2201                # Set the trace parameter.
2202                $tracing = join(" ", $level, sort keys %moduleHash);
2203            }
2204        } elsif (defined $cgi) {
2205            # There's no emergency tracing, but we have a CGI object, so check
2206            # for tracing from the form parameters.
2207            if ($cgi->param('Trace')) {
2208                # Here the user has requested tracing via a form.
2209                $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
2210                $tracing = $cgi->param('Trace') . " Tracer";
2211            }
2212        }
2213        # Setup the tracing we've determined from all the stuff above.
2214        TSetup($tracing, $dest);
2215        # If we're a web script, trace the parameter and environment data.
2216        if (defined $cgi) {
2217            TraceParms($cgi);
2218        }
2219    }
2220    
2221    =head3 EmergencyFileName
2222    
2223    C<< my $fileName = Tracer::EmergencyFileName($tkey); >>
2224    
2225    Return the emergency tracing file name. This is the file that specifies
2226    the tracing information.
2227    
2228    =over 4
2229    
2230    =item tkey
2231    
2232    Tracing key for the current program.
2233    
2234    =item RETURN
2235    
2236    Returns the name of the file to contain the emergency tracing information.
2237    
2238    =back
2239    
2240    =cut
2241    
2242    sub EmergencyFileName {
2243        # Get the parameters.
2244        my ($tkey) = @_;
2245        # Compute the emergency tracing file name.
2246        return "$FIG_Config::temp/Emergency$tkey.txt";
2247    }
2248    
2249    =head3 EmergencyFileTarget
2250    
2251    C<< my $fileName = Tracer::EmergencyFileTarget($tkey); >>
2252    
2253    Return the emergency tracing target file name. This is the file that receives
2254    the tracing output for file-based tracing.
2255    
2256    =over 4
2257    
2258    =item tkey
2259    
2260    Tracing key for the current program.
2261    
2262    =item RETURN
2263    
2264    Returns the name of the file to contain the trace output.
2265    
2266    =back
2267    
2268    =cut
2269    
2270    sub EmergencyFileTarget {
2271        # Get the parameters.
2272        my ($tkey) = @_;
2273        # Compute the emergency tracing file name.
2274        return "$FIG_Config::temp/trace$tkey.log";
2275      }      }
2276    
2277    =head3 EmergencyTracingDest
2278    
2279    C<< my $dest = Tracer::EmergencyTracingDest($tkey, $myDest); >>
2280    
2281    This method converts an emergency tracing destination to a real
2282    tracing destination. The main difference is that if the
2283    destination is C<FILE> or C<APPEND>, we convert it to file
2284    output.
2285    
2286    =over 4
2287    
2288    =item tkey
2289    
2290    Tracing key for this environment.
2291    
2292    =item myDest
2293    
2294    Destination from the emergency tracing file.
2295    
2296    =item RETURN
2297    
2298    Returns a destination that can be passed into L</TSetup>.
2299    
2300    =back
2301    
2302    =cut
2303    
2304    sub EmergencyTracingDest {
2305        # Get the parameters.
2306        my ($tkey, $myDest) = @_;
2307        # Declare the return variable.
2308        my $retVal;
2309        # Process according to the destination value.
2310        if ($myDest eq 'FILE') {
2311            $retVal = ">" . EmergencyFileTarget($tkey);
2312        } elsif ($myDest eq 'APPEND') {
2313            $retVal = ">>" . EmergencyFileTarget($tkey);
2314        } else {
2315            $retVal = $myDest;
2316        }
2317        # Return the result.
2318        return $retVal;
2319    }
2320    
2321    =head3 Emergency
2322    
2323    C<< Emergency($key, $hours, $dest, $level, @modules); >>
2324    
2325    Turn on emergency tracing. This method can only be invoked over the web and is
2326    should not be called if debug mode is off. The caller specifies the duration of the
2327    emergency in hours, the desired tracing destination, the trace level,
2328    and a list of the trace modules to activate. For the length of the duration, when a
2329    program in an environment with the specified tracing key active invokes a Sprout
2330    CGI script, tracing will be turned on automatically. See L</TSetup> for more
2331    about tracing setup and L</ETracing> for more about emergency tracing.
2332    
2333    =over 4
2334    
2335    =item tkey
2336    
2337    The tracing key. This is used to identify the control file and the trace file.
2338    
2339    =item hours
2340    
2341    Number of hours to keep emergency tracing alive.
2342    
2343    =item dest
2344    
2345    Tracing destination. If no path information is specified for a file
2346    destination, it is put in the FIG temporary directory.
2347    
2348    =item level
2349    
2350    Tracing level. A higher level means more trace messages.
2351    
2352    =item modules
2353    
2354    A list of the tracing modules to activate.
2355    
2356    =back
2357    
2358    =cut
2359    
2360    sub Emergency {
2361        # Get the parameters.
2362        my ($tkey, $hours, $dest, $level, @modules) = @_;
2363        # Create the emergency file.
2364        my $specFile = EmergencyFileName($tkey);
2365        my $outHandle = Open(undef, ">$specFile");
2366        print $outHandle join("\n", $hours, $dest, $level, @modules, "");
2367    }
2368    
2369    =head3 EmergencyKey
2370    
2371    C<< my $tkey = EmergencyKey($parameter); >>
2372    
2373    Return the Key to be used for emergency tracing. This could be an IP address,
2374     a session ID, or a user name, depending on the environment.
2375    
2376    =over 4
2377    
2378    =item parameter
2379    
2380    Parameter defining the method for finding the tracing key. If it is a scalar,
2381    then it is presumed to be the tracing key itself. If it is a CGI object, then
2382    the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
2383    taken from the C<TRACING> environment variable.
2384    
2385    =item RETURN
2386    
2387    Returns the key to be used for labels in emergency tracing.
2388    
2389    =back
2390    
2391    =cut
2392    
2393    sub EmergencyKey {
2394        # Get the parameters.
2395        my ($parameter) = @_;
2396        # Declare the return variable.
2397        my $retVal;
2398        # Determine the parameter type.
2399        if (! defined $parameter) {
2400            # Here we're supposed to check the environment.
2401            $retVal = $ENV{TRACING};
2402        } else {
2403            my $ptype = ref $parameter;
2404            if ($ptype eq 'CGI') {
2405                # Here we were invoked from a web page. Look for a cookie.
2406                $retVal = $parameter->cookie('IP');
2407            } elsif (! $ptype) {
2408                # Here the key was passed in.
2409                $retVal = $parameter;
2410            }
2411        }
2412        # If no luck finding a key, use the PID.
2413        if (! defined $retVal) {
2414            $retVal = $$;
2415        }
2416        # Return the result.
2417        return $retVal;
2418    }
2419    
2420    
2421    =head3 TraceParms
2422    
2423    C<< Tracer::TraceParms($cgi); >>
2424    
2425    Trace the CGI parameters at trace level CGI => 3 and the environment variables
2426    at level CGI => 4.
2427    
2428    =over 4
2429    
2430    =item cgi
2431    
2432    CGI query object containing the parameters to trace.
2433    
2434    =back
2435    
2436    =cut
2437    
2438    sub TraceParms {
2439        # Get the parameters.
2440        my ($cgi) = @_;
2441        if (T(CGI => 3)) {
2442            # Here we want to trace the parameter data.
2443            my @names = $cgi->param;
2444            for my $parmName (sort @names) {
2445                # Note we skip the Trace parameters, which are for our use only.
2446                if ($parmName ne 'Trace' && $parmName ne 'TF') {
2447                    my @values = $cgi->param($parmName);
2448                    Trace("CGI: $parmName = " . join(", ", @values));
2449                }
2450            }
2451            # Display the request method.
2452            my $method = $cgi->request_method();
2453            Trace("Method: $method");
2454        }
2455        if (T(CGI => 4)) {
2456            # Here we want the environment data too.
2457            for my $envName (sort keys %ENV) {
2458                Trace("ENV: $envName = $ENV{$envName}");
2459            }
2460        }
2461    }
2462    
2463    =head3 ScriptFinish
2464    
2465    C<< ScriptFinish($webData, $varHash); >>
2466    
2467    Output a web page at the end of a script. Either the string to be output or the
2468    name of a template file can be specified. If the second parameter is omitted,
2469    it is assumed we have a string to be output; otherwise, it is assumed we have the
2470    name of a template file. The template should have the variable C<DebugData>
2471    specified in any form that invokes a standard script. If debugging mode is turned
2472    on, a form field will be put in that allows the user to enter tracing data.
2473    Trace messages will be placed immediately before the terminal C<BODY> tag in
2474    the output, formatted as a list.
2475    
2476    A typical standard script would loook like the following.
2477    
2478        BEGIN {
2479            # Print the HTML header.
2480            print "CONTENT-TYPE: text/html\n\n";
2481        }
2482        use Tracer;
2483        use CGI;
2484        use FIG;
2485        # ... more uses ...
2486    
2487        my ($cgi, $varHash) = ScriptSetup();
2488        eval {
2489            # ... get data from $cgi, put it in $varHash ...
2490        };
2491        if ($@) {
2492            Trace("Script Error: $@") if T(0);
2493        }
2494        ScriptFinish("Html/MyTemplate.html", $varHash);
2495    
2496    The idea here is that even if the script fails, you'll see trace messages and
2497    useful output.
2498    
2499    =over 4
2500    
2501    =item webData
2502    
2503    A string containing either the full web page to be written to the output or the
2504    name of a template file from which the page is to be constructed. If the name
2505    of a template file is specified, then the second parameter must be present;
2506    otherwise, it must be absent.
2507    
2508    =item varHash (optional)
2509    
2510    If specified, then a reference to a hash mapping variable names for a template
2511    to their values. The template file will be read into memory, and variable markers
2512    will be replaced by data in this hash reference.
2513    
2514    =back
2515    
2516    =cut
2517    
2518    sub ScriptFinish {
2519        # Get the parameters.
2520        my ($webData, $varHash) = @_;
2521        # Check for a template file situation.
2522        my $outputString;
2523        if (defined $varHash) {
2524            # Here we have a template file. We need to determine the template type.
2525            my $template;
2526            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
2527                $template = "$FIG_Config::template_url/$webData";
2528            } else {
2529                $template = "<<$webData";
2530            }
2531            $outputString = PageBuilder::Build($template, $varHash, "Html");
2532        } else {
2533            # Here the user gave us a raw string.
2534            $outputString = $webData;
2535        }
2536        # Check for trace messages.
2537        if ($Destination ne "NONE" && $TraceLevel > 0) {
2538            # We have trace messages, so we want to put them at the end of the body. This
2539            # is either at the end of the whole string or at the beginning of the BODY
2540            # end-tag.
2541            my $pos = length $outputString;
2542            if ($outputString =~ m#</body>#gi) {
2543                $pos = (pos $outputString) - 7;
2544            }
2545            # If the trace messages were queued, we unroll them. Otherwise, we display the
2546            # destination.
2547            my $traceHtml;
2548            if ($Destination eq "QUEUE") {
2549                $traceHtml = QTrace('Html');
2550            } elsif ($Destination =~ /^>>(.+)$/) {
2551                # Here the tracing output it to a file. We code it as a hyperlink so the user
2552                # can copy the file name into the clipboard easily.
2553                my $actualDest = $1;
2554                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
2555            } else {
2556                # Here we have one of the special destinations.
2557                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
2558            }
2559            substr $outputString, $pos, 0, $traceHtml;
2560        }
2561        # Write the output string.
2562        print $outputString;
2563    }
2564    
2565    =head3 Insure
2566    
2567    C<< Insure($dirName); >>
2568    
2569    Insure a directory is present.
2570    
2571    =over 4
2572    
2573    =item dirName
2574    
2575    Name of the directory to check. If it does not exist, it will be created.
2576    
2577    =back
2578    
2579    =cut
2580    
2581    sub Insure {
2582        my ($dirName) = @_;
2583        if (! -d $dirName) {
2584            Trace("Creating $dirName directory.") if T(2);
2585            eval { mkpath $dirName; };
2586            if ($@) {
2587                Confess("Error creating $dirName: $@");
2588            }
2589        }
2590    }
2591    
2592    =head3 ChDir
2593    
2594    C<< ChDir($dirName); >>
2595    
2596    Change to the specified directory.
2597    
2598    =over 4
2599    
2600    =item dirName
2601    
2602    Name of the directory to which we want to change.
2603    
2604    =back
2605    
2606    =cut
2607    
2608    sub ChDir {
2609        my ($dirName) = @_;
2610        if (! -d $dirName) {
2611            Confess("Cannot change to directory $dirName: no such directory.");
2612        } else {
2613            Trace("Changing to directory $dirName.") if T(4);
2614            my $okFlag = chdir $dirName;
2615            if (! $okFlag) {
2616                Confess("Error switching to directory $dirName.");
2617            }
2618        }
2619    }
2620    
2621    =head3 SendSMS
2622    
2623    C<< my $msgID = Tracer::SendSMS($phoneNumber, $msg); >>
2624    
2625    Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
2626    user name, password, and API ID for the relevant account in the hash reference variable
2627    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
2628    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
2629    is C<2561022>, then the FIG_Config file must contain
2630    
2631        $phone =  { user => 'BruceTheHumanPet',
2632                    password => 'silly',
2633                    api_id => '2561022' };
2634    
2635    The original purpose of this method was to insure Bruce would be notified immediately when the
2636    Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
2637    when you call this method.
2638    
2639    The message ID will be returned if successful, and C<undef> if an error occurs.
2640    
2641    =over 4
2642    
2643    =item phoneNumber
2644    
2645    Phone number to receive the message, in international format. A United States phone number
2646    would be prefixed by "1". A British phone number would be prefixed by "44".
2647    
2648    =item msg
2649    
2650    Message to send to the specified phone.
2651    
2652    =item RETURN
2653    
2654    Returns the message ID if successful, and C<undef> if the message could not be sent.
2655    
2656    =back
2657    
2658    =cut
2659    
2660    sub SendSMS {
2661        # Get the parameters.
2662        my ($phoneNumber, $msg) = @_;
2663        # Declare the return variable. If we do not change it, C<undef> will be returned.
2664        my $retVal;
2665        # Only proceed if we have phone support.
2666        if (! defined $FIG_Config::phone) {
2667            Trace("Phone support not present in FIG_Config.") if T(1);
2668        } else {
2669            # Get the phone data.
2670            my $parms = $FIG_Config::phone;
2671            # Get the Clickatell URL.
2672            my $url = "http://api.clickatell.com/http/";
2673            # Create the user agent.
2674            my $ua = LWP::UserAgent->new;
2675            # Request a Clickatell session.
2676            my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
2677                                         password => $parms->{password},
2678                                         api_id => $parms->{api_id},
2679                                         to => $phoneNumber,
2680                                         text => $msg});
2681            # Check for an error.
2682            if (! $resp->is_success) {
2683                Trace("Alert failed.") if T(1);
2684            } else {
2685                # Get the message ID.
2686                my $rstring = $resp->content;
2687                if ($rstring =~ /^ID:\s+(.*)$/) {
2688                    $retVal = $1;
2689                } else {
2690                    Trace("Phone attempt failed with $rstring") if T(1);
2691                }
2692            }
2693        }
2694        # Return the result.
2695        return $retVal;
2696    }
2697    
2698    =head3 CommaFormat
2699    
2700    C<< my $formatted = Tracer::CommaFormat($number); >>
2701    
2702    Insert commas into a number.
2703    
2704    =over 4
2705    
2706    =item number
2707    
2708    A sequence of digits.
2709    
2710    =item RETURN
2711    
2712    Returns the same digits with commas strategically inserted.
2713    
2714    =back
2715    
2716    =cut
2717    
2718    sub CommaFormat {
2719        # Get the parameters.
2720        my ($number) = @_;
2721        # Pad the length up to a multiple of three.
2722        my $padded = "$number";
2723        $padded = " " . $padded while length($padded) % 3 != 0;
2724        # This is a fancy PERL trick. The parentheses in the SPLIT pattern
2725        # cause the delimiters to be included in the output stream. The
2726        # GREP removes the empty strings in between the delimiters.
2727        my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
2728        # Clean out the spaces.
2729        $retVal =~ s/ //g;
2730        # Return the result.
2731        return $retVal;
2732    }
2733    =head3 SetPermissions
2734    
2735    C<< Tracer::SetPermissions($dirName, $group, $mask, %otherMasks); >>
2736    
2737    Set the permissions for a directory and all the files and folders inside it.
2738    In addition, the group ownership will be changed to the specified value.
2739    
2740    This method is more vulnerable than most to permission and compatability
2741    problems, so it does internal error recovery.
2742    
2743    =over 4
2744    
2745    =item dirName
2746    
2747    Name of the directory to process.
2748    
2749    =item group
2750    
2751    Name of the group to be assigned.
2752    
2753    =item mask
2754    
2755    Permission mask. Bits that are C<1> in this mask will be ORed into the
2756    permission bits of any file or directory that does not already have them
2757    set to 1.
2758    
2759    =item otherMasks
2760    
2761    Map of search patterns to permission masks. If a directory name matches
2762    one of the patterns, that directory and all its members and subdirectories
2763    will be assigned the new pattern. For example, the following would
2764    assign 01664 to most files, but would use 01777 for directories named C<tmp>.
2765    
2766        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2767    
2768    The list is ordered, so the following would use 0777 for C<tmp1> and
2769    0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2770    
2771        Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2772                                                       '^tmp' => 0666);
2773    
2774    Note that the pattern matches are all case-insensitive, and only directory
2775    names are matched, not file names.
2776    
2777    =back
2778    
2779    =cut
2780    
2781    sub SetPermissions {
2782        # Get the parameters.
2783        my ($dirName, $group, $mask, @otherMasks) = @_;
2784        # Set up for error recovery.
2785        eval {
2786            # Switch to the specified directory.
2787            ChDir($dirName);
2788            # Get the group ID.
2789            my $gid = getgrnam($group);
2790            # Get the mask for tracing.
2791            my $traceMask = sprintf("%04o", $mask) . "($mask)";
2792            Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(2);
2793            my $fixCount = 0;
2794            my $lookCount = 0;
2795            # @dirs will be a stack of directories to be processed.
2796            my @dirs = (getcwd());
2797            while (scalar(@dirs) > 0) {
2798                # Get the current directory.
2799                my $dir = pop @dirs;
2800                # Check for a match to one of the specified directory names. To do
2801                # that, we need to pull the individual part of the name off of the
2802                # whole path.
2803                my $simpleName = $dir;
2804                if ($dir =~ m!/([^/]+)$!) {
2805                    $simpleName = $1;
2806                }
2807                Trace("Simple directory name for $dir is $simpleName.") if T(4);
2808                # Search for a match.
2809                my $match = 0;
2810                my $i;
2811                for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2812                    my $pattern = $otherMasks[$i];
2813                    if ($simpleName =~ /$pattern/i) {
2814                        $match = 1;
2815                    }
2816                }
2817                # Check for a match. Note we use $i-1 because the loop added 2
2818                # before terminating due to the match.
2819                if ($match && $otherMasks[$i-1] != $mask) {
2820                    # This directory matches one of the incoming patterns, and it's
2821                    # a different mask, so we process it recursively with that mask.
2822                    SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2823                } else {
2824                    # Here we can process normally. Get all of the non-hidden members.
2825                    my @submems = OpenDir($dir, 1);
2826                    for my $submem (@submems) {
2827                        # Get the full name.
2828                        my $thisMem = "$dir/$submem";
2829                        Trace("Checking member $thisMem.") if T(4);
2830                        $lookCount++;
2831                        if ($lookCount % 1000 == 0) {
2832                            Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(3);
2833                        }
2834                        # Fix the group.
2835                        chown -1, $gid, $thisMem;
2836                        # Insure this member is not a symlink.
2837                        if (! -l $thisMem) {
2838                            # Get its info.
2839                            my $fileInfo = stat $thisMem;
2840                            # Only proceed if we got the info. Otherwise, it's a hard link
2841                            # and we want to skip it anyway.
2842                            if ($fileInfo) {
2843                                my $fileMode = $fileInfo->mode;
2844                                if (($fileMode & $mask) != $mask) {
2845                                    # Fix this member.
2846                                    $fileMode |= $mask;
2847                                    chmod $fileMode, $thisMem;
2848                                    $fixCount++;
2849                                }
2850                                # If it's a subdirectory, stack it.
2851                                if (-d $thisMem) {
2852                                    push @dirs, $thisMem;
2853                                }
2854                            }
2855                        }
2856                    }
2857                }
2858            }
2859            Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);
2860        };
2861        # Check for an error.
2862        if ($@) {
2863            Confess("SetPermissions error: $@");
2864        }
2865    }
2866    
2867    =head3 CompareLists
2868    
2869    C<< my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex); >>
2870    
2871    Compare two lists of tuples, and return a hash analyzing the differences. The lists
2872    are presumed to be sorted alphabetically by the value in the $keyIndex column.
2873    The return value contains a list of items that are only in the new list
2874    (inserted) and only in the old list (deleted).
2875    
2876    =over 4
2877    
2878    =item newList
2879    
2880    Reference to a list of new tuples.
2881    
2882    =item oldList
2883    
2884    Reference to a list of old tuples.
2885    
2886    =item keyIndex (optional)
2887    
2888    Index into each tuple of its key field. The default is 0.
2889    
2890    =item RETURN
2891    
2892    Returns a 2-tuple consisting of a reference to the list of items that are only in the new
2893    list (inserted) followed by a reference to the list of items that are only in the old
2894    list (deleted).
2895    
2896    =back
2897    
2898    =cut
2899    
2900    sub CompareLists {
2901        # Get the parameters.
2902        my ($newList, $oldList, $keyIndex) = @_;
2903        if (! defined $keyIndex) {
2904            $keyIndex = 0;
2905        }
2906        # Declare the return variables.
2907        my ($inserted, $deleted) = ([], []);
2908        # Loop through the two lists simultaneously.
2909        my ($newI, $oldI) = (0, 0);
2910        my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
2911        while ($newI < $newN || $oldI < $oldN) {
2912            # Get the current object in each list. Note that if one
2913            # of the lists is past the end, we'll get undef.
2914            my $newItem = $newList->[$newI];
2915            my $oldItem = $oldList->[$oldI];
2916            if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
2917                # The old item is not in the new list, so mark it deleted.
2918                push @{$deleted}, $oldItem;
2919                $oldI++;
2920            } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
2921                # The new item is not in the old list, so mark it inserted.
2922                push @{$inserted}, $newItem;
2923                $newI++;
2924            } else {
2925                # The item is in both lists, so push forward.
2926                $oldI++;
2927                $newI++;
2928            }
2929        }
2930        # Return the result.
2931        return ($inserted, $deleted);
2932    }
2933    
2934    =head3 GetLine
2935    
2936    C<< my @data = Tracer::GetLine($handle); >>
2937    
2938    Read a line of data from a tab-delimited file.
2939    
2940    =over 4
2941    
2942    =item handle
2943    
2944    Open file handle from which to read.
2945    
2946    =item RETURN
2947    
2948    Returns a list of the fields in the record read. The fields are presumed to be
2949    tab-delimited. If we are at the end of the file, then an empty list will be
2950    returned. If an empty line is read, a single list item consisting of a null
2951    string will be returned.
2952    
2953    =back
2954    
2955    =cut
2956    
2957    sub GetLine {
2958        # Get the parameters.
2959        my ($handle) = @_;
2960        # Declare the return variable.
2961        my @retVal = ();
2962        # Read from the file.
2963        my $line = <$handle>;
2964        # Only proceed if we found something.
2965        if (defined $line) {
2966            # Remove the new-line.
2967            chomp $line;
2968            # If the line is empty, return a single empty string; otherwise, parse
2969            # it into fields.
2970            if ($line eq "") {
2971                push @retVal, "";
2972            } else {
2973                push @retVal, split /\t/,$line;
2974            }
2975        }
2976        # Return the result.
2977        return @retVal;
2978    }
2979    
2980    =head3 PutLine
2981    
2982    C<< Tracer::PutLine($handle, \@fields); >>
2983    
2984    Write a line of data to a tab-delimited file. The specified field values will be
2985    output in tab-separated form, with a trailing new-line.
2986    
2987    =over 4
2988    
2989    =item handle
2990    
2991    Output file handle.
2992    
2993    =item fields
2994    
2995    List of field values.
2996    
2997    =back
2998    
2999    =cut
3000    
3001    sub PutLine {
3002        # Get the parameters.
3003        my ($handle, $fields) = @_;
3004        # Write the data.
3005        print $handle join("\t", @{$fields}) . "\n";
3006    }
3007    
3008    =head3 GenerateURL
3009    
3010    C<< my $queryUrl = Tracer::GenerateURL($page, %parameters); >>
3011    
3012    Generate a GET-style URL for the specified page with the specified parameter
3013    names and values. The values will be URL-escaped automatically. So, for
3014    example
3015    
3016        Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3017    
3018    would return
3019    
3020        form.cgi?type=1&string=%22high%20pass%22%20or%20highway
3021    
3022    =over 4
3023    
3024    =item page
3025    
3026    Page URL.
3027    
3028    =item parameters
3029    
3030    Hash mapping parameter names to parameter values.
3031    
3032    =item RETURN
3033    
3034    Returns a GET-style URL that goes to the specified page and passes in the
3035    specified parameters and values.
3036    
3037    =back
3038    
3039    =cut
3040    
3041    sub GenerateURL {
3042        # Get the parameters.
3043        my ($page, %parameters) = @_;
3044        # Prime the return variable with the page URL.
3045        my $retVal = $page;
3046        # Loop through the parameters, creating parameter elements in a list.
3047        my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3048        # If the list is nonempty, tack it on.
3049        if (@parmList) {
3050            $retVal .= "?" . join("&", @parmList);
3051        }
3052        # Return the result.
3053        return $retVal;
3054  }  }
3055    
3056  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3