[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.73, Tue Oct 3 12:04:50 2006 UTC revision 1.90, Mon Jul 16 19:44:02 2007 UTC
# Line 34  Line 34 
34      use LWP::UserAgent;      use LWP::UserAgent;
35      use Time::HiRes 'gettimeofday';      use Time::HiRes 'gettimeofday';
36      use URI::Escape;      use URI::Escape;
37        use Time::Local;
38    
39  =head1 Tracing and Debugging Helpers  =head1 Tracing and Debugging Helpers
40    
# Line 185  Line 186 
186  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing  using the L</StandardScript> or L</StandardSetup> methods, emergency tracing
187  will be configured automatically.  will be configured automatically.
188    
189    NOTE: to configure emergency tracing from the command line instead of the Debugging
190    Control Panel (see below), use the C<trace.pl> script.
191    
192  =head3 Debugging Control Panel  =head3 Debugging Control Panel
193    
194  The debugging control panel provides several tools to assist in development of  The debugging control panel provides several tools to assist in development of
# Line 444  Line 448 
448                            noAlias => [0, "do not expect aliases in CHANGE transactions"],                            noAlias => [0, "do not expect aliases in CHANGE transactions"],
449                            start => [' ', "start with this genome"],                            start => [' ', "start with this genome"],
450                            tblFiles => [0, "output TBL files containing the corrected IDs"] },                            tblFiles => [0, "output TBL files containing the corrected IDs"] },
451                          "command transactionDirectory IDfile",                          "<command> <transactionDirectory> <IDfile>",
452                        @ARGV);                        @ARGV);
453    
454    
# Line 456  Line 460 
460    
461      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl      TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
462    
463    Single and double hyphens are equivalent. So, you could also code the
464    above command as
465    
466        TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
467    
468  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional  In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
469  parameters, and would find themselves in I<@parameters> after executing the  parameters, and would find themselves in I<@parameters> after executing the
470  above code fragment. The tracing would be set to level 2, and the categories  above code fragment. The tracing would be set to level 2, and the categories
# Line 490  Line 499 
499  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
500  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 PID.
501    
502  Finally, if the special option C<-h> is specified, the option names will  Finally, if the special option C<-help> is specified, the option
503  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.
504  This provides a limited help capability. For example, if the user enters  This provides a limited help capability. For example, if the user enters
505    
506      TransactFeatures -h      TransactFeatures -help
507    
508  he would see the following output.  he would see the following output.
509    
510      TransactFeatures [options] command transactionDirectory IDfile      TransactFeatures [options] <command> <transactionDirectory> <IDfile>
511          -trace    tracing level (default E)          -trace    tracing level (default E)
512          -sql      trace SQL commands          -sql      trace SQL commands
513          -safe     use database transactions          -safe     use database transactions
# Line 570  Line 579 
579      my $tkey = EmergencyKey();      my $tkey = EmergencyKey();
580      # Add the tracing options.      # Add the tracing options.
581      if (! exists $options->{trace}) {      if (! exists $options->{trace}) {
582          $options->{trace} = ['E', "tracing level (E for emergency tracing)"];          $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
583      }      }
584      $options->{sql} = [0, "turn on SQL tracing"];      $options->{sql} = [0, "turn on SQL tracing"];
585      $options->{h} = [0, "display command-line options"];      $options->{help} = [0, "display command-line options"];
586      $options->{user} = [$tkey, "tracing key"];      $options->{user} = [$tkey, "tracing key"];
587      $options->{background} = [0, "spool standard and error output"];      $options->{background} = [0, "spool standard and error output"];
588      # Create a parsing hash from the options hash. The parsing hash      # Create a parsing hash from the options hash. The parsing hash
# Line 648  Line 657 
657      }      }
658      # Check for the "h" option. If it is specified, dump the command-line      # Check for the "h" option. If it is specified, dump the command-line
659      # options and exit the program.      # options and exit the program.
660      if ($retOptions->{h}) {      if ($retOptions->{help}) {
661          $0 =~ m#[/\\](\w+)(\.pl)?$#i;          $0 =~ m#[/\\](\w+)(\.pl)?$#i;
662          print "$1 [options] $parmHelp\n";          print "$1 [options] $parmHelp\n";
663          for my $key (sort keys %{$options}) {          for my $key (sort keys %{$options}) {
# Line 661  Line 670 
670          }          }
671          exit(0);          exit(0);
672      }      }
673        # Trace the options, if applicable.
674        if (T(3)) {
675            my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
676            Trace("Selected options: " . join(", ", sort @parms) . ".");
677        }
678      # Return the parsed parameters.      # Return the parsed parameters.
679      return ($retOptions, @retParameters);      return ($retOptions, @retParameters);
680  }  }
# Line 931  Line 945 
945      return $value;      return $value;
946  }  }
947    
948    =head3 ParseTraceDate
949    
950    C<< my $time = Tracer::ParseTraceDate($dateString); >>
951    
952    Convert a date from the trace file into a PERL timestamp.
953    
954    =over 4
955    
956    =item dateString
957    
958    The date string from the trace file. The format of the string is determined by the
959    L</Now> method.
960    
961    =item RETURN
962    
963    Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
964    the time string is invalid.
965    
966    =back
967    
968    =cut
969    
970    sub ParseTraceDate {
971        # Get the parameters.
972        my ($dateString) = @_;
973        # Declare the return variable.
974        my $retVal;
975        # Parse the date.
976        if ($dateString =~ m#(\d+)/(\d+)/(\d+)\s+(\d+):(\d+):(\d+)#) {
977            # Create a time object. Note we need to convert the day, month,
978            # and year to a different base. Years count from 1900, and
979            # the internal month value is relocated to January = 0.
980            $retVal = timelocal($6, $5, $4, $2, $1 - 1, $3 - 1900);
981        }
982        # Return the result.
983        return $retVal;
984    }
985    
986  =head3 LogErrors  =head3 LogErrors
987    
988  C<< Tracer::LogErrors($fileName); >>  C<< Tracer::LogErrors($fileName); >>
# Line 1133  Line 1185 
1185      # Get the timestamp.      # Get the timestamp.
1186      my $timeStamp = Now();      my $timeStamp = Now();
1187      # Format the message. Note we strip off any line terminators at the end.      # Format the message. Note we strip off any line terminators at the end.
1188      my $formatted = "[$timeStamp] <$LastCategory>: " . Strip($message);      my $prefix = "[$timeStamp] <$LastCategory>: ";
1189        my $formatted = $prefix . Strip($message);
1190      # Process according to the destination.      # Process according to the destination.
1191      if ($Destination eq "TEXT") {      if ($Destination eq "TEXT") {
1192          # Write the message to the standard output.          # Write the message to the standard output.
# Line 1147  Line 1200 
1200      } elsif ($Destination eq "HTML") {      } elsif ($Destination eq "HTML") {
1201          # Convert the message to HTML and write it to the standard output.          # Convert the message to HTML and write it to the standard output.
1202          my $escapedMessage = CGI::escapeHTML($message);          my $escapedMessage = CGI::escapeHTML($message);
1203          print "<p>$formatted</p>\n";          print "<p>$timeStamp $LastCategory: $escapedMessage</p>\n";
1204      } elsif ($Destination eq "WARN") {      } elsif ($Destination eq "WARN") {
1205         # Emit the message as a warning.         # Emit the message as a warning.
1206         warn $message;         warn $message;
# Line 1212  Line 1265 
1265              if (!$package) {              if (!$package) {
1266                  $category = "main";                  $category = "main";
1267              } else {              } else {
1268                  $category = $package;                  my @cats = split /::/, $package;
1269                    $category = $cats[$#cats];
1270              }              }
1271          }          }
1272          # Save the category name.          # Save the category name.
# Line 1242  Line 1296 
1296    
1297  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>  C<< my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words); >>
1298    
1299  In this case, the list @words will be treated as a command line. There are two options available,  In this case, the list @words will be treated as a command line and there are two options available,
1300  B<errors> and B<logFile>. If @words has the following format  B<errors> and B<logFile>. If @words has the following format
1301    
1302  C<< -logFile=error.log apple orange rutabaga >>  C<< -logFile=error.log apple orange rutabaga >>
# Line 1256  Line 1310 
1310  C<< apple orange rutabaga >>  C<< apple orange rutabaga >>
1311    
1312  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no  The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
1313  support for quote characters.  support for quote characters. Options can be specified with single or double hyphens.
1314    
1315  =over 4  =over 4
1316    
# Line 1281  Line 1335 
1335      my ($optionTable, @inputList) = @_;      my ($optionTable, @inputList) = @_;
1336      # Process any options in the input list.      # Process any options in the input list.
1337      my %overrides = ();      my %overrides = ();
1338      while ((@inputList > 0) && ($inputList[0] =~ /^-/)) {      while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
1339          # Get the current option.          # Get the current option.
1340          my $arg = shift @inputList;          my $arg = shift @inputList;
1341          # Pull out the option name.          # Pull out the option name.
1342          $arg =~ /^-([^=]*)/g;          $arg =~ /^--?([^=]*)/g;
1343          my $name = $1;          my $name = $1;
1344          # Check for an option value.          # Check for an option value.
1345          if ($arg =~ /\G=(.*)$/g) {          if ($arg =~ /\G=(.*)$/g) {
# Line 1598  Line 1652 
1652      # Close it.      # Close it.
1653      close $handle;      close $handle;
1654      my $actualLines = @retVal;      my $actualLines = @retVal;
1655        Trace("$actualLines lines read from file $fileName.") if T(File => 2);
1656      # Return the file's contents in the desired format.      # Return the file's contents in the desired format.
1657      if (wantarray) {      if (wantarray) {
1658          return @retVal;          return @retVal;
# Line 1633  Line 1688 
1688      my ($fileName, $lines) = @_;      my ($fileName, $lines) = @_;
1689      # Open the output file.      # Open the output file.
1690      my $handle = Open(undef, ">$fileName");      my $handle = Open(undef, ">$fileName");
1691        # Count the lines written.
1692      if (ref $lines ne 'ARRAY') {      if (ref $lines ne 'ARRAY') {
1693          # Here we have a scalar, so we write it raw.          # Here we have a scalar, so we write it raw.
1694          print $handle $lines;          print $handle $lines;
1695            Trace("Scalar put to file $fileName.") if T(File => 3);
1696      } else {      } else {
1697          # Write the lines one at a time.          # Write the lines one at a time.
1698            my $count = 0;
1699          for my $line (@{$lines}) {          for my $line (@{$lines}) {
1700              print $handle "$line\n";              print $handle "$line\n";
1701                $count++;
1702          }          }
1703            Trace("$count lines put to file $fileName.") if T(File => 3);
1704      }      }
1705      # Close the output file.      # Close the output file.
1706      close $handle;      close $handle;
# Line 1714  Line 1774 
1774  sub Confess {  sub Confess {
1775      # Get the parameters.      # Get the parameters.
1776      my ($message) = @_;      my ($message) = @_;
1777        if (! defined($FIG_Config::no_tool_hdr)) {
1778            # Here we have a tool header. Display its length so that the user can adjust the line numbers.
1779            my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
1780            # Only proceed if the tool header file is actually present.
1781            if (-f $toolHeaderFile) {
1782                my @lines = GetFile($toolHeaderFile);
1783                Trace("Tool header has " . scalar(@lines) . " lines.");
1784            }
1785        }
1786      # Trace the call stack.      # Trace the call stack.
1787      Cluck($message);      Cluck($message);
1788      # Abort the program.      # Abort the program.
# Line 2059  Line 2128 
2128  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>  C<< my ($cgi, $varHash) = ScriptSetup($noTrace); >>
2129    
2130  Perform standard tracing and debugging setup for scripts. The value returned is  Perform standard tracing and debugging setup for scripts. The value returned is
2131  the CGI object followed by a pre-built variable hash.  the CGI object followed by a pre-built variable hash. At the end of the script,
2132    the client should call L</ScriptFinish> to output the web page.
 The C<Trace> form parameter is used to determine whether or not tracing is active and  
 which trace modules (other than C<Tracer> itself) should be turned on. Specifying  
 the C<CGI> trace module will trace parameter and environment information. Parameters are  
 traced at level 3 and environment variables at level 4. To trace to a file instead of to  
 the web page, set C<TF> to 1. At the end of the script, the client should call  
 L</ScriptFinish> to output the web page.  
2133    
2134  In some situations, it is not practical to invoke tracing via form parameters. For this  This method calls L</ETracing> to configure tracing, which allows the tracing
2135  situation, you can turn on emergency tracing from the debugging control panel.  to be configured via the emergency tracing form on the debugging control panel.
2136  Tracing will then be turned on automatically for all programs that use the L</ETracing>  Tracing will then be turned on automatically for all programs that use the L</ETracing>
2137  method, which includes every program that uses this method or L</StandardSetup>.  method, which includes every program that uses this method or L</StandardSetup>.
2138    
# Line 2246  Line 2309 
2309  This method converts an emergency tracing destination to a real  This method converts an emergency tracing destination to a real
2310  tracing destination. The main difference is that if the  tracing destination. The main difference is that if the
2311  destination is C<FILE> or C<APPEND>, we convert it to file  destination is C<FILE> or C<APPEND>, we convert it to file
2312  output.  output. If the destination is C<DUAL>, we convert it to file
2313    and standard output.
2314    
2315  =over 4  =over 4
2316    
# Line 2270  Line 2334 
2334      # Get the parameters.      # Get the parameters.
2335      my ($tkey, $myDest) = @_;      my ($tkey, $myDest) = @_;
2336      # Declare the return variable.      # Declare the return variable.
2337      my $retVal;      my $retVal = $myDest;
2338      # Process according to the destination value.      # Process according to the destination value.
2339      if ($myDest eq 'FILE') {      if ($myDest eq 'FILE') {
2340          $retVal = ">" . EmergencyFileTarget($tkey);          $retVal = ">" . EmergencyFileTarget($tkey);
2341      } elsif ($myDest eq 'APPEND') {      } elsif ($myDest eq 'APPEND') {
2342          $retVal = ">>" . EmergencyFileTarget($tkey);          $retVal = ">>" . EmergencyFileTarget($tkey);
2343      } else {      } elsif ($myDest eq 'DUAL') {
2344          $retVal = $myDest;          $retVal = "+>" . EmergencyFileTarget($tkey);
2345      }      }
2346      # Return the result.      # Return the result.
2347      return $retVal;      return $retVal;
# Line 2287  Line 2351 
2351    
2352  C<< Emergency($key, $hours, $dest, $level, @modules); >>  C<< Emergency($key, $hours, $dest, $level, @modules); >>
2353    
2354  Turn on emergency tracing. This method can only be invoked over the web and is  Turn on emergency tracing. This method is normally invoked over the web from
2355  should not be called if debug mode is off. The caller specifies the duration of the  a debugging console, but it can also be called by the C<trace.pl> script.
2356  emergency in hours, the desired tracing destination, the trace level,  The caller specifies the duration of the emergency in hours, the desired tracing
2357  and a list of the trace modules to activate. For the length of the duration, when a  destination, the trace level, and a list of the trace modules to activate.
2358  program in an environment with the specified tracing key active invokes a Sprout  For the length of the duration, when a program in an environment with the
2359  CGI script, tracing will be turned on automatically. See L</TSetup> for more  specified tracing key active invokes a Sprout CGI script, tracing will be
2360  about tracing setup and L</ETracing> for more about emergency tracing.  turned on automatically. See L</TSetup> for more about tracing setup and
2361    L</ETracing> for more about emergency tracing.
2362    
2363  =over 4  =over 4
2364    
# Line 2546  Line 2611 
2611  sub Insure {  sub Insure {
2612      my ($dirName) = @_;      my ($dirName) = @_;
2613      if (! -d $dirName) {      if (! -d $dirName) {
2614          Trace("Creating $dirName directory.") if T(2);          Trace("Creating $dirName directory.") if T(File => 2);
2615          eval { mkpath $dirName; };          eval { mkpath $dirName; };
2616          if ($@) {          if ($@) {
2617              Confess("Error creating $dirName: $@");              Confess("Error creating $dirName: $@");
# Line 2575  Line 2640 
2640      if (! -d $dirName) {      if (! -d $dirName) {
2641          Confess("Cannot change to directory $dirName: no such directory.");          Confess("Cannot change to directory $dirName: no such directory.");
2642      } else {      } else {
2643          Trace("Changing to directory $dirName.") if T(4);          Trace("Changing to directory $dirName.") if T(File => 4);
2644          my $okFlag = chdir $dirName;          my $okFlag = chdir $dirName;
2645          if (! $okFlag) {          if (! $okFlag) {
2646              Confess("Error switching to directory $dirName.");              Confess("Error switching to directory $dirName.");
# Line 2754  Line 2819 
2819          my $gid = getgrnam($group);          my $gid = getgrnam($group);
2820          # Get the mask for tracing.          # Get the mask for tracing.
2821          my $traceMask = sprintf("%04o", $mask) . "($mask)";          my $traceMask = sprintf("%04o", $mask) . "($mask)";
2822          Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(2);          Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2823          my $fixCount = 0;          my $fixCount = 0;
2824          my $lookCount = 0;          my $lookCount = 0;
2825          # @dirs will be a stack of directories to be processed.          # @dirs will be a stack of directories to be processed.
# Line 2769  Line 2834 
2834              if ($dir =~ m!/([^/]+)$!) {              if ($dir =~ m!/([^/]+)$!) {
2835                  $simpleName = $1;                  $simpleName = $1;
2836              }              }
2837              Trace("Simple directory name for $dir is $simpleName.") if T(4);              Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2838              # Search for a match.              # Search for a match.
2839              my $match = 0;              my $match = 0;
2840              my $i;              my $i;
# Line 2794  Line 2859 
2859                      Trace("Checking member $thisMem.") if T(4);                      Trace("Checking member $thisMem.") if T(4);
2860                      $lookCount++;                      $lookCount++;
2861                      if ($lookCount % 1000 == 0) {                      if ($lookCount % 1000 == 0) {
2862                          Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(3);                          Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2863                      }                      }
2864                      # Fix the group.                      # Fix the group.
2865                      chown -1, $gid, $thisMem;                      chown -1, $gid, $thisMem;
# Line 2821  Line 2886 
2886                  }                  }
2887              }              }
2888          }          }
2889          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(2);          Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2890      };      };
2891      # Check for an error.      # Check for an error.
2892      if ($@) {      if ($@) {
# Line 2924  Line 2989 
2989      my ($handle) = @_;      my ($handle) = @_;
2990      # Declare the return variable.      # Declare the return variable.
2991      my @retVal = ();      my @retVal = ();
2992        Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2993      # Read from the file.      # Read from the file.
2994      my $line = <$handle>;      my $line = <$handle>;
2995      # Only proceed if we found something.      # Only proceed if we found something.
2996      if (defined $line) {      if (defined $line) {
2997          # Remove the new-line.          # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2998          chomp $line;          # upload control and have a nonstandard EOL combination.
2999            $line =~ s/(\r|\n)+$//;
3000            # Here we do some fancy tracing to help in debugging complicated EOL marks.
3001            if (T(File => 4)) {
3002                my $escapedLine = $line;
3003                $escapedLine =~ s/\n/\\n/g;
3004                $escapedLine =~ s/\r/\\r/g;
3005                $escapedLine =~ s/\t/\\t/g;
3006                Trace("Line read: -->$escapedLine<--");
3007            }
3008          # If the line is empty, return a single empty string; otherwise, parse          # If the line is empty, return a single empty string; otherwise, parse
3009          # it into fields.          # it into fields.
3010          if ($line eq "") {          if ($line eq "") {
# Line 2937  Line 3012 
3012          } else {          } else {
3013              push @retVal, split /\t/,$line;              push @retVal, split /\t/,$line;
3014          }          }
3015        } else {
3016            # Trace the reason the read failed.
3017            Trace("End of file: $!") if T(File => 3);
3018      }      }
3019      # Return the result.      # Return the result.
3020      return @retVal;      return @retVal;
# Line 2944  Line 3022 
3022    
3023  =head3 PutLine  =head3 PutLine
3024    
3025  C<< Tracer::PutLine($handle, \@fields); >>  C<< Tracer::PutLine($handle, \@fields, $eol); >>
3026    
3027  Write a line of data to a tab-delimited file. The specified field values will be  Write a line of data to a tab-delimited file. The specified field values will be
3028  output in tab-separated form, with a trailing new-line.  output in tab-separated form, with a trailing new-line.
# Line 2959  Line 3037 
3037    
3038  List of field values.  List of field values.
3039    
3040    =item eol (optional)
3041    
3042    End-of-line character (default is "\n").
3043    
3044  =back  =back
3045    
3046  =cut  =cut
3047    
3048  sub PutLine {  sub PutLine {
3049      # Get the parameters.      # Get the parameters.
3050      my ($handle, $fields) = @_;      my ($handle, $fields, $eol) = @_;
3051      # Write the data.      # Write the data.
3052      print $handle join("\t", @{$fields}) . "\n";      print $handle join("\t", @{$fields}) . ($eol || "\n");
3053  }  }
3054    
3055  =head3 GenerateURL  =head3 GenerateURL
# Line 2982  Line 3064 
3064    
3065  would return  would return
3066    
3067      form.cgi?type=1&string=%22high%20pass%22%20or%20highway      form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3068    
3069  =over 4  =over 4
3070    
# Line 3012  Line 3094 
3094      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;      my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3095      # If the list is nonempty, tack it on.      # If the list is nonempty, tack it on.
3096      if (@parmList) {      if (@parmList) {
3097          $retVal .= "?" . join("&", @parmList);          $retVal .= "?" . join(";", @parmList);
3098      }      }
3099      # Return the result.      # Return the result.
3100      return $retVal;      return $retVal;
3101  }  }
3102    
3103    =head3 ApplyURL
3104    
3105    C<< Tracer::ApplyURL($table, $target, $url); >>
3106    
3107    Run through a two-dimensional table (or more accurately, a list of lists), converting the
3108    I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3109    URL column will be deleted by this process and the target column will be HTML-escaped.
3110    
3111    This provides a simple way to process the results of a database query into something
3112    displayable by combining a URL with text.
3113    
3114    =over 4
3115    
3116    =item table
3117    
3118    Reference to a list of lists. The elements in the containing list will be updated by
3119    this method.
3120    
3121    =item target
3122    
3123    The index of the column to be converted into HTML.
3124    
3125    =item url
3126    
3127    The index of the column containing the URL. Note that the URL must have a recognizable
3128    C<http:> at the beginning.
3129    
3130    =back
3131    
3132    =cut
3133    
3134    sub ApplyURL {
3135        # Get the parameters.
3136        my ($table, $target, $url) = @_;
3137        # Loop through the table.
3138        for my $row (@{$table}) {
3139            # Apply the URL to the target cell.
3140            $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3141            # Delete the URL from the row.
3142            delete $row->[$url];
3143        }
3144    }
3145    
3146    =head3 CombineURL
3147    
3148    C<< my $combinedHtml = Tracer::CombineURL($text, $url); >>
3149    
3150    This method will convert the specified text into HTML hyperlinked to the specified
3151    URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3152    is defined and begins with an C<http:> header.
3153    
3154    =over 4
3155    
3156    =item text
3157    
3158    Text to return. This will be HTML-escaped automatically.
3159    
3160    =item url
3161    
3162    A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3163    will be returned without any hyperlinking.
3164    
3165    =item RETURN
3166    
3167    Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3168    doesn't look right, the HTML-escaped text will be returned without any further
3169    modification.
3170    
3171    =back
3172    
3173    =cut
3174    
3175    sub CombineURL {
3176        # Get the parameters.
3177        my ($text, $url) = @_;
3178        # Declare the return variable.
3179        my $retVal = CGI::escapeHTML($text);
3180        # Verify the URL.
3181        if (defined($url) && $url =~ m!http://!i) {
3182            # It's good, so we apply it to the text.
3183            $retVal = "<a href=\"$url\">$retVal</a>";
3184        }
3185        # Return the result.
3186        return $retVal;
3187    }
3188    
3189    
3190  1;  1;

Legend:
Removed from v.1.73  
changed lines
  Added in v.1.90

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3