[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.26, Wed Sep 14 13:09:53 2005 UTC revision 1.41, Wed Mar 15 21:59:29 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 Open OpenDir TICK);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup ScriptSetup ScriptFinish Insure);
23      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);
24      use strict;      use strict;
25      use Carp qw(longmess croak);      use Carp qw(longmess croak);
# Line 10  Line 27 
27      use FIG_Config;      use FIG_Config;
28      use PageBuilder;      use PageBuilder;
29      use Digest::MD5;      use Digest::MD5;
30        use File::Basename;
31        use File::Path;
32    
33  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
34    
# Line 72  Line 91 
91    
92  =over 4  =over 4
93    
94  =item 0 Error  =item Error 0
95    
96  Message indicates an error that may lead to incorrect results or that has stopped the  Message indicates an error that may lead to incorrect results or that has stopped the
97  application entirely.  application entirely.
98    
99  =item 1 Warning  =item Warning 1
100    
101  Message indicates something that is unexpected but that probably did not interfere  Message indicates something that is unexpected but that probably did not interfere
102  with program execution.  with program execution.
103    
104  =item 2 Notice  =item Notice 2
105    
106  Message indicates the beginning or end of a major task.  Message indicates the beginning or end of a major task.
107    
108  =item 3 Information  =item Information 3
109    
110  Message indicates a subtask. In the FIG system, a subtask generally relates to a single  Message indicates a subtask. In the FIG system, a subtask generally relates to a single
111  genome. This would be a big loop that is not expected to execute more than 500 times or so.  genome. This would be a big loop that is not expected to execute more than 500 times or so.
112    
113  =item 4 Detail  =item Detail 4
114    
115  Message indicates a low-level loop iteration.  Message indicates a low-level loop iteration.
116    
# Line 157  Line 176 
176      # Presume category-based tracing until we learn otherwise.      # Presume category-based tracing until we learn otherwise.
177      $AllTrace = 0;      $AllTrace = 0;
178      # Build the category hash. Note that if we find a "*", we turn on non-category      # Build the category hash. Note that if we find a "*", we turn on non-category
179      # tracing.      # tracing. We must also clear away any pre-existing data.
180        %Categories = ( main => 1 );
181      for my $category (@categoryData) {      for my $category (@categoryData) {
182          if ($category eq '*') {          if ($category eq '*') {
183              $AllTrace = 1;              $AllTrace = 1;
# Line 188  Line 208 
208      $SetupCount++;      $SetupCount++;
209  }  }
210    
211    =head3 StandardSetup
212    
213    C<< my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV); >>
214    
215    This method performs standard command-line parsing and tracing setup. The return
216    values are a hash of the command-line options and a list of the positional
217    parameters. Tracing is automatically set up and the command-line options are
218    validated.
219    
220    This is a complex method that does a lot of grunt work. The parameters can
221    be more easily understood, however, once they are examined individually.
222    
223    The I<categories> parameter is the most obtuse. It is a reference to a list of
224    special-purpose tracing categories. Most tracing categories are PERL package
225    names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
226    B<ERDB>, and B<SproutLoad> packages, you would specify the categories
227    
228        ["Sprout", "SproutLoad", "ERDB"]
229    
230    This would cause trace messages in the specified three packages to appear in
231    the output. There are threer special tracing categories that are automatically
232    handled by this method. In other words, if you used L</TSetup> you would need
233    to include these categories manually, but if you use this method they are turned
234    on automatically.
235    
236    =over 4
237    
238    =item FIG
239    
240    Turns on trace messages inside the B<FIG> package.
241    
242    =item SQL
243    
244    Traces SQL commands and activity.
245    
246    =item Tracer
247    
248    Traces error messages and call stacks.
249    
250    =back
251    
252    C<SQL> is only turned on if the C<-sql> option is specified in the command line.
253    The trace level is specified using the C<-trace> command-line option. For example,
254    the following command line for C<TransactFeatures> turns on SQL tracing and runs
255    all tracing at level 3.
256    
257        TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
258    
259    Standard tracing is output to the standard output and echoed to the file
260    C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
261    process ID. You can also specify the C<user> parameter to put a user ID
262    instead of a process ID in the trace file name. So, for example
263    
264    The default trace level is 2. To get all messages, specify a trace level of 4.
265    For a genome-by-genome update, use 3.
266    
267        TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
268    
269    would send the trace output to C<traceBruce.log> in the temporary directory.
270    
271    The I<options> parameter is a reference to a hash containing the command-line
272    options, their default values, and an explanation of what they mean. Command-line
273    options may be in the form of switches or keywords. In the case of a switch, the
274    option value is 1 if it is specified and 0 if it is not specified. In the case
275    of a keyword, the value is separated from the option name by an equal sign. You
276    can see this last in the command-line example above.
277    
278    An example at this point would help. Consider, for example, the command-line utility
279    C<TransactFeatures>. It accepts a list of positional parameters plus the options
280    C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
281    the following code.
282    
283        my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
284                            { safe => [0, "use database transactions"],
285                              noAlias => [0, "do not expect aliases in CHANGE transactions"],
286                              start => [' ', "start with this genome"],
287                              tblFiles => [0, "output TBL files containing the corrected IDs"] },
288                            "command transactionDirectory IDfile",
289                          @ARGV);
290    
291    
292    The call to C<ParseCommand> specifies the default values for the options and
293    stores the actual options in a hash that is returned as C<$options>. The
294    positional parameters are returned in C<@parameters>.
295    
296    The following is a sample command line for C<TransactFeatures>.
297    
298        TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
299    
300    In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
301    parameters, and would find themselves in I<@parameters> after executing the
302    above code fragment. The tracing would be set to level 2, and the categories
303    would be C<FIG>, C<Tracer>, and <DocUtils>. C<FIG> and C<Tracer> are standard,
304    and C<DocUtils> was included because it came in within the first parameter
305    to this method. The I<$options> hash would be
306    
307        { trace => 2, sql => 0, safe => 0,
308          noAlias => 1, start => ' ', tblFiles => 0 }
309    
310    Use of C<StandardSetup> in this way provides a simple way of performing
311    standard tracing setup and command-line parsing. Note that the caller is
312    not even aware of the command-line switches C<-trace> and C<-sql>, which
313    are used by this method to control the tracing. If additional tracing features
314    need to be added in the future, they can be processed by this method without
315    upsetting the command-line utilities.
316    
317    Finally, if the special option C<-h> is specified, the option names will
318    be traced at level 0 and the program will exit without processing.
319    This provides a limited help capability. For example, if the user enters
320    
321        TransactFeatures -h
322    
323    he would see the following output.
324    
325        TransactFeatures [options] command transactionDirectory IDfile
326            -trace    tracing level (default 2)
327            -sql      trace SQL commands
328            -safe     use database transactions
329            -noAlias  do not expect aliases in CHANGE transactions
330            -start    start with this genome
331            -tblFiles output TBL files containing the corrected IDs
332    
333    The parameters to this method are as follows.
334    
335    =over 4
336    
337    =item categories
338    
339    Reference to a list of tracing category names. These should be names of
340    packages whose internal workings will need to be debugged to get the
341    command working.
342    
343    =item options
344    
345    Reference to a hash containing the legal options for the current command mapped
346    to their default values and descriptions. The user can override the defaults
347    by specifying the options as command-line switches prefixed by a hyphen.
348    Tracing-related options may be added to this hash. If the C<-h> option is
349    specified on the command line, the option descriptions will be used to
350    explain the options.
351    
352    =item parmHelp
353    
354    A string that vaguely describes the positional parameters. This is used
355    if the user specifies the C<-h> option.
356    
357    =item ARGV
358    
359    List of command line parameters, including the option switches, which must
360    precede the positional parameters and be prefixed by a hyphen.
361    
362    =item RETURN
363    
364    Returns a list. The first element of the list is the reference to a hash that
365    maps the command-line option switches to their values. These will either be the
366    default values or overrides specified on the command line. The remaining
367    elements of the list are the position parameters, in order.
368    
369    =back
370    
371    =cut
372    
373    sub StandardSetup {
374        # Get the parameters.
375        my ($categories, $options, $parmHelp, @argv) = @_;
376        # Add the tracing options.
377        if (! exists $options->{trace}) {
378            $options->{trace} = [2, "tracing level"];
379        }
380        $options->{sql} = [0, "turn on SQL tracing"];
381        $options->{h} = [0, "display command-line options"];
382        $options->{user} = [$$, "trace log file name suffix"];
383        # Create a parsing hash from the options hash. The parsing hash
384        # contains the default values rather than the default value
385        # and the description. While we're at it, we'll memorize the
386        # length of the longest option name.
387        my $longestName = 0;
388        my %parseOptions = ();
389        for my $key (keys %{$options}) {
390            if (length $key > $longestName) {
391                $longestName = length $key;
392            }
393            $parseOptions{$key} = $options->{$key}->[0];
394        }
395        # Parse the command line.
396        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
397        # Now we want to set up tracing. First, we need to know if SQL is to
398        # be traced.
399        my @cats = @{$categories};
400        if ($retOptions->{sql}) {
401            push @cats, "SQL";
402        }
403        # Add the default categories.
404        push @cats, "Tracer", "FIG";
405        # Next, we create the category string by prefixing the trace level
406        # and joining the categories.
407        my $cats = join(" ", $parseOptions{trace}, @cats);
408        # Verify that we can open a file in the temporary directory.
409        my $traceMode = "TEXT";
410        my $suffix = $retOptions->{user};
411        my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
412        if (open TESTTRACE, ">$traceFileName") {
413            $traceMode = "+>$traceFileName";
414            close TESTTRACE;
415        }
416        # Now set up the tracing.
417        TSetup($cats, $traceMode);
418        # Check for the "h" option. If it is specified, dump the command-line
419        # options and exit the program.
420        if ($retOptions->{h}) {
421            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
422            Trace("$1 [options] $parmHelp") if T(0);
423            for my $key (sort keys %{$options}) {
424                my $name = Pad($key, $longestName, 0, ' ');
425                my $desc = $options->{$key}->[1];
426                if ($options->{$key}->[0]) {
427                    $desc .= " (default " . $options->{$key}->[0] . ")";
428                }
429                Trace("  $name $desc") if T(0);
430            }
431            exit(0);
432        }
433        # Return the parsed parameters.
434        return ($retOptions, @retParameters);
435    }
436    
437  =head3 Setups  =head3 Setups
438    
439  C<< my $count = Tracer::Setups(); >>  C<< my $count = Tracer::Setups(); >>
# Line 348  Line 594 
594    
595  =head3 OpenDir  =head3 OpenDir
596    
597  C<< my @files = OpenDir($dirName, $filtered); >>  C<< my @files = OpenDir($dirName, $filtered, $flag); >>
598    
599  Open a directory and return all the file names. This function essentially performs  Open a directory and return all the file names. This function essentially performs
600  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is  the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
601  set to TRUE, all filenames beginning with a period (C<.>) will be filtered out of  set to TRUE, all filenames beginning with a period (C<.>), dollar sign (C<$>),
602  the return list. If the directory does not open, an exception is thrown. So,  or pound sign (C<#>) and all filenames ending with a tilde C<~>) will be
603  for example,  filtered out of the return list. If the directory does not open and I<$flag> is not
604    set, an exception is thrown. So, for example,
605    
606      my @files = OpenDir("/Volumes/fig/contigs", 1);      my @files = OpenDir("/Volumes/fig/contigs", 1);
607    
608  is effectively the same as  is effectively the same as
609    
610      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");
611      my @files = grep { $_ !~ /^\./ } readdir(TMP);      my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);
612    
613  Similarly, the following code  Similarly, the following code
614    
615      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs");      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);
616    
617  Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and  Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and
618  automatically throws an error if the directory fails to open.  automatically returns an empty list if the directory fails to open.
619    
620  =over 4  =over 4
621    
# Line 381  Line 628 
628  TRUE if files whose names begin with a period (C<.>) should be automatically removed  TRUE if files whose names begin with a period (C<.>) should be automatically removed
629  from the list, else FALSE.  from the list, else FALSE.
630    
631    =item flag
632    
633    TRUE if a failure to open is okay, else FALSE
634    
635  =back  =back
636    
637  =cut  =cut
638  #: Return Type @;  #: Return Type @;
639  sub OpenDir {  sub OpenDir {
640      # Get the parameters.      # Get the parameters.
641      my ($dirName, $filtered) = @_;      my ($dirName, $filtered, $flag) = @_;
642      # Declare the return variable.      # Declare the return variable.
643      my @retVal;      my @retVal = ();
644      # Open the directory.      # Open the directory.
645      if (opendir(my $dirHandle, $dirName)) {      if (opendir(my $dirHandle, $dirName)) {
646          # The directory opened successfully. Get the appropriate list according to the          # The directory opened successfully. Get the appropriate list according to the
647          # strictures of the filter parameter.          # strictures of the filter parameter.
648          if ($filtered) {          if ($filtered) {
649              @retVal = grep { $_ !~ /^\./ } readdir $dirHandle;              @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;
650          } else {          } else {
651              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
652          }          }
653      } else {      } elsif (! $flag) {
654          # Here the directory would not open.          # Here the directory would not open and it's considered an error.
655          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
656      }      }
657      # Return the result.      # Return the result.
# Line 738  Line 989 
989          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
990          $category = lc $category;          $category = lc $category;
991          # Use the category and tracelevel to compute the result.          # Use the category and tracelevel to compute the result.
992            if (ref $traceLevel) {
993                Confess("Bad trace level.");
994            } elsif (ref $TraceLevel) {
995                Confess("Bad trace config.");
996            }
997          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));
998      }      }
999      # Return the computed result.      # Return the computed result.
# Line 825  Line 1081 
1081  C<< my $codedString = Tracer::Escape($realString); >>  C<< my $codedString = Tracer::Escape($realString); >>
1082    
1083  Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines  Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines
1084  replaced by C<\n>, and backslashes will be doubled. The effect is to exactly reverse the  replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
1085  effect of L</UnEscape>.  result is to reverse the effect of L</UnEscape>.
1086    
1087  =over 4  =over 4
1088    
# Line 850  Line 1106 
1106      # Loop through the parameter string, looking for sequences to escape.      # Loop through the parameter string, looking for sequences to escape.
1107      while (length $realString > 0) {      while (length $realString > 0) {
1108          # Look for the first sequence to escape.          # Look for the first sequence to escape.
1109          if ($realString =~ /^(.*?)([\n\t\\])/) {          if ($realString =~ /^(.*?)([\n\t\r\\])/) {
1110              # 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
1111              # 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.
1112              $retVal .= $1;              $retVal .= $1;
1113              # Strip the processed section off the real string.              # Strip the processed section off the real string.
1114              $realString = substr $realString, (length $2) + (length $1);              $realString = substr $realString, (length $2) + (length $1);
1115              # Encode the escape sequence.              # Get the matched character.
1116              my $char = $2;              my $char = $2;
1117                # If we have a CR, we are done.
1118                if ($char ne "\r") {
1119                    # It's not a CR, so encode the escape sequence.
1120              $char =~ tr/\t\n/tn/;              $char =~ tr/\t\n/tn/;
1121              $retVal .= "\\" . $char;              $retVal .= "\\" . $char;
1122                }
1123          } else {          } else {
1124              # 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
1125              # transferred unmodified.              # transferred unmodified.
# Line 876  Line 1136 
1136  C<< my $realString = Tracer::UnEscape($codedString); >>  C<< my $realString = Tracer::UnEscape($codedString); >>
1137    
1138  Replace escape sequences with their actual equivalents. C<\t> will be replaced by  Replace escape sequences with their actual equivalents. C<\t> will be replaced by
1139  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
1140    be deleted.
1141    
1142  =over 4  =over 4
1143    
# Line 905  Line 1166 
1166          # "\<tab>" no matter what we do.)          # "\<tab>" no matter what we do.)
1167          while (length $codedString > 0) {          while (length $codedString > 0) {
1168              # Look for the first escape sequence.              # Look for the first escape sequence.
1169              if ($codedString =~ /^(.*?)\\(\\|n|t)/) {              if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {
1170                  # 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
1171                  # 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.
1172                  $retVal .= $1;                  $retVal .= $1;
1173                  $codedString = substr $codedString, (2 + length $1);                  $codedString = substr $codedString, (2 + length $1);
1174                  # Decode the escape sequence.                  # Get the escape value.
1175                  my $char = $2;                  my $char = $2;
1176                    # If we have a "\r", we are done.
1177                    if ($char ne 'r') {
1178                        # Here it's not an 'r', so we convert it.
1179                  $char =~ tr/\\tn/\\\t\n/;                  $char =~ tr/\\tn/\\\t\n/;
1180                  $retVal .= $char;                  $retVal .= $char;
1181                    }
1182              } else {              } else {
1183                  # 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
1184                  # transferred unmodified.                  # transferred unmodified.
# Line 1023  Line 1288 
1288    
1289  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
1290    
1291  Return the entire contents of a file.      or
1292    
1293    C<< my $fileContents = Tracer::GetFile($fileName); >>
1294    
1295    Return the entire contents of a file. In list context, line-ends are removed and
1296    each line is a list element. In scalar context, line-ends are replaced by C<\n>.
1297    
1298  =over 4  =over 4
1299    
# Line 1034  Line 1304 
1304  =item RETURN  =item RETURN
1305    
1306  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.
1307  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
1308    the file, an empty list will be returned.
1309    
1310  =back  =back
1311    
# Line 1150  Line 1421 
1421  C<< Assert($condition1, $condition2, ... $conditionN); >>  C<< Assert($condition1, $condition2, ... $conditionN); >>
1422    
1423  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
1424  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.
1425  So, for example  So, for example
1426    
1427  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>
# Line 1363  Line 1634 
1634  sub Strip {  sub Strip {
1635      # Get a copy of the parameter string.      # Get a copy of the parameter string.
1636      my ($string) = @_;      my ($string) = @_;
1637      my $retVal = $string;      my $retVal = (defined $string ? $string : "");
1638      # Strip the line terminator characters.      # Strip the line terminator characters.
1639      $retVal =~ s/(\r|\n)+$//g;      $retVal =~ s/(\r|\n)+$//g;
1640      # Return the result.      # Return the result.
# Line 1431  Line 1702 
1702      return $retVal;      return $retVal;
1703  }  }
1704    
1705    =head3 EOF
1706    
1707    This is a constant that is lexically greater than any useful string.
1708    
1709    =cut
1710    
1711    sub EOF {
1712        return "\xFF\xFF\xFF\xFF\xFF";
1713    }
1714    
1715  =head3 TICK  =head3 TICK
1716    
1717  C<< my @results = TICK($commandString); >>  C<< my @results = TICK($commandString); >>
# Line 1472  Line 1753 
1753      return `$commandString`;      return `$commandString`;
1754  }  }
1755    
1756    =head3 ScriptSetup
1757    
1758    C<< my ($query, $varHash) = ScriptSetup(); >>
1759    
1760    Perform standard tracing and debugging setup for scripts. The value returned is
1761    the CGI object followed by a pre-built variable hash.
1762    
1763    The C<Trace> query parameter is used to determine whether or not tracing is active and
1764    which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying
1765    the C<CGI> trace module will trace parameter and environment information. Parameters are
1766    traced at level 3 and environment variables at level 4. At the end of the script, the
1767    client should call L</ScriptFinish> to output the web page.
1768    
1769    =cut
1770    
1771    sub ScriptSetup {
1772        # Get the CGI query object.
1773        my $query = CGI->new();
1774        # Check for tracing. Set it up if the user asked for it.
1775        if ($query->param('Trace')) {
1776            # Set up tracing to be queued for display at the bottom of the web page.
1777            TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");
1778            # Trace the parameter and environment data.
1779            if (T(CGI => 3)) {
1780                # Here we want to trace the parameter data.
1781                my @names = $query->param;
1782                for my $parmName (sort @names) {
1783                    # Note we skip "Trace", which is for our use only.
1784                    if ($parmName ne 'Trace') {
1785                        my @values = $query->param($parmName);
1786                        Trace("CGI: $parmName = " . join(", ", @values));
1787                    }
1788                }
1789            }
1790            if (T(CGI => 4)) {
1791                # Here we want the environment data too.
1792                for my $envName (sort keys %ENV) {
1793                    Trace("ENV: $envName = $ENV{$envName}");
1794                }
1795            }
1796        } else {
1797            # Here tracing is to be turned off. All we allow is errors traced into the
1798            # error log.
1799            TSetup("0", "WARN");
1800        }
1801        # Create the variable hash.
1802        my $varHash = { DebugData => '' };
1803        # If we're in DEBUG mode, set up the debug mode data for forms.
1804        if (Tracer::DebugMode) {
1805            $varHash->{DebugData} = GetFile("Html/DebugFragment.html");
1806        }
1807        # Return the query object and variable hash.
1808        return ($query, $varHash);
1809    }
1810    
1811    =head3 ScriptFinish
1812    
1813    C<< ScriptFinish($webData, $varHash); >>
1814    
1815    Output a web page at the end of a script. Either the string to be output or the
1816    name of a template file can be specified. If the second parameter is omitted,
1817    it is assumed we have a string to be output; otherwise, it is assumed we have the
1818    name of a template file. The template should have the variable C<DebugData>
1819    specified in any form that invokes a standard script. If debugging mode is turned
1820    on, a form field will be put in that allows the user to enter tracing data.
1821    Trace messages will be placed immediately before the terminal C<BODY> tag in
1822    the output, formatted as a list.
1823    
1824    A typical standard script would loook like the following.
1825    
1826        BEGIN {
1827            # Print the HTML header.
1828            print "CONTENT-TYPE: text/html\n\n";
1829        }
1830        use Tracer;
1831        use CGI;
1832        use FIG;
1833        # ... more uses ...
1834    
1835        my ($query, $varHash) = ScriptSetup();
1836        eval {
1837            # ... get data from $query, put it in $varHash ...
1838        };
1839        if ($@) {
1840            Trace("Script Error: $@") if T(0);
1841        }
1842        ScriptFinish("Html/MyTemplate.html", $varHash);
1843    
1844    The idea here is that even if the script fails, you'll see trace messages and
1845    useful output.
1846    
1847    =over 4
1848    
1849    =item webData
1850    
1851    A string containing either the full web page to be written to the output or the
1852    name of a template file from which the page is to be constructed. If the name
1853    of a template file is specified, then the second parameter must be present;
1854    otherwise, it must be absent.
1855    
1856    =item varHash (optional)
1857    
1858    If specified, then a reference to a hash mapping variable names for a template
1859    to their values. The template file will be read into memory, and variable markers
1860    will be replaced by data in this hash reference.
1861    
1862    =back
1863    
1864    =cut
1865    
1866    sub ScriptFinish {
1867        # Get the parameters.
1868        my ($webData, $varHash) = @_;
1869        # Check for a template file situation.
1870        my $outputString;
1871        if (defined $varHash) {
1872            # Here we have a template file. We need to apply the variables to the template.
1873            $outputString = PageBuilder::Build("<$webData", $varHash, "Html");
1874        } else {
1875            # Here the user gave us a raw string.
1876            $outputString = $webData;
1877        }
1878        # Check for trace messages.
1879        if ($Destination eq "QUEUE") {
1880            # We have trace messages, so we want to put them at the end of the body. This
1881            # is either at the end of the whole string or at the beginning of the BODY
1882            # end-tag.
1883            my $pos = length $outputString;
1884            if ($outputString =~ m#</body>#gi) {
1885                $pos = (pos $outputString) - 7;
1886            }
1887            substr $outputString, $pos, 0, QTrace('Html');
1888        }
1889        # Write the output string.
1890        print $outputString;
1891    }
1892    
1893    =head3 Insure
1894    
1895    C<< Insure($dirName); >>
1896    
1897    Insure a directory is present.
1898    
1899    =over 4
1900    
1901    =item dirName
1902    
1903    Name of the directory to check. If it does not exist, it will be created.
1904    
1905    =back
1906    
1907    =cut
1908    
1909    sub Insure {
1910        my ($dirName) = @_;
1911        if (! -d $dirName) {
1912            Trace("Creating $dirName directory.") if T(2);
1913            mkpath $dirName;
1914        }
1915    }
1916    
1917  1;  1;

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.41

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3