[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.23, Tue Sep 13 05:36:12 2005 UTC revision 1.38, Wed Feb 22 11:02:18 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        $options->{trace} = [2, "tracing level"];
378        $options->{sql} = [0, "turn on SQL tracing"];
379        $options->{h} = [0, "display command-line options"];
380        $options->{user} = [$$, "trace log file name suffix"];
381        # Create a parsing hash from the options hash. The parsing hash
382        # contains the default values rather than the default value
383        # and the description. While we're at it, we'll memorize the
384        # length of the longest option name.
385        my $longestName = 0;
386        my %parseOptions = ();
387        for my $key (keys %{$options}) {
388            if (length $key > $longestName) {
389                $longestName = length $key;
390            }
391            $parseOptions{$key} = $options->{$key}->[0];
392        }
393        # Parse the command line.
394        my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
395        # Now we want to set up tracing. First, we need to know if SQL is to
396        # be traced.
397        my @cats = @{$categories};
398        if ($retOptions->{sql}) {
399            push @cats, "SQL";
400        }
401        # Add the default categories.
402        push @cats, "Tracer", "FIG";
403        # Next, we create the category string by prefixing the trace level
404        # and joining the categories.
405        my $cats = join(" ", $parseOptions{trace}, @cats);
406        # Now set up the tracing.
407        my $suffix = $retOptions->{user};
408        TSetup($cats, "+>$FIG_Config::temp/trace$suffix.log");
409        # Check for the "h" option. If it is specified, dump the command-line
410        # options and exit the program.
411        if ($retOptions->{h}) {
412            $0 =~ m#[/\\](\w+)(\.pl)?$#i;
413            Trace("$1 [options] $parmHelp") if T(0);
414            for my $key (sort keys %{$options}) {
415                my $name = Pad($key, $longestName, 0, ' ');
416                my $desc = $options->{$key}->[1];
417                if ($options->{$key}->[0]) {
418                    $desc .= " (default " . $options->{$key}->[0] . ")";
419                }
420                Trace("  $name $desc") if T(0);
421            }
422            exit(0);
423        }
424        # Return the parsed parameters.
425        return ($retOptions, @retParameters);
426    }
427    
428  =head3 Setups  =head3 Setups
429    
430  C<< my $count = Tracer::Setups(); >>  C<< my $count = Tracer::Setups(); >>
# Line 348  Line 585 
585    
586  =head3 OpenDir  =head3 OpenDir
587    
588  C<< my @files = OpenDir($dirName, $filtered); >>  C<< my @files = OpenDir($dirName, $filtered, $flag); >>
589    
590  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
591  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
592  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<$>),
593  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
594  for example,  filtered out of the return list. If the directory does not open and I<$flag> is not
595    set, an exception is thrown. So, for example,
596    
597      my @files = OpenDir("/Volumes/fig/contigs", 1);      my @files = OpenDir("/Volumes/fig/contigs", 1);
598    
599  is effectively the same as  is effectively the same as
600    
601      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");      opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");
602      my @files = grep { $_ !~ /^\./ } readdir(TMP);      my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);
603    
604  Similarly, the following code  Similarly, the following code
605    
606      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs");      my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);
607    
608  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
609  automatically throws an error if the directory fails to open.  automatically returns an empty list if the directory fails to open.
610    
611  =over 4  =over 4
612    
# Line 381  Line 619 
619  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
620  from the list, else FALSE.  from the list, else FALSE.
621    
622    =item flag
623    
624    TRUE if a failure to open is okay, else FALSE
625    
626  =back  =back
627    
628  =cut  =cut
629  #: Return Type @;  #: Return Type @;
630  sub OpenDir {  sub OpenDir {
631      # Get the parameters.      # Get the parameters.
632      my ($dirName, $filtered) = @_;      my ($dirName, $filtered, $flag) = @_;
633      # Declare the return variable.      # Declare the return variable.
634      my @retVal;      my @retVal = ();
635      # Open the directory.      # Open the directory.
636      if (opendir(my $dirHandle, $dirName)) {      if (opendir(my $dirHandle, $dirName)) {
637          # The directory opened successfully. Get the appropriate list according to the          # The directory opened successfully. Get the appropriate list according to the
638          # strictures of the filter parameter.          # strictures of the filter parameter.
639          if ($filtered) {          if ($filtered) {
640              @retVal = grep { $_ !~ /^\./ } readdir $dirHandle;              @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;
641          } else {          } else {
642              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
643          }          }
644      } else {      } elsif (! $flag) {
645          # Here the directory would not open.          # Here the directory would not open and it's considered an error.
646          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
647      }      }
648      # Return the result.      # Return the result.
# Line 738  Line 980 
980          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
981          $category = lc $category;          $category = lc $category;
982          # Use the category and tracelevel to compute the result.          # Use the category and tracelevel to compute the result.
983            if (ref $traceLevel) {
984                Confess("Bad trace level.");
985            } elsif (ref $TraceLevel) {
986                Confess("Bad trace config.");
987            }
988          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));
989      }      }
990      # Return the computed result.      # Return the computed result.
# Line 824  Line 1071 
1071    
1072  C<< my $codedString = Tracer::Escape($realString); >>  C<< my $codedString = Tracer::Escape($realString); >>
1073    
1074  Escape a string for use in a command length. Spaces will be replaced by C<\b>,  Escape a string for use in a command length. Tabs will be replaced by C<\t>, new-lines
1075  tabs replaced by C<\t>, new-lines replaced by C<\n>, and backslashes will be  replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
1076  doubled. The effect is to exactly reverse the effect of L</UnEscape>.  result is to reverse the effect of L</UnEscape>.
1077    
1078  =over 4  =over 4
1079    
# Line 850  Line 1097 
1097      # Loop through the parameter string, looking for sequences to escape.      # Loop through the parameter string, looking for sequences to escape.
1098      while (length $realString > 0) {      while (length $realString > 0) {
1099          # Look for the first sequence to escape.          # Look for the first sequence to escape.
1100          if ($realString =~ /^(.*?)([ \n\t\\])/) {          if ($realString =~ /^(.*?)([\n\t\r\\])/) {
1101              # 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
1102              # 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.
1103              $retVal .= $1;              $retVal .= $1;
1104              # Strip the processed section off the real string.              # Strip the processed section off the real string.
1105              $realString = substr $realString, (length $2) + (length $1);              $realString = substr $realString, (length $2) + (length $1);
1106              # Encode the escape sequence.              # Get the matched character.
1107              my $char = $2;              my $char = $2;
1108              $char =~ tr/ \t\n/btn/;              # If we have a CR, we are done.
1109                if ($char ne "\r") {
1110                    # It's not a CR, so encode the escape sequence.
1111                    $char =~ tr/\t\n/tn/;
1112              $retVal .= "\\" . $char;              $retVal .= "\\" . $char;
1113                }
1114          } else {          } else {
1115              # 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
1116              # transferred unmodified.              # transferred unmodified.
# Line 875  Line 1126 
1126    
1127  C<< my $realString = Tracer::UnEscape($codedString); >>  C<< my $realString = Tracer::UnEscape($codedString); >>
1128    
1129  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
1130  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
1131    be deleted.
1132    
1133  =over 4  =over 4
1134    
# Line 896  Line 1148 
1148  sub UnEscape {  sub UnEscape {
1149      # Get the parameter.      # Get the parameter.
1150      my ($codedString) = @_;      my ($codedString) = @_;
     Tracer("Coded string is \"$codedString\".") if T(4);  
1151      # Initialize the return variable.      # Initialize the return variable.
1152      my $retVal = "";      my $retVal = "";
1153      # Only proceed if the incoming string is nonempty.      # Only proceed if the incoming string is nonempty.
1154      if (defined $codedString) {      if (defined $codedString) {
1155          # 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
1156          # translating because it causes problems with the escaped slash. ("\\b" becomes          # translating because it causes problems with the escaped slash. ("\\t" becomes
1157          # "\ " no matter what we do.)          # "\<tab>" no matter what we do.)
1158          while (length $codedString > 0) {          while (length $codedString > 0) {
1159              # Look for the first escape sequence.              # Look for the first escape sequence.
1160              if ($codedString =~ /^(.*?)\\(\\|b|n|t)/) {              if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {
1161                  # 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
1162                  # 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.
1163                  $retVal .= $1;                  $retVal .= $1;
1164                  $codedString = substr $codedString, (2 + length $1);                  $codedString = substr $codedString, (2 + length $1);
1165                  # Decode the escape sequence.                  # Get the escape value.
1166                  my $char = $2;                  my $char = $2;
1167                  $char =~ tr/\\btn/\\ \t\n/;                  # If we have a "\r", we are done.
1168                    if ($char ne 'r') {
1169                        # Here it's not an 'r', so we convert it.
1170                        $char =~ tr/\\tn/\\\t\n/;
1171                  $retVal .= $char;                  $retVal .= $char;
1172                    }
1173              } else {              } else {
1174                  # 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
1175                  # transferred unmodified.                  # transferred unmodified.
# Line 1024  Line 1279 
1279    
1280  C<< my @fileContents = Tracer::GetFile($fileName); >>  C<< my @fileContents = Tracer::GetFile($fileName); >>
1281    
1282  Return the entire contents of a file.      or
1283    
1284    C<< my $fileContents = Tracer::GetFile($fileName); >>
1285    
1286    Return the entire contents of a file. In list context, line-ends are removed and
1287    each line is a list element. In scalar context, line-ends are replaced by C<\n>.
1288    
1289  =over 4  =over 4
1290    
# Line 1151  Line 1411 
1411  C<< Assert($condition1, $condition2, ... $conditionN); >>  C<< Assert($condition1, $condition2, ... $conditionN); >>
1412    
1413  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
1414  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.
1415  So, for example  So, for example
1416    
1417  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>  C<< Assert($recNum >= 0) || Confess("Invalid record number $recNum."); >>
# Line 1364  Line 1624 
1624  sub Strip {  sub Strip {
1625      # Get a copy of the parameter string.      # Get a copy of the parameter string.
1626      my ($string) = @_;      my ($string) = @_;
1627      my $retVal = $string;      my $retVal = (defined $string ? $string : "");
1628      # Strip the line terminator characters.      # Strip the line terminator characters.
1629      $retVal =~ s/(\r|\n)+$//g;      $retVal =~ s/(\r|\n)+$//g;
1630      # Return the result.      # Return the result.
# Line 1432  Line 1692 
1692      return $retVal;      return $retVal;
1693  }  }
1694    
1695    =head3 EOF
1696    
1697    This is a constant that is lexically greater than any useful string.
1698    
1699    =cut
1700    
1701    sub EOF {
1702        return "\xFF\xFF\xFF\xFF\xFF";
1703    }
1704    
1705  =head3 TICK  =head3 TICK
1706    
1707  C<< my @results = TICK($commandString); >>  C<< my @results = TICK($commandString); >>
# Line 1473  Line 1743 
1743      return `$commandString`;      return `$commandString`;
1744  }  }
1745    
1746    =head3 ScriptSetup
1747    
1748    C<< my ($query, $varHash) = ScriptSetup(); >>
1749    
1750    Perform standard tracing and debugging setup for scripts. The value returned is
1751    the CGI object followed by a pre-built variable hash.
1752    
1753    The C<Trace> query parameter is used to determine whether or not tracing is active and
1754    which trace modules (other than C<Tracer> and C<FIG>) should be turned on. Specifying
1755    the C<CGI> trace module will trace parameter and environment information. Parameters are
1756    traced at level 3 and environment variables at level 4. At the end of the script, the
1757    client should call L</ScriptFinish> to output the web page.
1758    
1759    =cut
1760    
1761    sub ScriptSetup {
1762        # Get the CGI query object.
1763        my $query = CGI->new();
1764        # Check for tracing. Set it up if the user asked for it.
1765        if ($query->param('Trace')) {
1766            # Set up tracing to be queued for display at the bottom of the web page.
1767            TSetup($query->param('Trace') . " FIG Tracer", "QUEUE");
1768            # Trace the parameter and environment data.
1769            if (T(CGI => 3)) {
1770                # Here we want to trace the parameter data.
1771                my @names = $query->param;
1772                for my $parmName (sort @names) {
1773                    # Note we skip "Trace", which is for our use only.
1774                    if ($parmName ne 'Trace') {
1775                        my @values = $query->param($parmName);
1776                        Trace("CGI: $parmName = " . join(", ", @values));
1777                    }
1778                }
1779            }
1780            if (T(CGI => 4)) {
1781                # Here we want the environment data too.
1782                for my $envName (sort keys %ENV) {
1783                    Trace("ENV: $envName = $ENV{$envName}");
1784                }
1785            }
1786        } else {
1787            # Here tracing is to be turned off. All we allow is errors traced into the
1788            # error log.
1789            TSetup("0", "WARN");
1790        }
1791        # Create the variable hash.
1792        my $varHash = { DebugData => '' };
1793        # If we're in DEBUG mode, set up the debug mode data for forms.
1794        if (Tracer::DebugMode) {
1795            $varHash->{DebugData} = GetFile("Html/DebugFragment.html");
1796        }
1797        # Return the query object and variable hash.
1798        return ($query, $varHash);
1799    }
1800    
1801    =head3 ScriptFinish
1802    
1803    C<< ScriptFinish($webData, $varHash); >>
1804    
1805    Output a web page at the end of a script. Either the string to be output or the
1806    name of a template file can be specified. If the second parameter is omitted,
1807    it is assumed we have a string to be output; otherwise, it is assumed we have the
1808    name of a template file. The template should have the variable C<DebugData>
1809    specified in any form that invokes a standard script. If debugging mode is turned
1810    on, a form field will be put in that allows the user to enter tracing data.
1811    Trace messages will be placed immediately before the terminal C<BODY> tag in
1812    the output, formatted as a list.
1813    
1814    A typical standard script would loook like the following.
1815    
1816        BEGIN {
1817            # Print the HTML header.
1818            print "CONTENT-TYPE: text/html\n\n";
1819        }
1820        use Tracer;
1821        use CGI;
1822        use FIG;
1823        # ... more uses ...
1824    
1825        my ($query, $varHash) = ScriptSetup();
1826        eval {
1827            # ... get data from $query, put it in $varHash ...
1828        };
1829        if ($@) {
1830            Trace("Script Error: $@") if T(0);
1831        }
1832        ScriptFinish("Html/MyTemplate.html", $varHash);
1833    
1834    The idea here is that even if the script fails, you'll see trace messages and
1835    useful output.
1836    
1837    =over 4
1838    
1839    =item webData
1840    
1841    A string containing either the full web page to be written to the output or the
1842    name of a template file from which the page is to be constructed. If the name
1843    of a template file is specified, then the second parameter must be present;
1844    otherwise, it must be absent.
1845    
1846    =item varHash (optional)
1847    
1848    If specified, then a reference to a hash mapping variable names for a template
1849    to their values. The template file will be read into memory, and variable markers
1850    will be replaced by data in this hash reference.
1851    
1852    =back
1853    
1854    =cut
1855    
1856    sub ScriptFinish {
1857        # Get the parameters.
1858        my ($webData, $varHash) = @_;
1859        # Check for a template file situation.
1860        my $outputString;
1861        if (defined $varHash) {
1862            # Here we have a template file. We need to apply the variables to the template.
1863            $outputString = PageBuilder::Build("<$webData", $varHash, "Html");
1864        } else {
1865            # Here the user gave us a raw string.
1866            $outputString = $webData;
1867        }
1868        # Check for trace messages.
1869        if ($Destination eq "QUEUE") {
1870            # We have trace messages, so we want to put them at the end of the body. This
1871            # is either at the end of the whole string or at the beginning of the BODY
1872            # end-tag.
1873            my $pos = length $outputString;
1874            if ($outputString =~ m#</body>#gi) {
1875                $pos = (pos $outputString) - 7;
1876            }
1877            substr $outputString, $pos, 0, QTrace('Html');
1878        }
1879        # Write the output string.
1880        print $outputString;
1881    }
1882    
1883    =head3 Insure
1884    
1885    C<< Insure($dirName); >>
1886    
1887    Insure a directory is present.
1888    
1889    =over 4
1890    
1891    =item dirName
1892    
1893    Name of the directory to check. If it does not exist, it will be created.
1894    
1895    =back
1896    
1897    =cut
1898    
1899    sub Insure {
1900        my ($dirName) = @_;
1901        if (! -d $dirName) {
1902            Trace("Creating $dirName directory.") if T(2);
1903            mkpath $dirName;
1904        }
1905    }
1906    
1907  1;  1;

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.38

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3