[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.96, Fri Apr 18 18:40:51 2008 UTC revision 1.97, Tue Apr 29 06:01:21 2008 UTC
# Line 20  Line 20 
20    
21      require Exporter;      require Exporter;
22      @ISA = ('Exporter');      @ISA = ('Exporter');
23      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing ScriptSetup ScriptFinish Insure ChDir Emergency);      @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency);
24      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape);      @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
25      use strict;      use strict;
26      use Carp qw(longmess croak carp);      use Carp qw(longmess croak carp);
27      use CGI;      use CGI;
# Line 160  Line 160 
160    
161  Sometimes, you need a way for tracing to happen automatically without putting parameters  Sometimes, you need a way for tracing to happen automatically without putting parameters
162  in a form or on the command line. Emergency tracing does this. You invoke emergency tracing  in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
163  from the debug form, which is accessed from I<MySeedInstance>C</FIG/Html/SetPassword.html>.  from the debug form, which is accessed from the [[DebugConsole]]. Emergency tracing requires
164  Emergency tracing requires you specify a tracing key. For command-line tools, the key is  that you specify a tracing key. For command-line tools, the key is
165  taken from the C<TRACING> environment variable. For web services, the key is taken from  taken from the C<TRACING> environment variable. For web services, the key is taken from
166  a cookie. Either way, the key tells the tracing facility who you are, so that you control  a cookie. Either way, the key tells the tracing facility who you are, so that you control
167  the tracing in your environment without stepping on other users.  the tracing in your environment without stepping on other users.
# Line 184  Line 184 
184    
185  The web script will look for the tracing key in the cookies, and the command-line  The web script will look for the tracing key in the cookies, and the command-line
186  script will look for it in the C<TRACING> environment variable. If you are  script will look for it in the C<TRACING> environment variable. If you are
187  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing  using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
188  will be configured automatically.  will be configured automatically.
189    
 NOTE: to configure emergency tracing from the command line instead of the Debugging  
 Control Panel (see below), use the C<trace.pl> script.  
   
 =head3 Debugging Control Panel  
   
 The debugging control panel provides several tools to assist in development of  
 SEED and Sprout software. You access the debugging control panel from the URL  
 C</FIG/Html/SetPassword.html> in whichever seed instance you're using. (So,  
 for example, the panel access point for the development NMPDR system is  
 C<http://web-1.nmpdr.org/next/FIG/Html/SetPassword.html>. Contact Bruce to  
 find out what the password is. From this page, you can also specify a tracing  
 key. If you don't specify a key, one will be generated for you.  
   
 =head4 Emergency Tracing Form  
   
 At the bottom of the debugging control panel is a form that allows you to  
 specify a trace level and tracing categories. Special and common categories  
 are listed with check boxes. You can hold your mouse over a check box to see  
 what its category does. In general, however, a category name is the same as  
 the name of the package in which the trace message occurs.  
   
 Additional categories can be entered in an input box, delimited by spaces or commas.  
   
 The B<Activate> button turns on Emergency tracing at the level you specify with the  
 specified categories active. The B<Terminate> button turns tracing off. The  
 B<Show File> button displays the current contents of the trace file. The tracing  
 form at the bottom of the control panel is designed for emergency tracing, so it  
 will only affect programs that call L</ETracing>, L</StandardScript>,  
 or L</StandardSetup>.  
   
 =head4 Script Form  
   
 The top form of the debugging control panel allows you to enter a tiny script and  
 have the output generated in a formatted table. Certain object variables are  
 predefined in the script, including a FIG object (C<$fig>), a CGI object (C<$cgi>),  
 and-- if Sprout is active-- Sprout (C<$sprout>) and SFXlate (C<$sfx>) objects.  
   
 The last line of the script must be a scalar, but it can be a reference to a hash,  
 a list, a list of lists, and various other combinations. If you select the appropriate  
 data type in the dropdown box, the output will be formatted accordingly. The form  
 also has controls for specifying tracing. These controls override any emergency  
 tracing in effect.  
   
 =head4 Database Query Forms  
   
 The forms between the script form and the emergency tracing form allow you to  
 make queries against the database. The FIG query form allows simple queries against  
 a single FIG table. The Sprout query form uses the B<GetAll> method to do a  
 multi-table query against the Sprout database. B<GetAll> is located in the B<ERDB>  
 package, and it takes five parameters.  
   
     GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count);  
   
 Each of the five parameters corresponds to a text box on the query form:  
   
 =over 4  
   
 =item Objects  
   
 Comma-separated list containing the names of the entity and relationship objects to be retrieved.  
   
 =item Filter  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)> or B<$I<number>(I<fieldName>)> where I<fieldName> is the name of a  
 field, I<objectName> is the name of the entity or relationship object containing the field, and  
 I<number> is the 1-based position of the object in the object list. Any parameters  
 specified in the filter clause should be specified in the B<Params> field.  
 The fields in a filter clause can come from primary entity relations,  
 relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item Params  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause. This  
 is a comma-separated list without any quoting or escaping.  
   
 =item fields  
   
 Comma-separated list of the fields to be returned in each element of the list returned. Fields  
 are specified in the same manner as in the filter clause.  
   
 =item count  
   
 Maximum number of records to return. If omitted or 0, all available records will be returned.  
   
 =back  
   
 B<GetAll> automatically joins together the entities and relationships listed in the object  
 names. This simplifies the coding of the filter clause, but it means that some queries are  
 not possible, since they cannot be expressed in a linear sequence of joins. This is a limitation  
 that has yet to be addressed.  
   
190  =cut  =cut
191    
192  # Declare the configuration variables.  # Declare the configuration variables.
# Line 290  Line 196 
196                              # standard output                              # standard output
197  my %Categories = ( main => 1 );  my %Categories = ( main => 1 );
198                              # hash of active category names                              # hash of active category names
199    my @LevelNames = qw(error warn notice info detail);
200  my $TraceLevel = 0;         # trace level; a higher trace level produces more  my $TraceLevel = 0;         # trace level; a higher trace level produces more
201                              # messages                              # messages
202  my @Queue = ();             # queued list of trace messages.  my @Queue = ();             # queued list of trace messages.
203  my $LastCategory = "main";  # name of the last category interrogated  my $LastCategory = "main";  # name of the last category interrogated
204    my $LastLevel = 0;          # level of the last test call
205  my $SetupCount = 0;         # number of times TSetup called  my $SetupCount = 0;         # number of times TSetup called
206  my $AllTrace = 0;           # TRUE if we are tracing all categories.  my $AllTrace = 0;           # TRUE if we are tracing all categories.
207    
# Line 375  Line 283 
283          }          }
284          if ($target =~ m/^>[^>]/) {          if ($target =~ m/^>[^>]/) {
285              open TRACEFILE, $target;              open TRACEFILE, $target;
286              print TRACEFILE "[" . Now() . "] <Tracer>: Tracing initialized.\n";              print TRACEFILE "[" . Now() . "] [Tracer] Tracing initialized.\n";
287              close TRACEFILE;              close TRACEFILE;
288              $Destination = ">$target";              $Destination = ">$target";
289          } else {          } else {
# Line 408  Line 316 
316      $TraceLevel = $_[0];      $TraceLevel = $_[0];
317  }  }
318    
319  =head3 ParseTraceDate  =head3 ParseDate
320    
321        my $time = Tracer::ParseDate($dateString);
322    
323    Convert a date into a PERL time number. This method expects a date-like string
324    and parses it into a number. The string must be vaguely date-like or it will
325    return an undefined value. Our requirement is that a month and day be
326    present and that three pieces of the date string (time of day, month and day,
327    year) be separated by likely delimiters, such as spaces, commas, and such-like.
328    
329    If a time of day is present, it must be in military time with two digits for
330    everything but the hour.
331    
332      my $time = Tracer::ParseTraceDate($dateString);  The year must be exactly four digits.
333    
334  Convert a date from the trace file into a PERL timestamp.  Additional stuff can be in the string. We presume it's time zones or weekdays or something
335    equally innocuous. This means, however, that a sufficiently long sentence with date-like
336    parts in it may be interpreted as a date. Hopefully this will not be a problem.
337    
338    It should be guaranteed that this method will parse the output of the L</Now> function.
339    
340    The parameters are as follows.
341    
342  =over 4  =over 4
343    
344  =item dateString  =item dateString
345    
346  The date string from the trace file. The format of the string is determined by the  The date string to convert.
 L</Now> method.  
347    
348  =item RETURN  =item RETURN
349    
350  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if  Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
351  the time string is invalid.  the date string is invalid. A valid date string must contain a month and day.
352    
353  =back  =back
354    
355  =cut  =cut
356    
357  sub ParseTraceDate {  # Universal month conversion table.
358    use constant MONTHS => {    Jan =>  0, January   =>  0, '01' =>  0,  '1' =>  0,
359                                Feb =>  1, February  =>  1, '02' =>  1,  '2' =>  1,
360                                Mar =>  2, March     =>  2, '03' =>  2,  '3' =>  2,
361                                Apr =>  3, April     =>  3, '04' =>  3,  '4' =>  3,
362                                May =>  4, May       =>  4, '05' =>  4,  '5' =>  4,
363                                Jun =>  5, June      =>  5, '06' =>  5,  '6' =>  5,
364                                Jul =>  6, July      =>  6, '07' =>  6,  '7' =>  6,
365                                Aug =>  7, August    =>  7, '08' =>  7,  '8' =>  7,
366                                Sep =>  8, September =>  8, '09' =>  8,  '9' =>  8,
367                                Oct =>  9, October  =>   9, '10' =>  9,
368                                Nov => 10, November =>  10, '11' => 10,
369                                Dec => 11, December =>  11, '12' => 11
370                            };
371    
372    sub ParseDate {
373      # Get the parameters.      # Get the parameters.
374      my ($dateString) = @_;      my ($dateString) = @_;
375      # Declare the return variable.      # Declare the return variable.
376      my $retVal;      my $retVal;
377      # Parse the date.      # Find the month and day of month. There are two ways that can happen. We check for the
378      if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {      # numeric style first. That way, if the user's done something like "Sun 12/22", then we
379          # Create a time object. Note we need to convert the day, month,      # won't be fooled into thinking the month is Sunday.
380          # and year to a different base. Years count from 1900, and      if ($dateString =~ m#\b(\d{1,2})/(\d{1,2})\b# || $dateString =~ m#\b(\w+)\s(\d{1,2})\b#) {
381          # the internal month value is relocated to January = 0.          my ($mon, $mday) = (MONTHS->{$1}, $2);
382          $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);          # Insist that the month and day are valid.
383            if (defined($mon) && $2 >= 1 && $2 <= 31) {
384                # Find the time.
385                my ($hour, $min, $sec) = (0, 0, 0);
386                if ($dateString =~ /\b(\d{1,2}):(\d{2}):(\d{2})\b/) {
387                    ($hour, $min, $sec) = ($1, $2, $3);
388                }
389                # Find the year.
390                my $year;
391                if ($dateString =~ /\b(\d{4})\b/) {
392                    $year = $1;
393                } else {
394                    # Get the default year, which is this one. Note we must convert it to
395                    # the four-digit value expected by "timelocal".
396                    (undef, undef, undef, undef, undef, $year) = localtime();
397                    $year += 1900;
398                }
399                $retVal = timelocal($sec, $min, $hour, $mday, $mon, $year);
400            }
401      }      }
402      # Return the result.      # Return the result.
403      return $retVal;      return $retVal;
# Line 489  Line 446 
446  sub Trace {  sub Trace {
447      # Get the parameters.      # Get the parameters.
448      my ($message) = @_;      my ($message) = @_;
449        # Strip off any line terminators at the end of the message. We will add
450        # new-line stuff ourselves.
451        my $stripped = Strip($message);
452        # Compute the caller information.
453        my ($callPackage, $callFile, $callLine) = caller();
454        my $callFileTitle = basename($callFile);
455        # Check the caller.
456        if ($callFileTitle ne "Tracer\.pm") {
457            # The caller isn't us, so add the caller info to the message.
458            $stripped = "[$callFileTitle $callLine] $stripped";
459        }
460      # Get the timestamp.      # Get the timestamp.
461      my $timeStamp = Now();      my $timeStamp = Now();
462      # Format the message. Note we strip off any line terminators at the end.      # Build the prefix.
463      my $prefix = "[$timeStamp] <$LastCategory>: ";      my $level = $LevelNames[$LastLevel] || "($LastLevel)";
464      my $formatted = $prefix . Strip($message);      my $prefix = "[$timeStamp] [$level] ";
465        # Format the message.
466        my $formatted = "$prefix $stripped";
467      # Process according to the destination.      # Process according to the destination.
468      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
469          # Write the message to the standard output.          # Write the message to the standard output.
470          print "$formatted\n";          print "$formatted\n";
471      } elsif ($Destination eq "ERROR") {      } elsif ($Destination eq "ERROR") {
472          # Write the message to the error output.          # Write the message to the error output. Here, we want our prefix fields.
473          print STDERR "$formatted\n";          print STDERR "$formatted\n";
474        } elsif ($Destination eq "WARN") {
475            # Emit the message to the standard error output. It is presumed that the
476            # error logger will add its own prefix fields
477            print STDERR "$stripped\n";
478      } elsif ($Destination eq "QUEUE") {      } elsif ($Destination eq "QUEUE") {
479          # Push the message into the queue.          # Push the message into the queue.
480          push @Queue, "$formatted";          push @Queue, "$formatted";
481      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
482          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML and write it to the standard output.
483          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($stripped);
484          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";          print "<p>$timeStamp $LastCategory $LastLevel: $escapedMessage</p>\n";
     } elsif ($Destination eq "WARN") {  
        # Emit the message as a warning.  
        carp $message;  
485      } elsif ($Destination =~ m/^>>/) {      } elsif ($Destination =~ m/^>>/) {
486          # Write the trace message to an output file.          # Write the trace message to an output file.
487          (open TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";          open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
488          print TRACING "$formatted\n";          print TRACING "$formatted\n";
489          close TRACING;          close TRACING;
490          # If the Tee flag is on, echo it to the standard output.          # If the Tee flag is on, echo it to the standard output.
# Line 576  Line 547 
547                  $category = $cats[$#cats];                  $category = $cats[$#cats];
548              }              }
549          }          }
550          # Save the category name.          # Save the category name and level.
551          $LastCategory = $category;          $LastCategory = $category;
552            $LastLevel = $traceLevel;
553          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
554          $category = lc $category;          $category = lc $category;
555          # Use the category and tracelevel to compute the result.          # Use the category and tracelevel to compute the result.
# Line 660  Line 632 
632  sub Confess {  sub Confess {
633      # Get the parameters.      # Get the parameters.
634      my ($message) = @_;      my ($message) = @_;
635        # Set up the category and level.
636        $LastCategory = "(confess)";
637        $LastLevel = 0;
638      if (! defined($FIG_Config::no_tool_hdr)) {      if (! defined($FIG_Config::no_tool_hdr)) {
639          # Here we have a tool header. Display its length so that the user can adjust the line numbers.          # Here we have a tool header. Display its length so that the user can adjust the line numbers.
640          my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";          my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
641          # Only proceed if the tool header file is actually present.          # Only proceed if the tool header file is actually present.
642          if (-f $toolHeaderFile) {          if (-f $toolHeaderFile) {
643              my @lines = GetFile($toolHeaderFile);              my $fh;
644                if (open $fh, "<$toolHeaderFile") {
645                    my @lines = <$fh>;
646              Trace("Tool header has " . scalar(@lines) . " lines.");              Trace("Tool header has " . scalar(@lines) . " lines.");
647          }          }
648      }      }
649        }
650      # Trace the call stack.      # Trace the call stack.
651      Cluck($message);      Cluck($message);
652      # Abort the program.      # Abort the program.
# Line 726  Line 704 
704      # Trace what's happening.      # Trace what's happening.
705      Trace("Stack trace for event: $message");      Trace("Stack trace for event: $message");
706      my $confession = longmess($message);      my $confession = longmess($message);
707      # Convert the confession to a series of trace messages. Note we skip any      # Convert the confession to a series of trace messages.
     # messages relating to calls into Tracer.  
708      for my $line (split /\s*\n/, $confession) {      for my $line (split /\s*\n/, $confession) {
709          Trace($line) if ($line !~ /Tracer\.pm/);          # Only proceed if this call trace is for a method outside Tracer itself.
710            if ($line !~ /Tracer\.pm/) {
711                # Replace the leading tab with a series of spaces.
712                $line =~ s/\t/    /;
713                # Trace the line.
714                Trace($line);
715            }
716      }      }
717  }  }
718    
719  =head3 ScriptSetup  =head3 ScriptSetup (deprecated)
720    
721      my ($cgi, $varHash) = ScriptSetup($noTrace);      my ($cgi, $varHash) = ScriptSetup($noTrace);
722    
# Line 958  Line 941 
941          $retVal = ">>" . EmergencyFileTarget($tkey);          $retVal = ">>" . EmergencyFileTarget($tkey);
942      } elsif ($myDest eq 'DUAL') {      } elsif ($myDest eq 'DUAL') {
943          $retVal = "+>" . EmergencyFileTarget($tkey);          $retVal = "+>" . EmergencyFileTarget($tkey);
944        } elsif ($myDest eq 'WARN') {
945            $retVal = "WARN";
946      }      }
947      # Return the result.      # Return the result.
948      return $retVal;      return $retVal;
# Line 1086  Line 1071 
1071      my ($cgi) = @_;      my ($cgi) = @_;
1072      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1073          # Here we trace the GET-style URL for the script.          # Here we trace the GET-style URL for the script.
1074          Trace("URL: " . $cgi->url(-relative => 1, -query => 1));          Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));
1075      }      }
1076      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1077          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1095  Line 1080 
1080              # Note we skip the Trace parameters, which are for our use only.              # Note we skip the Trace parameters, which are for our use only.
1081              if ($parmName ne 'Trace' && $parmName ne 'TF') {              if ($parmName ne 'Trace' && $parmName ne 'TF') {
1082                  my @values = $cgi->param($parmName);                  my @values = $cgi->param($parmName);
1083                  Trace("CGI: $parmName = " . join(", ", @values));                  Trace("[CGI] $parmName = " . join(", ", @values));
1084              }              }
1085          }          }
1086          # Display the request method.          # Display the request method.
# Line 1105  Line 1090 
1090      if (T(CGI => 4)) {      if (T(CGI => 4)) {
1091          # Here we want the environment data too.          # Here we want the environment data too.
1092          for my $envName (sort keys %ENV) {          for my $envName (sort keys %ENV) {
1093              Trace("ENV: $envName = $ENV{$envName}");              Trace("[ENV] $envName = $ENV{$envName}");
1094          }          }
1095      }      }
1096  }  }
# Line 1162  Line 1147 
1147  }  }
1148    
1149    
1150  =head3 ScriptFinish  =head3 ScriptFinish (deprecated)
1151    
1152      ScriptFinish($webData, $varHash);      ScriptFinish($webData, $varHash);
1153    
# Line 2584  Line 2569 
2569  }  }
2570    
2571    
2572    =head3 PrintLine
2573    
2574        Tracer::PrintLine($line);
2575    
2576    Print a line of text with a trailing new-line.
2577    
2578    =over 4
2579    
2580    =item line
2581    
2582    Line of text to print.
2583    
2584    =back
2585    
2586    =cut
2587    
2588    sub PrintLine {
2589        # Get the parameters.
2590        my ($line) = @_;
2591        # Print the line.
2592        print "$line\n";
2593    }
2594    
2595    
2596  =head2 Other Useful Methods  =head2 Other Useful Methods
2597    
# Line 2624  Line 2632 
2632      return $retVal;      return $retVal;
2633  }  }
2634    
   
   
   
2635  =head3 Now  =head3 Now
2636    
2637      my $string = Tracer::Now();      my $string = Tracer::Now();
2638    
2639  Return a displayable time stamp containing the local time.  Return a displayable time stamp containing the local time. Whatever format this
2640    method produces must be parseable by L</ParseDate>.
2641    
2642  =cut  =cut
2643    
2644  sub Now {  sub Now {
2645      my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);      return DisplayTime(time);
2646      my $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .  }
2647    
2648    =head3 DisplayTime
2649    
2650        my $string = Tracer::DisplayTime($time);
2651    
2652    Convert a time value to a displayable time stamp. Whatever format this
2653    method produces must be parseable by L</ParseDate>.
2654    
2655    =over 4
2656    
2657    =item time
2658    
2659    Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
2660    
2661    =item RETURN
2662    
2663    Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
2664    
2665    =back
2666    
2667    =cut
2668    
2669    sub DisplayTime {
2670        my ($time) = @_;
2671        my $retVal = "(n/a)";
2672        if (defined $time) {
2673            my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
2674            $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
2675                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);                   _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
2676        }
2677      return $retVal;      return $retVal;
2678  }  }
2679    
# Line 2802  Line 2837 
2837      return $retVal;      return $retVal;
2838  }  }
2839    
2840    =head3 Constrain
2841    
2842        my $constrained = Constrain($value, $min, $max);
2843    
2844    Modify a numeric value to bring it to a point in between a maximum and a minimum.
2845    
2846    =over 4
2847    
2848    =item value
2849    
2850    Value to constrain.
2851    
2852    =item min (optional)
2853    
2854    Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
2855    
2856    =item max (optional)
2857    
2858    Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
2859    
2860    =item RETURN
2861    
2862    Returns the incoming value, constrained according to the other parameters.
2863    
2864    =back
2865    
2866    =cut
2867    
2868    sub Constrain {
2869        # Get the parameters.
2870        my ($value, $min, $max) = @_;
2871        # Declare the return variable.
2872        my $retVal = $value;
2873        # Apply the minimum constraint.
2874        if (defined $min && $retVal < $min) {
2875            $retVal = $min;
2876        }
2877        # Apply the maximum constraint.
2878        if (defined $max && $retVal > $max) {
2879            $retVal = $max;
2880        }
2881        # Return the result.
2882        return $retVal;
2883    }
2884    
2885  =head3 Min  =head3 Min
2886    
2887      my $min = Min($value1, $value2, ... $valueN);      my $min = Min($value1, $value2, ... $valueN);
# Line 2868  Line 2948 
2948      return $retVal;      return $retVal;
2949  }  }
2950    
 =head3 DebugMode  
   
     if (Tracer::DebugMode) { ...code... }  
   
 Return TRUE if debug mode has been turned on, else abort.  
   
 Certain CGI scripts are too dangerous to exist in the production  
 environment. This method provides a simple way to prevent them  
 from working unless they are explicitly turned on by creating a password  
 cookie via the B<SetPassword> script.  If debugging mode  
 is not turned on, an error will occur.  
   
 =cut  
   
 sub DebugMode {  
     # Declare the return variable.  
     my $retVal = 0;  
     # Check the debug configuration.  
     my $password = CGI::cookie("DebugMode");  
     my $encrypted = Digest::MD5::md5_hex($password);  
     if ($encrypted eq "252dec43280e0c0d6a75ffcec486e61d") {  
         $retVal = 1;  
     } else {  
         # Here debug mode is off, so we generate an error.  
         Confess("Cannot use this facility without logging in.");  
     }  
     # Return the determination indicator.  
     return $retVal;  
 }  
2951    
2952  =head3 Strip  =head3 Strip
2953    
# Line 3340  Line 3391 
3391  }  }
3392    
3393    
3394    =head3 TrackingCode
3395    
3396        my $html = Tracer::TrackingCode();
3397    
3398    Returns the HTML code for doing web page traffic monitoring. If the
3399    current environment is a test system, then it returns a null string;
3400    otherwise, it returns a bunch of javascript containing code for turning
3401    on SiteMeter and Google Analytics.
3402    
3403    =cut
3404    
3405    sub TrackingCode {
3406        # Declare the return variable.
3407        my $retVal = "<!-- tracking off -->";
3408        # Determine if we're in production.
3409        if ($FIG_Config::site_meter) {
3410            $retVal = <<END_HTML
3411            <!-- Site Meter -->
3412            <script type="text/javascript" src="http://s20.sitemeter.com/js/counter.js?site=s20nmpdr">
3413            </script>
3414            <noscript>
3415            <a href="http://s20.sitemeter.com/stats.asp?site=s20nmpdr" target="_top">
3416            <img src="http://s20.sitemeter.com/meter.asp?site=s20nmpdr" alt="Site Meter" border="0"/></a>
3417            </noscript>
3418            <!-- Copyright (c)2006 Site Meter -->
3419    END_HTML
3420        }
3421        return $retVal;
3422    }
3423    
3424    
3425  1;  1;

Legend:
Removed from v.1.96  
changed lines
  Added in v.1.97

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3