[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.121, Thu Jun 18 01:29:19 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
# Line 790  Line 1091 
1091      # Get the parameter.      # Get the parameter.
1092      my ($parameter) = @_;      my ($parameter) = @_;
1093      # Check for CGI mode.      # Check for CGI mode.
1094      my $cgi = (ref $parameter eq 'CGI' ? $parameter : undef);      if (defined $parameter && ref $parameter eq 'CGI') {
1095            $SavedCGI = $parameter;
1096        } else {
1097            $SavedCGI = undef;
1098        }
1099      # Default to no tracing except errors.      # Default to no tracing except errors.
1100      my ($tracing, $dest) = ("0", "WARN");      my ($tracing, $dest) = ("0", "WARN");
1101      # Check for emergency tracing.      # Check for emergency tracing.
# Line 823  Line 1128 
1128              # Set the trace parameter.              # Set the trace parameter.
1129              $tracing = join(" ", $level, sort keys %moduleHash);              $tracing = join(" ", $level, sort keys %moduleHash);
1130          }          }
1131      } elsif (defined $cgi) {      } elsif (defined $SavedCGI) {
1132          # There's no emergency tracing, but we have a CGI object, so check          # There's no emergency tracing, but we have a CGI object, so check
1133          # for tracing from the form parameters.          # for tracing from the form parameters.
1134          if ($cgi->param('Trace')) {          if ($SavedCGI->param('Trace')) {
1135              # Here the user has requested tracing via a form.              # Here the user has requested tracing via a form.
1136              $dest = ($cgi->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");              $dest = ($SavedCGI->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
1137              $tracing = $cgi->param('Trace') . " Tracer";              $tracing = $SavedCGI->param('Trace') . " Tracer";
1138          }          }
1139      }      }
1140      # Setup the tracing we've determined from all the stuff above.      # Setup the tracing we've determined from all the stuff above.
1141      TSetup($tracing, $dest);      TSetup($tracing, $dest);
1142      # Check to see if we're a web script.      # Check to see if we're a web script.
1143      if (defined $cgi) {      if (defined $SavedCGI) {
1144          # Yes we are. Trace the form and environment data.          # Yes we are. Trace the form and environment data.
1145          TraceParms($cgi);          TraceParms($SavedCGI);
1146          # 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
1147          # emitted by the script in its raw form.          # emitted by the script in its raw form.
1148          if (T(Raw => 3)) {          if (T(Raw => 3)) {
# Line 1028  Line 1333 
1333      # Declare the return variable.      # Declare the return variable.
1334      my $retVal;      my $retVal;
1335      # Determine the parameter type.      # Determine the parameter type.
1336      if (! defined $parameter) {      if (! defined $parameter || defined($ENV{TRACING})) {
1337          # Here we're supposed to check the environment.          # Here we're supposed to check the environment. If that fails, we
1338          $retVal = $ENV{TRACING};          # get the effective login ID.
1339            $retVal = $ENV{TRACING} || scalar getpwuid($<);
1340      } else {      } else {
1341          my $ptype = ref $parameter;          my $ptype = ref $parameter;
1342          if ($ptype eq 'CGI') {          if ($ptype eq 'CGI') {
# Line 1071  Line 1377 
1377      # Get the parameters.      # Get the parameters.
1378      my ($cgi) = @_;      my ($cgi) = @_;
1379      if (T(CGI => 2)) {      if (T(CGI => 2)) {
1380          # 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
1381          Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));          # relatively small.
1382            my $url = $cgi->url(-relative => 1, -query => 1);
1383            my $len = length($url);
1384            if ($len < 500) {
1385                Trace("[URL] $url");
1386            } elsif ($len > 2048) {
1387                Trace("[URL] URL is too long to use with GET ($len characters).");
1388            } else {
1389                Trace("[URL] URL length is $len characters.");
1390            }
1391      }      }
1392      if (T(CGI => 3)) {      if (T(CGI => 3)) {
1393          # Here we want to trace the parameter data.          # Here we want to trace the parameter data.
# Line 1147  Line 1462 
1462      }      }
1463  }  }
1464    
1465    =head2 Command-Line Utility Methods
1466    
1467  =head3 ScriptFinish (deprecated)  =head3 SendSMS
   
     ScriptFinish($webData, $varHash);  
1468    
1469  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.  
1470    
1471  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
1472    user name, password, and API ID for the relevant account in the hash reference variable
1473    I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1474    example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1475    is C<2561022>, then the FIG_Config file must contain
1476    
1477      BEGIN {      $phone =  { user => 'BruceTheHumanPet',
1478          # Print the HTML header.                  password => 'silly',
1479          print "CONTENT-TYPE: text/html\n\n";                  api_id => '2561022' };
     }  
     use Tracer;  
     use CGI;  
     use FIG;  
     # ... more uses ...  
1480    
1481      my ($cgi, $varHash) = ScriptSetup();  The original purpose of this method was to insure Bruce would be notified immediately when the
1482      eval {  Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1483          # ... 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);  
1484    
1485  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.  
1486    
1487  =over 4  =over 4
1488    
1489  =item webData  =item phoneNumber
1490    
1491  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
1492  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.  
1493    
1494  =item varHash (optional)  =item msg
1495    
1496  If specified, then a reference to a hash mapping variable names for a template  Message to send to the specified phone.
1497  to their values. The template file will be read into memory, and variable markers  
1498  will be replaced by data in this hash reference.  =item RETURN
1499    
1500    Returns the message ID if successful, and C<undef> if the message could not be sent.
1501    
1502  =back  =back
1503    
1504  =cut  =cut
1505    
1506  sub ScriptFinish {  sub SendSMS {
1507      # Get the parameters.      # Get the parameters.
1508      my ($webData, $varHash) = @_;      my ($phoneNumber, $msg) = @_;
1509      # Check for a template file situation.      # Declare the return variable. If we do not change it, C<undef> will be returned.
1510      my $outputString;      my $retVal;
1511      if (defined $varHash) {      # Only proceed if we have phone support.
1512          # Here we have a template file. We need to determine the template type.      if (! defined $FIG_Config::phone) {
1513          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";  
1514          } else {          } else {
1515              $template = "<<$webData";          # Get the phone data.
1516          }          my $parms = $FIG_Config::phone;
1517          $outputString = PageBuilder::Build($template, $varHash, "Html");          # Get the Clickatell URL.
1518      } else {          my $url = "http://api.clickatell.com/http/";
1519          # Here the user gave us a raw string.          # Create the user agent.
1520          $outputString = $webData;          my $ua = LWP::UserAgent->new;
1521      }          # Request a Clickatell session.
1522      # Check for trace messages.          my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
1523      if ($Destination ne "NONE" && $TraceLevel > 0) {                                       password => $parms->{password},
1524          # We have trace messages, so we want to put them at the end of the body. This                                       api_id => $parms->{api_id},
1525          # is either at the end of the whole string or at the beginning of the BODY                                       to => $phoneNumber,
1526          # end-tag.                                       text => $msg});
1527          my $pos = length $outputString;          # Check for an error.
1528          if ($outputString =~ m#</body>#gi) {          if (! $resp->is_success) {
1529              $pos = (pos $outputString) - 7;              Trace("Alert failed.") if T(1);
         }  
         # 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);  
     } else {  
         # Get the phone data.  
         my $parms = $FIG_Config::phone;  
         # Get the Clickatell URL.  
         my $url = "http://api.clickatell.com/http/";  
         # Create the user agent.  
         my $ua = LWP::UserAgent->new;  
         # Request a Clickatell session.  
         my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},  
                                      password => $parms->{password},  
                                      api_id => $parms->{api_id},  
                                      to => $phoneNumber,  
                                      text => $msg});  
         # Check for an error.  
         if (! $resp->is_success) {  
             Trace("Alert failed.") if T(1);  
1530          } else {          } else {
1531              # Get the message ID.              # Get the message ID.
1532              my $rstring = $resp->content;              my $rstring = $resp->content;
# Line 1454  Line 1666 
1666  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
1667  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,
1668  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
1669  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
1670    login ID.
1671    
1672    Since the default situation in StandardSetup is to trace to the standard
1673    output, errors that occur in command-line scripts will not generate
1674    RSS events. To force the events, use the C<warn> option.
1675    
1676        TransactFeatures -background -warn register ../xacts IDs.tbl
1677    
1678  Finally, if the special option C<-help> is specified, the option  Finally, if the special option C<-help> is specified, the option
1679  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 1690 
1690          -noAlias  do not expect aliases in CHANGE transactions          -noAlias  do not expect aliases in CHANGE transactions
1691          -start    start with this genome          -start    start with this genome
1692          -tblFiles output TBL files containing the corrected IDs          -tblFiles output TBL files containing the corrected IDs
1693            -forked   do not erase the trace file before tracing
1694    
1695  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
1696  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 1754 
1754      my ($categories, $options, $parmHelp, @argv) = @_;      my ($categories, $options, $parmHelp, @argv) = @_;
1755      # Get the default tracing key.      # Get the default tracing key.
1756      my $tkey = EmergencyKey();      my $tkey = EmergencyKey();
1757        # Save the command line.
1758        $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1759      # Add the tracing options.      # Add the tracing options.
1760      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
1761          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1762      }      }
1763        if (! exists $options->{forked}) {
1764            $options->{forked} = [0, "keep old trace file"];
1765        }
1766      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
1767      $options->{help} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
1768      $options->{user} = [$tkey, "tracing key"];      $options->{user} = [$tkey, "tracing key"];
1769      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
1770        $options->{warn} = [0, "send errors to RSS feed"];
1771        $options->{moreTracing} = ["", "comma-delimited list of additional trace modules for debugging"];
1772      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
1773      # contains the default values rather than the default value      # contains the default values rather than the default value
1774      # 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 1785 
1785      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);      my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1786      # Get the logfile suffix.      # Get the logfile suffix.
1787      my $suffix = $retOptions->{user};      my $suffix = $retOptions->{user};
1788      # Check for background mode.      # We'll put the trace file name in here. We need it later if background
1789      if ($retOptions->{background}) {      # mode is on.
1790          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};  
         }  
     }  
1791      # 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
1792      # wants emergency tracing.      # wants emergency tracing.
1793      if ($retOptions->{trace} eq 'E') {      if ($retOptions->{trace} eq 'E') {
# Line 1580  Line 1798 
1798          if ($retOptions->{sql}) {          if ($retOptions->{sql}) {
1799              push @cats, "SQL";              push @cats, "SQL";
1800          }          }
1801            if ($retOptions->{warn}) {
1802                push @cats, "Feed";
1803            }
1804          # Add the default categories.          # Add the default categories.
1805          push @cats, "Tracer";          push @cats, "Tracer";
1806            # Check for more tracing groups.
1807            if ($retOptions->{moreTracing}) {
1808                push @cats, split /,/, $retOptions->{moreTracing};
1809            }
1810          # Next, we create the category string by joining the categories.          # Next, we create the category string by joining the categories.
1811          my $cats = join(" ", @cats);          my $cats = join(" ", @cats);
1812          # 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 1821 
1821          my $traceMode;          my $traceMode;
1822          # Verify that we can open a file in the FIG temporary directory.          # Verify that we can open a file in the FIG temporary directory.
1823          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";          my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1824          if (open TESTTRACE, ">$traceFileName") {          my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1825            if (open TESTTRACE, "$traceFileSpec") {
1826              # Here we can trace to a file.              # Here we can trace to a file.
1827              $traceMode = ">$traceFileName";              $traceMode = ">>$traceFileName";
1828              if ($textOKFlag) {              if ($textOKFlag) {
1829                  # Echo to standard output if the text-OK flag is set.                  # Echo to standard output if the text-OK flag is set.
1830                  $traceMode = "+$traceMode";                  $traceMode = "+$traceMode";
# Line 1619  Line 1845 
1845          # Now set up the tracing.          # Now set up the tracing.
1846          TSetup("$traceLevel $cats", $traceMode);          TSetup("$traceLevel $cats", $traceMode);
1847      }      }
1848        # Check for background mode.
1849        if ($retOptions->{background}) {
1850            my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1851            my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1852            # Spool the output.
1853            open STDOUT, ">$outFileName";
1854            # If we have a trace file, trace the errors to the log. Otherwise,
1855            # spool the errors.
1856            if (defined $traceFileName) {
1857                open STDERR, "| Tracer $traceFileName";
1858            } else {
1859                open STDERR, ">$errFileName";
1860            }
1861            # Check for phone support. If we have phone support and a phone number,
1862            # we want to turn it on.
1863            if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1864                $retOptions->{phone} = $ENV{PHONE};
1865            }
1866        }
1867      # 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
1868      # options and exit the program.      # options and exit the program.
1869      if ($retOptions->{help}) {      if ($retOptions->{help}) {
# Line 1799  Line 2044 
2044      }      }
2045  }  }
2046    
2047    =head3 UnparseOptions
2048    
2049        my $optionString = Tracer::UnparseOptions(\%options);
2050    
2051    Convert an option hash into a command-line string. This will not
2052    necessarily be the same text that came in, but it will nonetheless
2053    produce the same ultimate result when parsed by L</StandardSetup>.
2054    
2055    =over 4
2056    
2057    =item options
2058    
2059    Reference to a hash of options to convert into an option string.
2060    
2061    =item RETURN
2062    
2063    Returns a string that will parse to the same set of options when
2064    parsed by L</StandardSetup>.
2065    
2066    =back
2067    
2068    =cut
2069    
2070    sub UnparseOptions {
2071        # Get the parameters.
2072        my ($options) = @_;
2073        # The option segments will be put in here.
2074        my @retVal = ();
2075        # Loop through the options.
2076        for my $key (keys %$options) {
2077            # Get the option value.
2078            my $value = $options->{$key};
2079            # Only use it if it's nonempty.
2080            if (defined $value && $value ne "") {
2081                my $segment = "--$key=$value";
2082                # Quote it if necessary.
2083                if ($segment =~ /[ |<>*]/) {
2084                    $segment = '"' . $segment . '"';
2085                }
2086                # Add it to the return list.
2087                push @retVal, $segment;
2088            }
2089        }
2090        # Return the result.
2091        return join(" ", @retVal);
2092    }
2093    
2094  =head3 ParseCommand  =head3 ParseCommand
2095    
2096      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);      my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
# Line 2271  Line 2563 
2563          } else {          } else {
2564              @retVal = readdir $dirHandle;              @retVal = readdir $dirHandle;
2565          }          }
2566            closedir $dirHandle;
2567      } elsif (! $flag) {      } elsif (! $flag) {
2568          # Here the directory would not open and it's considered an error.          # Here the directory would not open and it's considered an error.
2569          Confess("Could not open directory $dirName.");          Confess("Could not open directory $dirName.");
# Line 2377  Line 2670 
2670  Map of search patterns to permission masks. If a directory name matches  Map of search patterns to permission masks. If a directory name matches
2671  one of the patterns, that directory and all its members and subdirectories  one of the patterns, that directory and all its members and subdirectories
2672  will be assigned the new pattern. For example, the following would  will be assigned the new pattern. For example, the following would
2673  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>.
2674    
2675      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);      Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2676    
# Line 2430  Line 2723 
2723                      $match = 1;                      $match = 1;
2724                  }                  }
2725              }              }
2726              # 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
2727              # before terminating due to the match.              # before terminating due to the match.
2728              if ($match && $otherMasks[$i-1] != $mask) {              if ($match && $otherMasks[$i-1] != $mask) {
2729                  # 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 2891 
2891    
2892  =head2 Other Useful Methods  =head2 Other Useful Methods
2893    
2894    =head3 IDHASH
2895    
2896        my $hash = SHTargetSearch::IDHASH(@keys);
2897    
2898    This is a dinky little method that converts a list of values to a reference
2899    to hash of values to labels. The values and labels are the same.
2900    
2901    =cut
2902    
2903    sub IDHASH {
2904        my %retVal = map { $_ => $_ } @_;
2905        return \%retVal;
2906    }
2907    
2908    =head3 Pluralize
2909    
2910        my $plural = Tracer::Pluralize($word);
2911    
2912    This is a very simple pluralization utility. It adds an C<s> at the end
2913    of the input word unless it already ends in an C<s>, in which case it
2914    adds C<es>.
2915    
2916    =over 4
2917    
2918    =item word
2919    
2920    Singular word to pluralize.
2921    
2922    =item RETURN
2923    
2924    Returns the probable plural form of the word.
2925    
2926    =back
2927    
2928    =cut
2929    
2930    sub Pluralize {
2931        # Get the parameters.
2932        my ($word) = @_;
2933        # Declare the return variable.
2934        my $retVal;
2935        if ($word =~ /s$/) {
2936            $retVal = $word . 'es';
2937        } else {
2938            $retVal = $word . 's';
2939        }
2940        # Return the result.
2941        return $retVal;
2942    }
2943    
2944    =head3 Numeric
2945    
2946        my $okFlag = Tracer::Numeric($string);
2947    
2948    Return the value of the specified string if it is numeric, or an undefined value
2949    if it is not numeric.
2950    
2951    =over 4
2952    
2953    =item string
2954    
2955    String to check.
2956    
2957    =item RETURN
2958    
2959    Returns the numeric value of the string if successful, or C<undef> if the string
2960    is not numeric.
2961    
2962    =back
2963    
2964    =cut
2965    
2966    sub Numeric {
2967        # Get the parameters.
2968        my ($string) = @_;
2969        # We'll put the value in here if we succeed.
2970        my $retVal;
2971        # Get a working copy of the string.
2972        my $copy = $string;
2973        # Trim leading and trailing spaces.
2974        $copy =~ s/^\s+//;
2975        $copy =~ s/\s+$//;
2976        # Check the result.
2977        if ($copy =~ /^[+-]?\d+$/) {
2978            $retVal = $copy;
2979        } elsif ($copy =~ /^([+-]\d+|\d*)[eE][+-]?\d+$/) {
2980            $retVal = $copy;
2981        } elsif ($copy =~ /^([+-]\d+|\d*)\.\d*([eE][+-]?\d+)?$/) {
2982            $retVal = $copy;
2983        }
2984        # Return the result.
2985        return $retVal;
2986    }
2987    
2988    
2989  =head3 ParseParm  =head3 ParseParm
2990    
2991      my $listValue = Tracer::ParseParm($string);      my $listValue = Tracer::ParseParm($string);
# Line 2840  Line 3228 
3228      return $retVal;      return $retVal;
3229  }  }
3230    
3231    =head3 In
3232    
3233        my $flag = Tracer::In($value, $min, $max);
3234    
3235    Return TRUE if the value is between the minimum and the maximum, else FALSE.
3236    
3237    =cut
3238    
3239    sub In {
3240        return ($_[0] <= $_[2] && $_[0] >= $_[1]);
3241    }
3242    
3243    
3244  =head3 Constrain  =head3 Constrain
3245    
3246      my $constrained = Constrain($value, $min, $max);      my $constrained = Constrain($value, $min, $max);
# Line 2951  Line 3352 
3352      return $retVal;      return $retVal;
3353  }  }
3354    
   
3355  =head3 Strip  =head3 Strip
3356    
3357      my $string = Tracer::Strip($line);      my $string = Tracer::Strip($line);
# Line 2984  Line 3384 
3384      return $retVal;      return $retVal;
3385  }  }
3386    
3387    =head3 Trim
3388    
3389        my $string = Tracer::Trim($line);
3390    
3391    Trim all spaces from the beginning and ending of a string.
3392    
3393    =over 4
3394    
3395    =item line
3396    
3397    Line of text to be trimmed.
3398    
3399    =item RETURN
3400    
3401    The same line of text with all whitespace chopped off either end.
3402    
3403    =back
3404    
3405    =cut
3406    
3407    sub Trim {
3408        # Get a copy of the parameter string.
3409        my ($string) = @_;
3410        my $retVal = (defined $string ? $string : "");
3411        # Strip the front spaces.
3412        $retVal =~ s/^\s+//;
3413        # Strip the back spaces.
3414        $retVal =~ s/\s+$//;
3415        # Return the result.
3416        return $retVal;
3417    }
3418    
3419  =head3 Pad  =head3 Pad
3420    
3421      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);      my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
# Line 3045  Line 3477 
3477      return $retVal;      return $retVal;
3478  }  }
3479    
3480    =head3 Quoted
3481    
3482        my $string = Tracer::Quoted($var);
3483    
3484    Convert the specified value to a string and enclose it in single quotes.
3485    If it's undefined, the string C<undef> in angle brackets will be used
3486    instead.
3487    
3488    =over 4
3489    
3490    =item var
3491    
3492    Value to quote.
3493    
3494    =item RETURN
3495    
3496    Returns a string enclosed in quotes, or an indication the value is undefined.
3497    
3498    =back
3499    
3500    =cut
3501    
3502    sub Quoted {
3503        # Get the parameters.
3504        my ($var) = @_;
3505        # Declare the return variable.
3506        my $retVal;
3507        # Are we undefined?
3508        if (! defined $var) {
3509            $retVal = "<undef>";
3510        } else {
3511            # No, so convert to a string and enclose in quotes.
3512            $retVal = $var;
3513            $retVal =~ s/'/\\'/;
3514            $retVal = "'$retVal'";
3515        }
3516        # Return the result.
3517        return $retVal;
3518    }
3519    
3520  =head3 EOF  =head3 EOF
3521    
3522  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 3606 
3606  }  }
3607    
3608    
3609  =head3 CompareLists  =head3 GetMemorySize
3610    
3611      my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);      my $string = Tracer::GetMemorySize();
3612    
3613    Return a memory size string for the current process. The string will be
3614    in comma format, with a size indicator (K, M, G) at the end.
3615    
3616    =cut
3617    
3618    sub GetMemorySize {
3619        # Get the memory size from Unix.
3620        my ($retVal) = `ps h -o vsz $$`;
3621        # Remove the ending new-line.
3622        chomp $retVal;
3623        # Format and return the result.
3624        return CommaFormat($retVal) . "K";
3625    }
3626    
3627    =head3 CompareLists
3628    
3629        my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
3630    
3631  Compare two lists of tuples, and return a hash analyzing the differences. The lists  Compare two lists of tuples, and return a hash analyzing the differences. The lists
3632  are presumed to be sorted alphabetically by the value in the $keyIndex column.  are presumed to be sorted alphabetically by the value in the $keyIndex column.
# Line 3201  Line 3691 
3691      return ($inserted, $deleted);      return ($inserted, $deleted);
3692  }  }
3693    
3694    =head3 Cmp
3695    
3696        my $cmp = Tracer::Cmp($a, $b);
3697    
3698    This method performs a universal sort comparison. Each value coming in is
3699    separated into a text parts and number parts. The text
3700    part is string compared, and if both parts are equal, then the number
3701    parts are compared numerically. A stream of just numbers or a stream of
3702    just strings will sort correctly, and a mixed stream will sort with the
3703    numbers first. Strings with a label and a number will sort in the
3704    expected manner instead of lexically. Undefined values sort last.
3705    
3706    =over 4
3707    
3708    =item a
3709    
3710    First item to compare.
3711    
3712    =item b
3713    
3714    Second item to compare.
3715    
3716    =item RETURN
3717    
3718    Returns a negative number if the first item should sort first (is less), a positive
3719    number if the first item should sort second (is greater), and a zero if the items are
3720    equal.
3721    
3722    =back
3723    
3724    =cut
3725    
3726    sub Cmp {
3727        # Get the parameters.
3728        my ($a, $b) = @_;
3729        # Declare the return value.
3730        my $retVal;
3731        # Check for nulls.
3732        if (! defined($a)) {
3733            $retVal = (! defined($b) ? 0 : -1);
3734        } elsif (! defined($b)) {
3735            $retVal = 1;
3736        } else {
3737            # Here we have two real values. Parse the two strings.
3738            my @aParsed = _Parse($a);
3739            my @bParsed = _Parse($b);
3740            # Loop through the first string.
3741            while (! $retVal && @aParsed) {
3742                # Extract the string parts.
3743                my $aPiece = shift(@aParsed);
3744                my $bPiece = shift(@bParsed) || '';
3745                # Extract the number parts.
3746                my $aNum = shift(@aParsed);
3747                my $bNum = shift(@bParsed) || 0;
3748                # Compare the string parts insensitively.
3749                $retVal = (lc($aPiece) cmp lc($bPiece));
3750                # If they're equal, compare them sensitively.
3751                if (! $retVal) {
3752                    $retVal = ($aPiece cmp $bPiece);
3753                    # If they're STILL equal, compare the number parts.
3754                    if (! $retVal) {
3755                        $retVal = $aNum <=> $bNum;
3756                    }
3757                }
3758            }
3759        }
3760        # Return the result.
3761        return $retVal;
3762    }
3763    
3764    # This method parses an input string into a string parts alternating with
3765    # number parts.
3766    sub _Parse {
3767        # Get the incoming string.
3768        my ($string) = @_;
3769        # The pieces will be put in here.
3770        my @retVal;
3771        # Loop through as many alpha/num sets as we can.
3772        while ($string =~ /^(\D*)(\d+)(.*)/) {
3773            # Push the alpha and number parts into the return string.
3774            push @retVal, $1, $2;
3775            # Save the residual.
3776            $string = $3;
3777        }
3778        # If there's still stuff left, add it to the end with a trailing
3779        # zero.
3780        if ($string) {
3781            push @retVal, $string, 0;
3782        }
3783        # Return the list.
3784        return @retVal;
3785    }
3786    
3787    =head3 ListEQ
3788    
3789        my $flag = Tracer::ListEQ(\@a, \@b);
3790    
3791    Return TRUE if the specified lists contain the same strings in the same
3792    order, else FALSE.
3793    
3794    =over 4
3795    
3796    =item a
3797    
3798    Reference to the first list.
3799    
3800    =item b
3801    
3802    Reference to the second list.
3803    
3804    =item RETURN
3805    
3806    Returns TRUE if the two parameters are identical string lists, else FALSE.
3807    
3808    =back
3809    
3810    =cut
3811    
3812    sub ListEQ {
3813        # Get the parameters.
3814        my ($a, $b) = @_;
3815        # Declare the return variable. Start by checking the lengths.
3816        my $n = scalar(@$a);
3817        my $retVal = ($n == scalar(@$b));
3818        # Now compare the list elements.
3819        for (my $i = 0; $retVal && $i < $n; $i++) {
3820            $retVal = ($a->[$i] eq $b->[$i]);
3821        }
3822        # Return the result.
3823        return $retVal;
3824    }
3825    
3826    =head2 CGI Script Utilities
3827    
3828    =head3 ScriptSetup (deprecated)
3829    
3830        my ($cgi, $varHash) = ScriptSetup($noTrace);
3831    
3832    Perform standard tracing and debugging setup for scripts. The value returned is
3833    the CGI object followed by a pre-built variable hash. At the end of the script,
3834    the client should call L</ScriptFinish> to output the web page.
3835    
3836    This method calls L</ETracing> to configure tracing, which allows the tracing
3837    to be configured via the emergency tracing form on the debugging control panel.
3838    Tracing will then be turned on automatically for all programs that use the L</ETracing>
3839    method, which includes every program that uses this method or L</StandardSetup>.
3840    
3841    =over 4
3842    
3843    =item noTrace (optional)
3844    
3845    If specified, tracing will be suppressed. This is useful if the script wants to set up
3846    tracing manually.
3847    
3848    =item RETURN
3849    
3850    Returns a two-element list consisting of a CGI query object and a variable hash for
3851    the output page.
3852    
3853    =back
3854    
3855    =cut
3856    
3857    sub ScriptSetup {
3858        # Get the parameters.
3859        my ($noTrace) = @_;
3860        # Get the CGI query object.
3861        my $cgi = CGI->new();
3862        # Set up tracing if it's not suppressed.
3863        ETracing($cgi) unless $noTrace;
3864        # Create the variable hash.
3865        my $varHash = { results => '' };
3866        # Return the query object and variable hash.
3867        return ($cgi, $varHash);
3868    }
3869    
3870    =head3 ScriptFinish (deprecated)
3871    
3872        ScriptFinish($webData, $varHash);
3873    
3874    Output a web page at the end of a script. Either the string to be output or the
3875    name of a template file can be specified. If the second parameter is omitted,
3876    it is assumed we have a string to be output; otherwise, it is assumed we have the
3877    name of a template file. The template should have the variable C<DebugData>
3878    specified in any form that invokes a standard script. If debugging mode is turned
3879    on, a form field will be put in that allows the user to enter tracing data.
3880    Trace messages will be placed immediately before the terminal C<BODY> tag in
3881    the output, formatted as a list.
3882    
3883    A typical standard script would loook like the following.
3884    
3885        BEGIN {
3886            # Print the HTML header.
3887            print "CONTENT-TYPE: text/html\n\n";
3888        }
3889        use Tracer;
3890        use CGI;
3891        use FIG;
3892        # ... more uses ...
3893    
3894        my ($cgi, $varHash) = ScriptSetup();
3895        eval {
3896            # ... get data from $cgi, put it in $varHash ...
3897        };
3898        if ($@) {
3899            Trace("Script Error: $@") if T(0);
3900        }
3901        ScriptFinish("Html/MyTemplate.html", $varHash);
3902    
3903    The idea here is that even if the script fails, you'll see trace messages and
3904    useful output.
3905    
3906    =over 4
3907    
3908    =item webData
3909    
3910    A string containing either the full web page to be written to the output or the
3911    name of a template file from which the page is to be constructed. If the name
3912    of a template file is specified, then the second parameter must be present;
3913    otherwise, it must be absent.
3914    
3915    =item varHash (optional)
3916    
3917    If specified, then a reference to a hash mapping variable names for a template
3918    to their values. The template file will be read into memory, and variable markers
3919    will be replaced by data in this hash reference.
3920    
3921    =back
3922    
3923    =cut
3924    
3925    sub ScriptFinish {
3926        # Get the parameters.
3927        my ($webData, $varHash) = @_;
3928        # Check for a template file situation.
3929        my $outputString;
3930        if (defined $varHash) {
3931            # Here we have a template file. We need to determine the template type.
3932            my $template;
3933            if ($FIG_Config::template_url && $webData =~ /\.php$/) {
3934                $template = "$FIG_Config::template_url/$webData";
3935            } else {
3936                $template = "<<$webData";
3937            }
3938            $outputString = PageBuilder::Build($template, $varHash, "Html");
3939        } else {
3940            # Here the user gave us a raw string.
3941            $outputString = $webData;
3942        }
3943        # Check for trace messages.
3944        if ($Destination ne "NONE" && $TraceLevel > 0) {
3945            # We have trace messages, so we want to put them at the end of the body. This
3946            # is either at the end of the whole string or at the beginning of the BODY
3947            # end-tag.
3948            my $pos = length $outputString;
3949            if ($outputString =~ m#</body>#gi) {
3950                $pos = (pos $outputString) - 7;
3951            }
3952            # If the trace messages were queued, we unroll them. Otherwise, we display the
3953            # destination.
3954            my $traceHtml;
3955            if ($Destination eq "QUEUE") {
3956                $traceHtml = QTrace('Html');
3957            } elsif ($Destination =~ /^>>(.+)$/) {
3958                # Here the tracing output it to a file. We code it as a hyperlink so the user
3959                # can copy the file name into the clipboard easily.
3960                my $actualDest = $1;
3961                $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
3962            } else {
3963                # Here we have one of the special destinations.
3964                $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
3965            }
3966            substr $outputString, $pos, 0, $traceHtml;
3967        }
3968        # Write the output string.
3969        print $outputString;
3970    }
3971    
3972  =head3 GenerateURL  =head3 GenerateURL
3973    
3974      my $queryUrl = Tracer::GenerateURL($page, %parameters);      my $queryUrl = Tracer::GenerateURL($page, %parameters);
# Line 3335  Line 4103 
4103      return $retVal;      return $retVal;
4104  }  }
4105    
 =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;  
 }  
   
   
4106  =head3 TrackingCode  =head3 TrackingCode
4107    
4108      my $html = Tracer::TrackingCode();      my $html = Tracer::TrackingCode();
# Line 3424  Line 4133 
4133      return $retVal;      return $retVal;
4134  }  }
4135    
4136    =head3 Clean
4137    
4138        my $cleaned = Tracer::Clean($string);
4139    
4140    Clean up a string for HTML display. This not only converts special
4141    characters to HTML entity names, it also removes control characters.
4142    
4143    =over 4
4144    
4145    =item string
4146    
4147    String to convert.
4148    
4149    =item RETURN
4150    
4151    Returns the input string with anything that might disrupt an HTML literal removed. An
4152    undefined value will be converted to an empty string.
4153    
4154    =back
4155    
4156    =cut
4157    
4158    sub Clean {
4159        # Get the parameters.
4160        my ($string) = @_;
4161        # Declare the return variable.
4162        my $retVal = "";
4163        # Only proceed if the value exists.
4164        if (defined $string) {
4165            # Get the string.
4166            $retVal = $string;
4167            # Clean the control characters.
4168            $retVal =~ tr/\x00-\x1F/?/;
4169            # Escape the rest.
4170            $retVal = CGI::escapeHTML($retVal);
4171        }
4172        # Return the result.
4173        return $retVal;
4174    }
4175    
4176    =head3 SortByValue
4177    
4178        my @keys = Tracer::SortByValue(\%hash);
4179    
4180    Get a list of hash table keys sorted by hash table values.
4181    
4182    =over 4
4183    
4184    =item hash
4185    
4186    Hash reference whose keys are to be extracted.
4187    
4188    =item RETURN
4189    
4190    Returns a list of the hash keys, ordered so that the corresponding hash values
4191    are in alphabetical sequence.
4192    
4193    =back
4194    
4195    =cut
4196    
4197    sub SortByValue {
4198        # Get the parameters.
4199        my ($hash) = @_;
4200        # Sort the hash's keys using the values.
4201        my @retVal = sort { Cmp($hash->{$a}, $hash->{$b}) } keys %$hash;
4202        # Return the result.
4203        return @retVal;
4204    }
4205    
4206    =head3 GetSet
4207    
4208        my $value = Tracer::GetSet($object, $name => $newValue);
4209    
4210    Get or set the value of an object field. The object is treated as an
4211    ordinary hash reference. If a new value is specified, it is stored in the
4212    hash under the specified name and then returned. If no new value is
4213    specified, the current value is returned.
4214    
4215    =over 4
4216    
4217    =item object
4218    
4219    Reference to the hash that is to be interrogated or updated.
4220    
4221    =item name
4222    
4223    Name of the field. This is the hash key.
4224    
4225    =item newValue (optional)
4226    
4227    New value to be stored in the field. If no new value is specified, the current
4228    value of the field is returned.
4229    
4230    =item RETURN
4231    
4232    Returns the value of the named field in the specified hash.
4233    
4234    =back
4235    
4236    =cut
4237    
4238    sub GetSet {
4239        # Get the parameters.
4240        my ($object, $name, $newValue) = @_;
4241        # Is a new value specified?
4242        if (defined $newValue) {
4243            # Yes, so store it.
4244            $object->{$name} = $newValue;
4245        }
4246        # Return the result.
4247        return $object->{$name};
4248    }
4249    
4250  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3