[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.98, Thu May 1 07:52:10 2008 UTC revision 1.126, Wed Dec 16 20:00:53 2009 UTC
# Line 18  Line 18 
18    
19  package Tracer;  package Tracer;
20    
     require Exporter;  
     @ISA = ('Exporter');  
     @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency);  
     @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);  
21      use strict;      use strict;
22        use base qw(Exporter);
23        use vars qw(@EXPORT @EXPORT_OK);
24        @EXPORT = qw(Trace T TSetup QTrace Confess MemTrace Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency Warn TraceDump IDHASH);
25        @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
26      use Carp qw(longmess croak carp);      use Carp qw(longmess croak carp);
27      use CGI;      use CGI;
28      use Cwd;      use Cwd;
# Line 36  Line 36 
36      use Time::HiRes 'gettimeofday';      use Time::HiRes 'gettimeofday';
37      use URI::Escape;      use URI::Escape;
38      use Time::Local;      use Time::Local;
39        use POSIX qw(strftime);
40        use Time::Zone;
41        use Fcntl qw(:DEFAULT :flock);
42        use Data::Dumper;
43    
44    
45  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
46    
# Line 204  Line 209 
209  my $LastLevel = 0;          # level of the last test call  my $LastLevel = 0;          # level of the last test call
210  my $SetupCount = 0;         # number of times TSetup called  my $SetupCount = 0;         # number of times TSetup called
211  my $AllTrace = 0;           # TRUE if we are tracing all categories.  my $AllTrace = 0;           # TRUE if we are tracing all categories.
212    my $SavedCGI;               # CGI object passed to ETracing
213    my $CommandLine;            # Command line passed to StandardSetup
214    my $Confessions = 0;        # confession count
215    umask 2;                    # Fix the damn umask so everything is group-writable.
216    
217  =head2 Tracing Methods  =head2 Tracing Methods
218    
# Line 480  Line 489 
489          # Push the message into the queue.          # Push the message into the queue.
490          push @Queue, "$formatted";          push @Queue, "$formatted";
491      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
492          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML.
493          my $escapedMessage = CGI::escapeHTML($stripped);          my $escapedMessage = CGI::escapeHTML($stripped);
494          print "<p>$timeStamp $LastCategory $LastLevel: $escapedMessage</p>\n";          # The stuff after the first line feed should be pre-formatted.
495            my @lines = split /\s*\n/, $escapedMessage;
496            # Get the normal portion.
497            my $line1 = shift @lines;
498            print "<p>$timeStamp $LastCategory $LastLevel: $line1</p>\n";
499            if (@lines) {
500                print "<pre>" . join("\n", @lines, "</pre>");
501            }
502      } elsif ($Destination =~ m/^>>/) {      } elsif ($Destination =~ m/^>>/) {
503          # Write the trace message to an output file.          # Write the trace message to an output file.
504          open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";          open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
505            # Lock the file.
506            flock TRACING, LOCK_EX;
507          print TRACING "$formatted\n";          print TRACING "$formatted\n";
508          close TRACING;          close TRACING;
509          # 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 495  Line 513 
513      }      }
514  }  }
515    
516    =head3 MemTrace
517    
518        MemTrace($message);
519    
520    Output a trace message that includes memory size information.
521    
522    =over 4
523    
524    =item message
525    
526    Message to display. The message will be followed by a sentence about the memory size.
527    
528    =back
529    
530    =cut
531    
532    sub MemTrace {
533        # Get the parameters.
534        my ($message) = @_;
535        my $memory = GetMemorySize();
536        Trace("$message $memory in use.");
537    }
538    
539    
540    =head3 TraceDump
541    
542        TraceDump($title, $object);
543    
544    Dump an object to the trace log. This method simply calls the C<Dumper>
545    function, but routes the output to the trace log instead of returning it
546    as a string. The output is arranged so that it comes out monospaced when
547    it appears in an HTML trace dump.
548    
549    =over 4
550    
551    =item title
552    
553    Title to give to the object being dumped.
554    
555    =item object
556    
557    Reference to a list, hash, or object to dump.
558    
559    =back
560    
561    =cut
562    
563    sub TraceDump {
564        # Get the parameters.
565        my ($title, $object) = @_;
566        # Trace the object.
567        Trace("Object dump for $title:\n" . Dumper($object));
568    }
569    
570  =head3 T  =head3 T
571    
572      my $switch = T($category, $traceLevel);      my $switch = T($category, $traceLevel);
# Line 553  Line 625 
625          $LastLevel = $traceLevel;          $LastLevel = $traceLevel;
626          # Convert it to lower case before we hash it.          # Convert it to lower case before we hash it.
627          $category = lc $category;          $category = lc $category;
628          # Use the category and tracelevel to compute the result.          # Validate the trace level.
629          if (ref $traceLevel) {          if (ref $traceLevel) {
630              Confess("Bad trace level.");              Confess("Bad trace level.");
631          } elsif (ref $TraceLevel) {          } elsif (ref $TraceLevel) {
632              Confess("Bad trace config.");              Confess("Bad trace config.");
633          }          }
634          $retVal = ($traceLevel <= $TraceLevel && ($AllTrace || exists $Categories{$category}));          # Make the check. Note that level 0 shows even if the category is turned off.
635            $retVal = ($traceLevel <= $TraceLevel && ($traceLevel == 0 || $AllTrace || exists $Categories{$category}));
636      }      }
637      # Return the computed result.      # Return the computed result.
638      return $retVal;      return $retVal;
# Line 636  Line 709 
709      # Set up the category and level.      # Set up the category and level.
710      $LastCategory = "(confess)";      $LastCategory = "(confess)";
711      $LastLevel = 0;      $LastLevel = 0;
     if (! defined($FIG_Config::no_tool_hdr)) {  
         # Here we have a tool header. Display its length so that the user can adjust the line numbers.  
         my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";  
         # Only proceed if the tool header file is actually present.  
         if (-f $toolHeaderFile) {  
             my $fh;  
             if (open $fh, "<$toolHeaderFile") {  
                 my @lines = <$fh>;  
                 Trace("Tool header has " . scalar(@lines) . " lines.");  
             }  
         }  
     }  
712      # Trace the call stack.      # Trace the call stack.
713      Cluck($message);      Cluck($message);
714        # Increment the confession count.
715        $Confessions++;
716      # Abort the program.      # Abort the program.
717      croak(">>> $message");      croak(">>> $message");
718  }  }
719    
720    =head3 Confessions
721    
722        my $count = Tracer::Confessions();
723    
724    Return the number of calls to L</Confess> by the current task.
725    
726    =cut
727    
728    sub Confessions {
729        return $Confessions;
730    }
731    
732    
733    =head3 SaveCGI
734    
735        Tracer::SaveCGI($cgi);
736    
737    This method saves the CGI object but does not activate emergency tracing.
738    It is used to allow L</Warn> to work in situations where emergency
739    tracing is contra-indicated (e.g. the wiki).
740    
741    =over 4
742    
743    =item cgi
744    
745    Active CGI query object.
746    
747    =back
748    
749    =cut
750    
751    sub SaveCGI {
752        $SavedCGI = $_[0];
753    }
754    
755    =head3 Warn
756    
757        Warn($message, @options);
758    
759    This method traces an important message. If an RSS feed is configured
760    (via I<FIG_Config::error_feed>) and the tracing destination is C<WARN>,
761    then the message will be echoed to the feed. In general, a tracing
762    destination of C<WARN> indicates that the caller is running as a web
763    service in a production environment; however, this is not a requirement.
764    
765    To force warnings into the RSS feed even when the tracing destination
766    is not C<WARN>, simply specify the C<Feed> tracing module. This can be
767    configured automatically when L</StandardSetup> is used.
768    
769    The L</Cluck> method calls this one for its final message. Since
770    L</Confess> calls L</Cluck>, this means that any error which is caught
771    and confessed will put something in the feed. This insures that someone
772    will be alerted relatively quickly when a failure occurs.
773    
774    =over 4
775    
776    =item message
777    
778    Message to be traced.
779    
780    =item options
781    
782    A list containing zero or more options.
783    
784    =back
785    
786    The permissible options are as follows.
787    
788    =over 4
789    
790    =item noStack
791    
792    If specified, then the stack trace is not included in the output.
793    
794    =back
795    
796    =cut
797    
798    sub Warn {
799        # Get the parameters.
800        my $message = shift @_;
801        my %options = map { $_ => 1 } @_;
802        # Save $@;
803        my $savedError = $@;
804        # Trace the message.
805        Trace($message);
806        # This will contain the lock handle. If it's defined, it means we need to unlock.
807        my $lock;
808        # Check for feed forcing.
809        my $forceFeed = exists $Categories{feed};
810        # An error here would be disastrous. Note that if debug mode is specified,
811        # we do this stuff even in a test environment.
812        eval {
813            # Do we need to put this in the RSS feed?
814            if ($FIG_Config::error_feed && ($Destination eq 'WARN' || $forceFeed)) {
815                # Probably. We need to check first, however, to see if it's from an
816                # ignored IP. For non-CGI situations, we default the IP to the self-referent.
817                my $key = "127.0.0.1";
818                if (defined $SavedCGI) {
819                    # Get the IP address.
820                    $key = $ENV{HTTP_X_FORWARDED_FOR} || $ENV{REMOTE_ADDR};
821                }
822                # Is the IP address in the ignore list?
823                my $found = scalar(grep { $_ eq $key } @FIG_Config::error_ignore_ips);
824                if (! $found) {
825                    # No. We're good. We now need to compute the date, the link, and the title.
826                    # First, the date, in a very specific format.
827                    my $date = strftime("%a, %02e %b %H:%M:%S %Y ", localtime) .
828                        (tz_local_offset() / 30);
829                    # Environment data goes in here. We start with the date.
830                    my $environment = "$date.  ";
831                    # If we need to recap the message (because it's too long to be a title), we'll
832                    # put it in here.
833                    my $recap;
834                    # Copy the message and remove excess space.
835                    my $title = $message;
836                    $title =~ s/\s+/ /gs;
837                    # If it's too long, we have to split it up.
838                    if (length $title > 60) {
839                        # Put the full message in the environment string.
840                        $recap = $title;
841                        # Excerpt it as the title.
842                        $title = substr($title, 0, 50) . "...";
843                    }
844                    # If we have a CGI object, then this is a web error. Otherwise, it's
845                    # command-line.
846                    if (defined $SavedCGI) {
847                        # We're in a web service. The environment is the user's IP, and the link
848                        # is the URL that got us here.
849                        $environment .= "Event Reported at IP address $key process $$.";
850                        my $url = $SavedCGI->self_url();
851                        # We need the user agent string and (if available) the referrer.
852                        # The referrer will be the link.
853                        $environment .= " User Agent $ENV{HTTP_USER_AGENT}";
854                        if ($ENV{HTTP_REFERER}) {
855                            my $link = $ENV{HTTP_REFERER};
856                            $environment .= " referred from <a href=\"$link\">$link</a>.";
857                        } else {
858                            $environment .= " referrer unknown.";
859                        }
860                        # Close off the sentence with the original link.
861                        $environment .= " URL of event is <a href=\"$url\">$url</a>.";
862                    } else {
863                        # No CGI object, so we're a command-line tool. Use the tracing
864                        # key and the PID as the user identifier, and add the command.
865                        my $key = EmergencyKey();
866                        $environment .= "Event Reported by $key process $$.";
867                        if ($CommandLine) {
868                            # We're in a StandardSetup script, so we have the real command line.
869                            $environment .= "\n<pre>" . CGI::escapeHTML($CommandLine) . "</pre>\n";
870                        } elsif ($ENV{_}) {
871                            # We're in a BASH script, so the command has been stored in the _ variable.
872                            $environment .= "  Command = " . CGI::escapeHTML($ENV{_}) . "\n";
873                        }
874                    }
875                    # Build a GUID. We use the current time, the title, and the process ID,
876                    # then digest the result.
877                    my $guid = Digest::MD5::md5_base64(gettimeofday(), $title, $$);
878                    # Finally, the description. This is a stack trace plus various environmental stuff.
879                    # The trace is optional.
880                    my $stackTrace;
881                    if ($options{noStack}) {
882                        $stackTrace = "";
883                    } else {
884                        my @trace = LongMess();
885                        # Only proceed if we got something back.
886                        if (scalar(@trace) > 0) {
887                            $trace[0] =~ s/Tracer::Warn.+?called/Event occurred/;
888                            $stackTrace = "Stack trace:<pre>" . join("\n", @trace, "</pre>");
889                        }
890                    }
891                    # We got the stack trace. Now it's time to put it all together.
892                    # We have a goofy thing here in that we need to HTML-escape some sections of the description
893                    # twice. They will be escaped once here, and then once when written by XML::Simple. They are
894                    # unescaped once when processed by the RSS reader, and stuff in the description is treated as
895                    # HTML. So, anything escaped here is treated as a literal when viewed in the RSS reader, but
896                    # our <br>s and <pre>s are used to format the description.
897                    $recap = (defined $recap ? "<em>" . CGI::escapeHTML($recap) . "</em><br /><br />" : "");
898                    my $description = "$recap$environment  $stackTrace";
899                    # Okay, we have all the pieces. Create a hash of the new event.
900                    my $newItem = { title => $title,
901                                    description => $description,
902                                    category => $LastCategory,
903                                    pubDate => $date,
904                                    guid => $guid,
905                                  };
906                    # We need XML capability for this.
907                    require XML::Simple;
908                    # The RSS document goes in here.
909                    my $rss;
910                    # Get the name of the RSS file. It's in the FIG temporary directory.
911                    my $fileName = "$FIG_Config::temp/$FIG_Config::error_feed";
912                    # Open the config file and lock it.
913                    $lock = Open(undef, "<$FIG_Config::fig_disk/config/FIG_Config.pm");
914                    flock $lock, LOCK_EX;
915                    # Does it exist?
916                    if (-s $fileName) {
917                        # Slurp it in.
918                        $rss = XML::Simple::XMLin($fileName, ForceArray => ['item']);
919                    } else {
920                        my $size = -s $fileName;
921                        # Create an empty channel.
922                        $rss = {
923                            channel => {
924                                title => 'NMPDR Warning Feed',
925                                link => "$FIG_Config::temp_url/$FIG_Config::error_feed",
926                                description => "Important messages regarding the status of the NMPDR.",
927                                generator => "NMPDR Trace Facility",
928                                docs => "http://blogs.law.harvard.edu/tech/rss",
929                                item => []
930                            },
931                        };
932                    }
933                    # Get the channel object.
934                    my $channel = $rss->{channel};
935                    # Update the last-build date.
936                    $channel->{lastBuildDate} = $date;
937                    # Get the item array.
938                    my $items = $channel->{item};
939                    # Insure it has only 100 entries.
940                    while (scalar @{$items} > 100) {
941                        pop @{$items};
942                    }
943                    # Add our new item at the front.
944                    unshift @{$items}, $newItem;
945                    # Create the XML. Note we do not include the root or the declaration. XML Simple can't handle
946                    # the requirements for those.
947                    my $xml = XML::Simple::XMLout($channel, NoAttr => 1, RootName => 'channel', XmlDecl => '');
948                    # Here we put in the root and declaration. The problem is that the root has to have the version attribute
949                    # in it. So, we suppress the root and do it by hand, and that requires suppressing the declaration, too.
950                    $xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<rss version=\"2.0\">$xml\n</rss>";
951                    # We don't use Open here because we can't afford an error.
952                    if (open XMLOUT, ">$fileName") {
953                        print XMLOUT $xml;
954                        close XMLOUT;
955                    }
956                }
957            }
958        };
959        if ($@) {
960            # If the feed failed, we need to know why. The error will be traced, but this method will not be involved
961            # (which is a good thing).
962            my $error = $@;
963            Trace("Feed Error: $error") if T(Feed => 0);
964        }
965        # Be sure to unlock.
966        if ($lock) {
967            flock $lock, LOCK_UN;
968            undef $lock;
969        }
970        # Restore the error message.
971        $@ = $savedError;
972    }
973    
974    
975    
976    
977  =head3 Assert  =head3 Assert
978    
979      Assert($condition1, $condition2, ... $conditionN);      Assert($condition1, $condition2, ... $conditionN);
# Line 704  Line 1024 
1024      my ($message) = @_;      my ($message) = @_;
1025      # Trace what's happening.      # Trace what's happening.
1026      Trace("Stack trace for event: $message");      Trace("Stack trace for event: $message");
1027      my $confession = longmess($message);      # Get the stack trace.
1028      # Convert the confession to a series of trace messages.      my @trace = LongMess();
1029      for my $line (split /\s*\n/, $confession) {      # Convert the trace to a series of messages.
1030          # Only proceed if this call trace is for a method outside Tracer itself.      for my $line (@trace) {
1031          if ($line !~ /Tracer\.pm/) {          # Replace the tab at the beginning with spaces.
1032              # Replace the leading tab with a series of spaces.          $line =~ s/^\t/    /;
             $line =~ s/\t/    /;  
1033              # Trace the line.              # Trace the line.
1034              Trace($line);              Trace($line);
1035          }          }
1036        # Issue a warning. This displays the event message and inserts it into the RSS error feed.
1037        Warn($message);
1038      }      }
 }  
   
 =head3 ScriptSetup (deprecated)  
   
     my ($cgi, $varHash) = ScriptSetup($noTrace);  
   
 Perform standard tracing and debugging setup for scripts. The value returned is  
 the CGI object followed by a pre-built variable hash. At the end of the script,  
 the client should call L</ScriptFinish> to output the web page.  
   
 This method calls L</ETracing> to configure tracing, which allows the tracing  
 to be configured via the emergency tracing form on the debugging control panel.  
 Tracing will then be turned on automatically for all programs that use the L</ETracing>  
 method, which includes every program that uses this method or L</StandardSetup>.  
   
 =over 4  
   
 =item noTrace (optional)  
   
 If specified, tracing will be suppressed. This is useful if the script wants to set up  
 tracing manually.  
1039    
1040  =item RETURN  =head3 LongMess
1041    
1042  Returns a two-element list consisting of a CGI query object and a variable hash for      my @lines = Tracer::LongMess();
 the output page.  
1043    
1044  =back  Return a stack trace with all tracing methods removed. The return will be in the form of a list
1045    of message strings.
1046    
1047  =cut  =cut
1048    
1049  sub ScriptSetup {  sub LongMess {
1050      # Get the parameters.      # Declare the return variable.
1051      my ($noTrace) = @_;      my @retVal = ();
1052      # Get the CGI query object.      my $confession = longmess("");
1053      my $cgi = CGI->new();      for my $line (split /\s*\n/, $confession) {
1054      # Set up tracing if it's not suppressed.          unless ($line =~ /Tracer\.pm/) {
1055      ETracing($cgi) unless $noTrace;              # Here we have a line worth keeping. Push it onto the result list.
1056      # Create the variable hash.              push @retVal, $line;
1057      my $varHash = { results => '' };          }
1058      # Return the query object and variable hash.      }
1059      return ($cgi, $varHash);      # Return the result.
1060        return @retVal;
1061  }  }
1062    
1063  =head3 ETracing  =head3 ETracing
1064    
1065      ETracing($parameter);      ETracing($parameter, %options);
1066    
1067  Set up emergency tracing. Emergency tracing is tracing that is turned  Set up emergency tracing. Emergency tracing is tracing that is turned
1068  on automatically for any program that calls this method. The emergency  on automatically for any program that calls this method. The emergency
# Line 782  Line 1083 
1083  is a CGI object and emergency tracing is not on, the C<Trace> and  is a CGI object and emergency tracing is not on, the C<Trace> and
1084  C<TF> parameters will be used to determine the type of tracing.  C<TF> parameters will be used to determine the type of tracing.
1085    
1086    =item options
1087    
1088    Hash of options. The permissible options are given below.
1089    
1090    =over 8
1091    
1092    =item destType
1093    
1094    Emergency tracing destination type to use if no tracing file is found. The
1095    default is C<WARN>.
1096    
1097    =item noParms
1098    
1099    If TRUE, then display of the saved CGI parms is suppressed. The default is FALSE.
1100    
1101    =item level
1102    
1103    The trace level to use if no tracing file is found. The default is C<0>.
1104    
1105  =back  =back
1106    
1107  =cut  =cut
1108    
1109  sub ETracing {  sub ETracing {
1110      # Get the parameter.      # Get the parameter.
1111      my ($parameter) = @_;      my ($parameter, %options) = @_;
1112      # Check for CGI mode.      # Check for CGI mode.
1113      my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);      if (defined $parameter && ref $parameter eq 'CGI') {
1114      # Default to no tracing except errors.          $SavedCGI = $parameter;
1115      my ($tracing, $dest) = ("0", "WARN");      } else {
1116            $SavedCGI = undef;
1117        }
1118        # Check for the noParms option.
1119        my $noParms = $options{noParms} || 0;
1120        # Get the default tracing information.
1121        my $tracing = $options{level} || 0;
1122        my $dest = $options{destType} || "WARN";
1123      # Check for emergency tracing.      # Check for emergency tracing.
1124      my $tkey = EmergencyKey($parameter);      my $tkey = EmergencyKey($parameter);
1125        warn "Tracing key is $tkey.\n"; ##HACK
1126      my $emergencyFile = EmergencyFileName($tkey);      my $emergencyFile = EmergencyFileName($tkey);
1127      if (-e $emergencyFile) {      if (-e $emergencyFile) {
1128          # We have the file. Read in the data.          # We have the file. Read in the data.
# Line 814  Line 1142 
1142              # the trace level;              # the trace level;
1143              $dest = shift @tracing;              $dest = shift @tracing;
1144              my $level = shift @tracing;              my $level = shift @tracing;
             # Convert the destination to a real tracing destination.  
             # temp directory.  
             $dest = EmergencyTracingDest($tkey, $dest);  
1145              # Insure Tracer is specified.              # Insure Tracer is specified.
1146              my %moduleHash = map { $_ => 1 } @tracing;              my %moduleHash = map { $_ => 1 } @tracing;
1147              $moduleHash{Tracer} = 1;              $moduleHash{Tracer} = 1;
1148              # Set the trace parameter.              # Set the trace parameter.
1149              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
1150          }          }
     } elsif (defined $cgi) {  
         # There's no emergency tracing, but we have a CGI object, so check  
         # for tracing from the form parameters.  
         if ($cgi->param('Trace')) {  
             # Here the user has requested tracing via a form.  
             $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");  
             $tracing = $cgi->param('Trace') . " Tracer";  
         }  
1151      }      }
1152        # Convert the destination to a real tracing destination.
1153        warn "Tracing destination is $dest.\n"; ##HACK
1154        $dest = EmergencyTracingDest($tkey, $dest);
1155      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
1156        warn "TSetup is \"$tracing\", \"$dest\".\n"; ##HACK
1157      TSetup($tracing, $dest);      TSetup($tracing, $dest);
1158      # Check to see if we're a web script.      # Check to see if we're a web script.
1159      if (defined $cgi) {      if (defined $SavedCGI) {
1160          # Yes we are. Trace the form and environment data.          # Yes we are. Trace the form and environment data if it's not suppressed.
1161          TraceParms($cgi);          if (! $noParms) {
1162                TraceParms($SavedCGI);
1163            }
1164          # Check for RAW mode. In raw mode, we print a fake header so that we see everything          # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1165          # emitted by the script in its raw form.          # emitted by the script in its raw form.
1166          if (T(Raw => 3)) {          if (T(Raw => 3)) {
# Line 1028  Line 1351 
1351      # Declare the return variable.      # Declare the return variable.
1352      my $retVal;      my $retVal;
1353      # Determine the parameter type.      # Determine the parameter type.
1354      if (! defined $parameter) {      if (! defined $parameter || defined($ENV{TRACING})) {
1355          # Here we're supposed to check the environment.          # Here we're supposed to check the environment. If that fails, we
1356          $retVal = $ENV{TRACING};          # get the effective login ID.
1357            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1358      } else {      } else {
1359          my $ptype = ref $parameter;          my $ptype = ref $parameter;
1360          if ($ptype eq 'CGI') {          if ($ptype eq 'CGI') {
# Line 1071  Line 1395 
1395      # Get the parameters.      # Get the parameters.
1396      my ($cgi) = @_;      my ($cgi) = @_;
1397      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1398          # Here we trace the GET-style URL for the script.          # Here we trace the GET-style URL for the script, but only if it's
1399          Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));          # relatively small.
1400            my $url = $cgi->url(-relative => 1, -query => 1);
1401            my $len = length($url);
1402            if ($len < 500) {
1403                Trace("[URL] $url");
1404            } elsif ($len > 2048) {
1405                Trace("[URL] URL is too long to use with GET ($len characters).");
1406            } else {
1407                Trace("[URL] URL length is $len characters.");
1408            }
1409      }      }
1410      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1411          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1147  Line 1480 
1480      }      }
1481  }  }
1482    
1483    =head2 Command-Line Utility Methods
1484    
1485  =head3 ScriptFinish (deprecated)  =head3 SendSMS
   
     ScriptFinish($webData, $varHash);  
1486    
1487  Output a web page at the end of a script. Either the string to be output or the      my $msgID = Tracer::SendSMS($phoneNumber, $msg);
 name of a template file can be specified. If the second parameter is omitted,  
 it is assumed we have a string to be output; otherwise, it is assumed we have the  
 name of a template file. The template should have the variable C<DebugData>  
 specified in any form that invokes a standard script. If debugging mode is turned  
 on, a form field will be put in that allows the user to enter tracing data.  
 Trace messages will be placed immediately before the terminal C<BODY> tag in  
 the output, formatted as a list.  
1488    
1489  A typical standard script would loook like the following.  Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1490    user name, password, and API ID for the relevant account in the hash reference variable
1491    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1492    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1493    is C<2561022>, then the FIG_Config file must contain
1494    
1495      BEGIN {      $phone =  { user => 'BruceTheHumanPet',
1496          # Print the HTML header.                  password => 'silly',
1497          print "CONTENT-TYPE: text/html\n\n";                  api_id => '2561022' };
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
1498    
1499      my ($cgi, $varHash) = ScriptSetup();  The original purpose of this method was to insure Bruce would be notified immediately when the
1500      eval {  Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1501          # ... get data from $cgi, put it in $varHash ...  when you call this method.
     };  
     if ($@) {  
         Trace("Script Error: $@") if T(0);  
     }  
     ScriptFinish("Html/MyTemplate.html", $varHash);  
1502    
1503  The idea here is that even if the script fails, you'll see trace messages and  The message ID will be returned if successful, and C<undef> if an error occurs.
 useful output.  
1504    
1505  =over 4  =over 4
1506    
1507  =item webData  =item phoneNumber
1508    
1509  A string containing either the full web page to be written to the output or the  Phone number to receive the message, in international format. A United States phone number
1510  name of a template file from which the page is to be constructed. If the name  would be prefixed by "1". A British phone number would be prefixed by "44".
 of a template file is specified, then the second parameter must be present;  
 otherwise, it must be absent.  
1511    
1512  =item varHash (optional)  =item msg
1513    
1514  If specified, then a reference to a hash mapping variable names for a template  Message to send to the specified phone.
1515  to their values. The template file will be read into memory, and variable markers  
1516  will be replaced by data in this hash reference.  =item RETURN
1517    
1518    Returns the message ID if successful, and C<undef> if the message could not be sent.
1519    
1520  =back  =back
1521    
1522  =cut  =cut
1523    
1524  sub ScriptFinish {  sub SendSMS {
1525      # Get the parameters.      # Get the parameters.
1526      my ($webData, $varHash) = @_;      my ($phoneNumber, $msg) = @_;
1527      # Check for a template file situation.      # Declare the return variable. If we do not change it, C<undef> will be returned.
1528      my $outputString;      my $retVal;
1529      if (defined $varHash) {      # Only proceed if we have phone support.
1530          # Here we have a template file. We need to determine the template type.      if (! defined $FIG_Config::phone) {
1531          my $template;          Trace("Phone support not present in FIG_Config.") if T(1);
         if ($FIG_Config::template_url && $webData =~ /\.php$/) {  
             $template = "$FIG_Config::template_url/$webData";  
         } else {  
             $template = "<<$webData";  
         }  
         $outputString = PageBuilder::Build($template, $varHash, "Html");  
     } else {  
         # Here the user gave us a raw string.  
         $outputString = $webData;  
     }  
     # Check for trace messages.  
     if ($Destination ne "NONE" && $TraceLevel > 0) {  
         # We have trace messages, so we want to put them at the end of the body. This  
         # is either at the end of the whole string or at the beginning of the BODY  
         # end-tag.  
         my $pos = length $outputString;  
         if ($outputString =~ m#</body>#gi) {  
             $pos = (pos $outputString) - 7;  
         }  
         # If the trace messages were queued, we unroll them. Otherwise, we display the  
         # destination.  
         my $traceHtml;  
         if ($Destination eq "QUEUE") {  
             $traceHtml = QTrace('Html');  
         } elsif ($Destination =~ /^>>(.+)$/) {  
             # Here the tracing output it to a file. We code it as a hyperlink so the user  
             # can copy the file name into the clipboard easily.  
             my $actualDest = $1;  
             $traceHtml = "<p>Tracing output to $actualDest.</p>\n";  
         } else {  
             # Here we have one of the special destinations.  
             $traceHtml = "<P>Tracing output type is $Destination.</p>\n";  
         }  
         substr $outputString, $pos, 0, $traceHtml;  
     }  
     # Write the output string.  
     print $outputString;  
 }  
   
 =head2 Command-Line Utility Methods  
   
 =head3 SendSMS  
   
     my $msgID = Tracer::SendSMS($phoneNumber, $msg);  
   
 Send a text message to a phone number using Clickatell. The FIG_Config file must contain the  
 user name, password, and API ID for the relevant account in the hash reference variable  
 I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For  
 example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID  
 is C<2561022>, then the FIG_Config file must contain  
   
     $phone =  { user => 'BruceTheHumanPet',  
                 password => 'silly',  
                 api_id => '2561022' };  
   
 The original purpose of this method was to insure Bruce would be notified immediately when the  
 Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately  
 when you call this method.  
   
 The message ID will be returned if successful, and C<undef> if an error occurs.  
   
 =over 4  
   
 =item phoneNumber  
   
 Phone number to receive the message, in international format. A United States phone number  
 would be prefixed by "1". A British phone number would be prefixed by "44".  
   
 =item msg  
   
 Message to send to the specified phone.  
   
 =item RETURN  
   
 Returns the message ID if successful, and C<undef> if the message could not be sent.  
   
 =back  
   
 =cut  
   
 sub SendSMS {  
     # Get the parameters.  
     my ($phoneNumber, $msg) = @_;  
     # Declare the return variable. If we do not change it, C<undef> will be returned.  
     my $retVal;  
     # Only proceed if we have phone support.  
     if (! defined $FIG_Config::phone) {  
         Trace("Phone support not present in FIG_Config.") if T(1);  
1532      } else {      } else {
1533          # Get the phone data.          # Get the phone data.
1534          my $parms = $FIG_Config::phone;          my $parms = $FIG_Config::phone;
# Line 1454  Line 1684 
1684  Specifying a value of C<E> for the trace level causes emergency tracing to  Specifying a value of C<E> for the trace level causes emergency tracing to
1685  be used instead of custom tracing. If the user name is not specified,  be used instead of custom tracing. If the user name is not specified,
1686  the tracing key is taken from the C<Tracing> environment variable. If there  the tracing key is taken from the C<Tracing> environment variable. If there
1687  is no value for that variable, the tracing key will be computed from the PID.  is no value for that variable, the tracing key will be computed from the active
1688    login ID.
1689    
1690    Since the default situation in StandardSetup is to trace to the standard
1691    output, errors that occur in command-line scripts will not generate
1692    RSS events. To force the events, use the C<warn> option.
1693    
1694        TransactFeatures -background -warn register ../xacts IDs.tbl
1695    
1696  Finally, if the special option C<-help> is specified, the option  Finally, if the special option C<-help> is specified, the option
1697  names will be traced at level 0 and the program will exit without processing.  names will be traced at level 0 and the program will exit without processing.
# Line 1471  Line 1708 
1708          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
1709          -start    start with this genome          -start    start with this genome
1710          -tblFiles output TBL files containing the corrected IDs          -tblFiles output TBL files containing the corrected IDs
1711            -forked   do not erase the trace file before tracing
1712    
1713  The caller has the option of modifying the tracing scheme by placing a value  The caller has the option of modifying the tracing scheme by placing a value
1714  for C<trace> in the incoming options hash. The default value can be overridden,  for C<trace> in the incoming options hash. The default value can be overridden,
# Line 1534  Line 1772 
1772      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
1773      # Get the default tracing key.      # Get the default tracing key.
1774      my $tkey = EmergencyKey();      my $tkey = EmergencyKey();
1775        # Save the command line.
1776        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1777      # Add the tracing options.      # Add the tracing options.
1778      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
1779          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1780      }      }
1781        if (! exists $options->{forked}) {
1782            $options->{forked} = [0, "keep old trace file"];
1783        }
1784      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
1785      $options->{help} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
1786      $options->{user} = [$tkey, "tracing key"];      $options->{user} = [$tkey, "tracing key"];
1787      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
1788        $options->{warn} = [0, "send errors to RSS feed"];
1789        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1790      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
1791      # contains the default values rather than the default value      # contains the default values rather than the default value
1792      # and the description. While we're at it, we'll memorize the      # and the description. While we're at it, we'll memorize the
# Line 1558  Line 1803 
1803      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1804      # Get the logfile suffix.      # Get the logfile suffix.
1805      my $suffix = $retOptions->{user};      my $suffix = $retOptions->{user};
1806      # Check for background mode.      # We'll put the trace file name in here. We need it later if background
1807      if ($retOptions->{background}) {      # mode is on.
1808          my $outFileName = "$FIG_Config::temp/out$suffix.log";      my $traceFileName;
         my $errFileName = "$FIG_Config::temp/err$suffix.log";  
         open STDOUT, ">$outFileName";  
         open STDERR, ">$errFileName";  
         # Check for phone support. If we have phone support and a phone number,  
         # we want to turn it on.  
         if ($ENV{PHONE} && defined($FIG_Config::phone)) {  
             $retOptions->{phone} = $ENV{PHONE};  
         }  
     }  
1809      # Now we want to set up tracing. First, we need to know if the user      # Now we want to set up tracing. First, we need to know if the user
1810      # wants emergency tracing.      # wants emergency tracing.
1811      if ($retOptions->{trace} eq 'E') {      if ($retOptions->{trace} eq 'E') {
# Line 1580  Line 1816 
1816          if ($retOptions->{sql}) {          if ($retOptions->{sql}) {
1817              push @cats, "SQL";              push @cats, "SQL";
1818          }          }
1819            if ($retOptions->{warn}) {
1820                push @cats, "Feed";
1821            }
1822          # Add the default categories.          # Add the default categories.
1823          push @cats, "Tracer";          push @cats, "Tracer";
1824            # Check for more tracing groups.
1825            if ($retOptions->{moreTracing}) {
1826                push @cats, split /,/, $retOptions->{moreTracing};
1827            }
1828          # Next, we create the category string by joining the categories.          # Next, we create the category string by joining the categories.
1829          my $cats = join(" ", @cats);          my $cats = join(" ", @cats);
1830          # Check to determine whether or not the caller wants to turn off tracing          # Check to determine whether or not the caller wants to turn off tracing
# Line 1596  Line 1839 
1839          my $traceMode;          my $traceMode;
1840          # Verify that we can open a file in the FIG temporary directory.          # Verify that we can open a file in the FIG temporary directory.
1841          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1842          if (open TESTTRACE, ">$traceFileName") {          my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1843            if (open TESTTRACE, "$traceFileSpec") {
1844              # Here we can trace to a file.              # Here we can trace to a file.
1845              $traceMode = ">$traceFileName";              $traceMode = ">>$traceFileName";
1846              if ($textOKFlag) {              if ($textOKFlag) {
1847                  # Echo to standard output if the text-OK flag is set.                  # Echo to standard output if the text-OK flag is set.
1848                  $traceMode = "+$traceMode";                  $traceMode = "+$traceMode";
# Line 1619  Line 1863 
1863          # Now set up the tracing.          # Now set up the tracing.
1864          TSetup("$traceLevel $cats", $traceMode);          TSetup("$traceLevel $cats", $traceMode);
1865      }      }
1866        # Check for background mode.
1867        if ($retOptions->{background}) {
1868            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1869            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1870            # Spool the output.
1871            open STDOUT, ">$outFileName";
1872            # If we have a trace file, trace the errors to the log. Otherwise,
1873            # spool the errors.
1874            if (defined $traceFileName) {
1875                open STDERR, "| Tracer $traceFileName";
1876            } else {
1877                open STDERR, ">$errFileName";
1878            }
1879            # Check for phone support. If we have phone support and a phone number,
1880            # we want to turn it on.
1881            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1882                $retOptions->{phone} = $ENV{PHONE};
1883            }
1884        }
1885      # Check for the "help" option. If it is specified, dump the command-line      # Check for the "help" option. If it is specified, dump the command-line
1886      # options and exit the program.      # options and exit the program.
1887      if ($retOptions->{help}) {      if ($retOptions->{help}) {
# Line 1799  Line 2062 
2062      }      }
2063  }  }
2064    
2065    =head3 UnparseOptions
2066    
2067        my $optionString = Tracer::UnparseOptions(\%options);
2068    
2069    Convert an option hash into a command-line string. This will not
2070    necessarily be the same text that came in, but it will nonetheless
2071    produce the same ultimate result when parsed by L</StandardSetup>.
2072    
2073    =over 4
2074    
2075    =item options
2076    
2077    Reference to a hash of options to convert into an option string.
2078    
2079    =item RETURN
2080    
2081    Returns a string that will parse to the same set of options when
2082    parsed by L</StandardSetup>.
2083    
2084    =back
2085    
2086    =cut
2087    
2088    sub UnparseOptions {
2089        # Get the parameters.
2090        my ($options) = @_;
2091        # The option segments will be put in here.
2092        my @retVal = ();
2093        # Loop through the options.
2094        for my $key (keys %$options) {
2095            # Get the option value.
2096            my $value = $options->{$key};
2097            # Only use it if it's nonempty.
2098            if (defined $value && $value ne "") {
2099                my $segment = "--$key=$value";
2100                # Quote it if necessary.
2101                if ($segment =~ /[ |<>*]/) {
2102                    $segment = '"' . $segment . '"';
2103                }
2104                # Add it to the return list.
2105                push @retVal, $segment;
2106            }
2107        }
2108        # Return the result.
2109        return join(" ", @retVal);
2110    }
2111    
2112  =head3 ParseCommand  =head3 ParseCommand
2113    
2114      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
# Line 2271  Line 2581 
2581          } else {          } else {
2582              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2583          }          }
2584            closedir $dirHandle;
2585      } elsif (! $flag) {      } elsif (! $flag) {
2586          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2587          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 2377  Line 2688 
2688  Map of search patterns to permission masks. If a directory name matches  Map of search patterns to permission masks. If a directory name matches
2689  one of the patterns, that directory and all its members and subdirectories  one of the patterns, that directory and all its members and subdirectories
2690  will be assigned the new pattern. For example, the following would  will be assigned the new pattern. For example, the following would
2691  assign 01664 to most files, but would use 01777 for directories named C<tmp>.  assign 0664 to most files, but would use 0777 for directories named C<tmp>.
2692    
2693      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2694    
# Line 2430  Line 2741 
2741                      $match = 1;                      $match = 1;
2742                  }                  }
2743              }              }
2744              # Check for a match. Note we use $i-1 because the loop added 2              # Find out if we have a match. Note we use $i-1 because the loop added 2
2745              # before terminating due to the match.              # before terminating due to the match.
2746              if ($match && $otherMasks[$i-1] != $mask) {              if ($match && $otherMasks[$i-1] != $mask) {
2747                  # This directory matches one of the incoming patterns, and it's                  # This directory matches one of the incoming patterns, and it's
# Line 2598  Line 2909 
2909    
2910  =head2 Other Useful Methods  =head2 Other Useful Methods
2911    
2912    =head3 IDHASH
2913    
2914        my $hash = SHTargetSearch::IDHASH(@keys);
2915    
2916    This is a dinky little method that converts a list of values to a reference
2917    to hash of values to labels. The values and labels are the same.
2918    
2919    =cut
2920    
2921    sub IDHASH {
2922        my %retVal = map { $_ => $_ } @_;
2923        return \%retVal;
2924    }
2925    
2926    =head3 Pluralize
2927    
2928        my $plural = Tracer::Pluralize($word);
2929    
2930    This is a very simple pluralization utility. It adds an C<s> at the end
2931    of the input word unless it already ends in an C<s>, in which case it
2932    adds C<es>.
2933    
2934    =over 4
2935    
2936    =item word
2937    
2938    Singular word to pluralize.
2939    
2940    =item RETURN
2941    
2942    Returns the probable plural form of the word.
2943    
2944    =back
2945    
2946    =cut
2947    
2948    sub Pluralize {
2949        # Get the parameters.
2950        my ($word) = @_;
2951        # Declare the return variable.
2952        my $retVal;
2953        if ($word =~ /s$/) {
2954            $retVal = $word . 'es';
2955        } else {
2956            $retVal = $word . 's';
2957        }
2958        # Return the result.
2959        return $retVal;
2960    }
2961    
2962    =head3 Numeric
2963    
2964        my $okFlag = Tracer::Numeric($string);
2965    
2966    Return the value of the specified string if it is numeric, or an undefined value
2967    if it is not numeric.
2968    
2969    =over 4
2970    
2971    =item string
2972    
2973    String to check.
2974    
2975    =item RETURN
2976    
2977    Returns the numeric value of the string if successful, or C<undef> if the string
2978    is not numeric.
2979    
2980    =back
2981    
2982    =cut
2983    
2984    sub Numeric {
2985        # Get the parameters.
2986        my ($string) = @_;
2987        # We'll put the value in here if we succeed.
2988        my $retVal;
2989        # Get a working copy of the string.
2990        my $copy = $string;
2991        # Trim leading and trailing spaces.
2992        $copy =~ s/^\s+//;
2993        $copy =~ s/\s+$//;
2994        # Check the result.
2995        if ($copy =~ /^[+-]?\d+$/) {
2996            $retVal = $copy;
2997        } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2998            $retVal = $copy;
2999        } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
3000            $retVal = $copy;
3001        }
3002        # Return the result.
3003        return $retVal;
3004    }
3005    
3006    
3007  =head3 ParseParm  =head3 ParseParm
3008    
3009      my $listValue = Tracer::ParseParm($string);      my $listValue = Tracer::ParseParm($string);
# Line 2840  Line 3246 
3246      return $retVal;      return $retVal;
3247  }  }
3248    
3249    =head3 In
3250    
3251        my $flag = Tracer::In($value, $min, $max);
3252    
3253    Return TRUE if the value is between the minimum and the maximum, else FALSE.
3254    
3255    =cut
3256    
3257    sub In {
3258        return ($_[0] <= $_[2] && $_[0] >= $_[1]);
3259    }
3260    
3261    
3262  =head3 Constrain  =head3 Constrain
3263    
3264      my $constrained = Constrain($value, $min, $max);      my $constrained = Constrain($value, $min, $max);
# Line 2951  Line 3370 
3370      return $retVal;      return $retVal;
3371  }  }
3372    
   
3373  =head3 Strip  =head3 Strip
3374    
3375      my $string = Tracer::Strip($line);      my $string = Tracer::Strip($line);
# Line 2984  Line 3402 
3402      return $retVal;      return $retVal;
3403  }  }
3404    
3405    =head3 Trim
3406    
3407        my $string = Tracer::Trim($line);
3408    
3409    Trim all spaces from the beginning and ending of a string.
3410    
3411    =over 4
3412    
3413    =item line
3414    
3415    Line of text to be trimmed.
3416    
3417    =item RETURN
3418    
3419    The same line of text with all whitespace chopped off either end.
3420    
3421    =back
3422    
3423    =cut
3424    
3425    sub Trim {
3426        # Get a copy of the parameter string.
3427        my ($string) = @_;
3428        my $retVal = (defined $string ? $string : "");
3429        # Strip the front spaces.
3430        $retVal =~ s/^\s+//;
3431        # Strip the back spaces.
3432        $retVal =~ s/\s+$//;
3433        # Return the result.
3434        return $retVal;
3435    }
3436    
3437  =head3 Pad  =head3 Pad
3438    
3439      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
# Line 3045  Line 3495 
3495      return $retVal;      return $retVal;
3496  }  }
3497    
3498    =head3 Quoted
3499    
3500        my $string = Tracer::Quoted($var);
3501    
3502    Convert the specified value to a string and enclose it in single quotes.
3503    If it's undefined, the string C<undef> in angle brackets will be used
3504    instead.
3505    
3506    =over 4
3507    
3508    =item var
3509    
3510    Value to quote.
3511    
3512    =item RETURN
3513    
3514    Returns a string enclosed in quotes, or an indication the value is undefined.
3515    
3516    =back
3517    
3518    =cut
3519    
3520    sub Quoted {
3521        # Get the parameters.
3522        my ($var) = @_;
3523        # Declare the return variable.
3524        my $retVal;
3525        # Are we undefined?
3526        if (! defined $var) {
3527            $retVal = "<undef>";
3528        } else {
3529            # No, so convert to a string and enclose in quotes.
3530            $retVal = $var;
3531            $retVal =~ s/'/\\'/;
3532            $retVal = "'$retVal'";
3533        }
3534        # Return the result.
3535        return $retVal;
3536    }
3537    
3538  =head3 EOF  =head3 EOF
3539    
3540  This is a constant that is lexically greater than any useful string.  This is a constant that is lexically greater than any useful string.
# Line 3134  Line 3624 
3624  }  }
3625    
3626    
3627    =head3 GetMemorySize
3628    
3629        my $string = Tracer::GetMemorySize();
3630    
3631    Return a memory size string for the current process. The string will be
3632    in comma format, with a size indicator (K, M, G) at the end.
3633    
3634    =cut
3635    
3636    sub GetMemorySize {
3637        # Get the memory size from Unix.
3638        my ($retVal) = `ps h -o vsz $$`;
3639        # Remove the ending new-line.
3640        chomp $retVal;
3641        # Format and return the result.
3642        return CommaFormat($retVal) . "K";
3643    }
3644    
3645  =head3 CompareLists  =head3 CompareLists
3646    
3647      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
# Line 3201  Line 3709 
3709      return ($inserted, $deleted);      return ($inserted, $deleted);
3710  }  }
3711    
3712  =head3 GenerateURL  =head3 Cmp
3713    
3714      my $queryUrl = Tracer::GenerateURL($page, %parameters);      my $cmp = Tracer::Cmp($a, $b);
3715    
3716  Generate a GET-style URL for the specified page with the specified parameter  This method performs a universal sort comparison. Each value coming in is
3717  names and values. The values will be URL-escaped automatically. So, for  separated into a text parts and number parts. The text
3718  example  part is string compared, and if both parts are equal, then the number
3719    parts are compared numerically. A stream of just numbers or a stream of
3720    just strings will sort correctly, and a mixed stream will sort with the
3721    numbers first. Strings with a label and a number will sort in the
3722    expected manner instead of lexically. Undefined values sort last.
3723    
3724    =over 4
3725    
3726    =item a
3727    
3728    First item to compare.
3729    
3730    =item b
3731    
3732    Second item to compare.
3733    
3734    =item RETURN
3735    
3736    Returns a negative number if the first item should sort first (is less), a positive
3737    number if the first item should sort second (is greater), and a zero if the items are
3738    equal.
3739    
3740    =back
3741    
3742    =cut
3743    
3744    sub Cmp {
3745        # Get the parameters.
3746        my ($a, $b) = @_;
3747        # Declare the return value.
3748        my $retVal;
3749        # Check for nulls.
3750        if (! defined($a)) {
3751            $retVal = (! defined($b) ? 0 : -1);
3752        } elsif (! defined($b)) {
3753            $retVal = 1;
3754        } else {
3755            # Here we have two real values. Parse the two strings.
3756            my @aParsed = _Parse($a);
3757            my @bParsed = _Parse($b);
3758            # Loop through the first string.
3759            while (! $retVal && @aParsed) {
3760                # Extract the string parts.
3761                my $aPiece = shift(@aParsed);
3762                my $bPiece = shift(@bParsed) || '';
3763                # Extract the number parts.
3764                my $aNum = shift(@aParsed);
3765                my $bNum = shift(@bParsed) || 0;
3766                # Compare the string parts insensitively.
3767                $retVal = (lc($aPiece) cmp lc($bPiece));
3768                # If they're equal, compare them sensitively.
3769                if (! $retVal) {
3770                    $retVal = ($aPiece cmp $bPiece);
3771                    # If they're STILL equal, compare the number parts.
3772                    if (! $retVal) {
3773                        $retVal = $aNum <=> $bNum;
3774                    }
3775                }
3776            }
3777        }
3778        # Return the result.
3779        return $retVal;
3780    }
3781    
3782    # This method parses an input string into a string parts alternating with
3783    # number parts.
3784    sub _Parse {
3785        # Get the incoming string.
3786        my ($string) = @_;
3787        # The pieces will be put in here.
3788        my @retVal;
3789        # Loop through as many alpha/num sets as we can.
3790        while ($string =~ /^(\D*)(\d+)(.*)/) {
3791            # Push the alpha and number parts into the return string.
3792            push @retVal, $1, $2;
3793            # Save the residual.
3794            $string = $3;
3795        }
3796        # If there's still stuff left, add it to the end with a trailing
3797        # zero.
3798        if ($string) {
3799            push @retVal, $string, 0;
3800        }
3801        # Return the list.
3802        return @retVal;
3803    }
3804    
3805    =head3 ListEQ
3806    
3807        my $flag = Tracer::ListEQ(\@a, \@b);
3808    
3809    Return TRUE if the specified lists contain the same strings in the same
3810    order, else FALSE.
3811    
3812    =over 4
3813    
3814    =item a
3815    
3816    Reference to the first list.
3817    
3818    =item b
3819    
3820    Reference to the second list.
3821    
3822    =item RETURN
3823    
3824    Returns TRUE if the two parameters are identical string lists, else FALSE.
3825    
3826    =back
3827    
3828    =cut
3829    
3830    sub ListEQ {
3831        # Get the parameters.
3832        my ($a, $b) = @_;
3833        # Declare the return variable. Start by checking the lengths.
3834        my $n = scalar(@$a);
3835        my $retVal = ($n == scalar(@$b));
3836        # Now compare the list elements.
3837        for (my $i = 0; $retVal && $i < $n; $i++) {
3838            $retVal = ($a->[$i] eq $b->[$i]);
3839        }
3840        # Return the result.
3841        return $retVal;
3842    }
3843    
3844    =head2 CGI Script Utilities
3845    
3846    =head3 ScriptSetup (deprecated)
3847    
3848        my ($cgi, $varHash) = ScriptSetup($noTrace);
3849    
3850    Perform standard tracing and debugging setup for scripts. The value returned is
3851    the CGI object followed by a pre-built variable hash. At the end of the script,
3852    the client should call L</ScriptFinish> to output the web page.
3853    
3854    This method calls L</ETracing> to configure tracing, which allows the tracing
3855    to be configured via the emergency tracing form on the debugging control panel.
3856    Tracing will then be turned on automatically for all programs that use the L</ETracing>
3857    method, which includes every program that uses this method or L</StandardSetup>.
3858    
3859    =over 4
3860    
3861    =item noTrace (optional)
3862    
3863    If specified, tracing will be suppressed. This is useful if the script wants to set up
3864    tracing manually.
3865    
3866    =item RETURN
3867    
3868    Returns a two-element list consisting of a CGI query object and a variable hash for
3869    the output page.
3870    
3871    =back
3872    
3873    =cut
3874    
3875    sub ScriptSetup {
3876        # Get the parameters.
3877        my ($noTrace) = @_;
3878        # Get the CGI query object.
3879        my $cgi = CGI->new();
3880        # Set up tracing if it's not suppressed.
3881        ETracing($cgi) unless $noTrace;
3882        # Create the variable hash.
3883        my $varHash = { results => '' };
3884        # Return the query object and variable hash.
3885        return ($cgi, $varHash);
3886    }
3887    
3888    =head3 ScriptFinish (deprecated)
3889    
3890        ScriptFinish($webData, $varHash);
3891    
3892    Output a web page at the end of a script. Either the string to be output or the
3893    name of a template file can be specified. If the second parameter is omitted,
3894    it is assumed we have a string to be output; otherwise, it is assumed we have the
3895    name of a template file. The template should have the variable C<DebugData>
3896    specified in any form that invokes a standard script. If debugging mode is turned
3897    on, a form field will be put in that allows the user to enter tracing data.
3898    Trace messages will be placed immediately before the terminal C<BODY> tag in
3899    the output, formatted as a list.
3900    
3901    A typical standard script would loook like the following.
3902    
3903        BEGIN {
3904            # Print the HTML header.
3905            print "CONTENT-TYPE: text/html\n\n";
3906        }
3907        use Tracer;
3908        use CGI;
3909        use FIG;
3910        # ... more uses ...
3911    
3912        my ($cgi, $varHash) = ScriptSetup();
3913        eval {
3914            # ... get data from $cgi, put it in $varHash ...
3915        };
3916        if ($@) {
3917            Trace("Script Error: $@") if T(0);
3918        }
3919        ScriptFinish("Html/MyTemplate.html", $varHash);
3920    
3921    The idea here is that even if the script fails, you'll see trace messages and
3922    useful output.
3923    
3924    =over 4
3925    
3926    =item webData
3927    
3928    A string containing either the full web page to be written to the output or the
3929    name of a template file from which the page is to be constructed. If the name
3930    of a template file is specified, then the second parameter must be present;
3931    otherwise, it must be absent.
3932    
3933    =item varHash (optional)
3934    
3935    If specified, then a reference to a hash mapping variable names for a template
3936    to their values. The template file will be read into memory, and variable markers
3937    will be replaced by data in this hash reference.
3938    
3939    =back
3940    
3941    =cut
3942    
3943    sub ScriptFinish {
3944        # Get the parameters.
3945        my ($webData, $varHash) = @_;
3946        # Check for a template file situation.
3947        my $outputString;
3948        if (defined $varHash) {
3949            # Here we have a template file. We need to determine the template type.
3950            my $template;
3951            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
3952                $template = "$FIG_Config::template_url/$webData";
3953            } else {
3954                $template = "<<$webData";
3955            }
3956            $outputString = PageBuilder::Build($template, $varHash, "Html");
3957        } else {
3958            # Here the user gave us a raw string.
3959            $outputString = $webData;
3960        }
3961        # Check for trace messages.
3962        if ($Destination ne "NONE" && $TraceLevel > 0) {
3963            # We have trace messages, so we want to put them at the end of the body. This
3964            # is either at the end of the whole string or at the beginning of the BODY
3965            # end-tag.
3966            my $pos = length $outputString;
3967            if ($outputString =~ m#</body>#gi) {
3968                $pos = (pos $outputString) - 7;
3969            }
3970            # If the trace messages were queued, we unroll them. Otherwise, we display the
3971            # destination.
3972            my $traceHtml;
3973            if ($Destination eq "QUEUE") {
3974                $traceHtml = QTrace('Html');
3975            } elsif ($Destination =~ /^>>(.+)$/) {
3976                # Here the tracing output it to a file. We code it as a hyperlink so the user
3977                # can copy the file name into the clipboard easily.
3978                my $actualDest = $1;
3979                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
3980            } else {
3981                # Here we have one of the special destinations.
3982                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
3983            }
3984            substr $outputString, $pos, 0, $traceHtml;
3985        }
3986        # Write the output string.
3987        print $outputString;
3988    }
3989    
3990    =head3 GenerateURL
3991    
3992        my $queryUrl = Tracer::GenerateURL($page, %parameters);
3993    
3994    Generate a GET-style URL for the specified page with the specified parameter
3995    names and values. The values will be URL-escaped automatically. So, for
3996    example
3997    
3998      Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")      Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3999    
# Line 3335  Line 4121 
4121      return $retVal;      return $retVal;
4122  }  }
4123    
 =head3 Cmp  
   
     my $cmp = Tracer::Cmp($a, $b);  
   
 This method performs a universal sort comparison. Each value coming in is  
 separated into a leading text part and a trailing number part. The text  
 part is string compared, and if both parts are equal, then the number  
 parts are compared numerically. A stream of just numbers or a stream of  
 just strings will sort correctly, and a mixed stream will sort with the  
 numbers first. Strings with a label and a number will sort in the  
 expected manner instead of lexically.  
   
 =over 4  
   
 =item a  
   
 First item to compare.  
   
 =item b  
   
 Second item to compare.  
   
 =item RETURN  
   
 Returns a negative number if the first item should sort first (is less), a positive  
 number if the first item should sort second (is greater), and a zero if the items are  
 equal.  
   
 =back  
   
 =cut  
   
 sub Cmp {  
     # Get the parameters.  
     my ($a, $b) = @_;  
     # Declare the return value.  
     my $retVal;  
     # Check for nulls.  
     if (! defined($a)) {  
         $retVal = (! defined($b) ? 0 : -1);  
     } elsif (! defined($b)) {  
         $retVal = 1;  
     } else {  
         # Here we have two real values. Parse the two strings.  
         $a =~ /^(\D*)(\d*)$/;  
         my $aParsed = [$1, $2];  
         $b =~ /^(\D*)(\d*)$/;  
         my $bParsed = [$1, $2];  
         # Compare the string parts.  
         $retVal = $aParsed->[0] cmp $bParsed->[0];  
         if (! $retVal) {  
             $retVal = $aParsed->[1] <=> $bParsed->[1];  
         }  
     }  
     # Return the result.  
     return $retVal;  
 }  
   
   
4124  =head3 TrackingCode  =head3 TrackingCode
4125    
4126      my $html = Tracer::TrackingCode();      my $html = Tracer::TrackingCode();
# Line 3424  Line 4151 
4151      return $retVal;      return $retVal;
4152  }  }
4153    
4154    =head3 Clean
4155    
4156        my $cleaned = Tracer::Clean($string);
4157    
4158    Clean up a string for HTML display. This not only converts special
4159    characters to HTML entity names, it also removes control characters.
4160    
4161    =over 4
4162    
4163    =item string
4164    
4165    String to convert.
4166    
4167    =item RETURN
4168    
4169    Returns the input string with anything that might disrupt an HTML literal removed. An
4170    undefined value will be converted to an empty string.
4171    
4172    =back
4173    
4174    =cut
4175    
4176    sub Clean {
4177        # Get the parameters.
4178        my ($string) = @_;
4179        # Declare the return variable.
4180        my $retVal = "";
4181        # Only proceed if the value exists.
4182        if (defined $string) {
4183            # Get the string.
4184            $retVal = $string;
4185            # Clean the control characters.
4186            $retVal =~ tr/\x00-\x1F/?/;
4187            # Escape the rest.
4188            $retVal = CGI::escapeHTML($retVal);
4189        }
4190        # Return the result.
4191        return $retVal;
4192    }
4193    
4194    =head3 SortByValue
4195    
4196        my @keys = Tracer::SortByValue(\%hash);
4197    
4198    Get a list of hash table keys sorted by hash table values.
4199    
4200    =over 4
4201    
4202    =item hash
4203    
4204    Hash reference whose keys are to be extracted.
4205    
4206    =item RETURN
4207    
4208    Returns a list of the hash keys, ordered so that the corresponding hash values
4209    are in alphabetical sequence.
4210    
4211    =back
4212    
4213    =cut
4214    
4215    sub SortByValue {
4216        # Get the parameters.
4217        my ($hash) = @_;
4218        # Sort the hash's keys using the values.
4219        my @retVal = sort { Cmp($hash->{$a}, $hash->{$b}) } keys %$hash;
4220        # Return the result.
4221        return @retVal;
4222    }
4223    
4224    =head3 GetSet
4225    
4226        my $value = Tracer::GetSet($object, $name => $newValue);
4227    
4228    Get or set the value of an object field. The object is treated as an
4229    ordinary hash reference. If a new value is specified, it is stored in the
4230    hash under the specified name and then returned. If no new value is
4231    specified, the current value is returned.
4232    
4233    =over 4
4234    
4235    =item object
4236    
4237    Reference to the hash that is to be interrogated or updated.
4238    
4239    =item name
4240    
4241    Name of the field. This is the hash key.
4242    
4243    =item newValue (optional)
4244    
4245    New value to be stored in the field. If no new value is specified, the current
4246    value of the field is returned.
4247    
4248    =item RETURN
4249    
4250    Returns the value of the named field in the specified hash.
4251    
4252    =back
4253    
4254    =cut
4255    
4256    sub GetSet {
4257        # Get the parameters.
4258        my ($object, $name, $newValue) = @_;
4259        # Is a new value specified?
4260        if (defined $newValue) {
4261            # Yes, so store it.
4262            $object->{$name} = $newValue;
4263        }
4264        # Return the result.
4265        return $object->{$name};
4266    }
4267    
4268  1;  1;

Legend:
Removed from v.1.98  
changed lines
  Added in v.1.126

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3