[Bio] / FigKernelPackages / Tracer.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/Tracer.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.112 - (view) (download) (as text)

1 : gdpusch 1.95 # -*- perl -*-
2 :     ########################################################################
3 : olson 1.30 # Copyright (c) 2003-2006 University of Chicago and Fellowship
4 :     # for Interpretations of Genomes. All Rights Reserved.
5 :     #
6 :     # This file is part of the SEED Toolkit.
7 : parrello 1.61 #
8 : olson 1.30 # The SEED Toolkit is free software. You can redistribute
9 :     # it and/or modify it under the terms of the SEED Toolkit
10 : parrello 1.61 # Public License.
11 : olson 1.30 #
12 :     # You should have received a copy of the SEED Toolkit Public License
13 :     # along with this program; if not write to the University of Chicago
14 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
15 :     # Genomes at veronika@thefig.info or download a copy from
16 :     # http://www.theseed.org/LICENSE.TXT.
17 : gdpusch 1.95 ########################################################################
18 : olson 1.30
19 : olson 1.1 package Tracer;
20 :    
21 : parrello 1.12 require Exporter;
22 :     @ISA = ('Exporter');
23 : parrello 1.99 @EXPORT = qw(Trace T TSetup QTrace Confess Cluck Min Max Assert Open OpenDir TICK StandardSetup EmergencyKey ETracing Constrain Insure ChDir Emergency Warn);
24 : parrello 1.97 @EXPORT_OK = qw(GetFile GetOptions Merge MergeOptions ParseCommand ParseRecord UnEscape Escape PrintLine PutLine);
25 : parrello 1.12 use strict;
26 : gdpusch 1.96 use Carp qw(longmess croak carp);
27 : parrello 1.12 use CGI;
28 : parrello 1.47 use Cwd;
29 : parrello 1.12 use FIG_Config;
30 : parrello 1.9 use PageBuilder;
31 : parrello 1.21 use Digest::MD5;
32 : parrello 1.36 use File::Basename;
33 : parrello 1.37 use File::Path;
34 : parrello 1.48 use File::stat;
35 : parrello 1.59 use LWP::UserAgent;
36 : parrello 1.64 use Time::HiRes 'gettimeofday';
37 : parrello 1.65 use URI::Escape;
38 : parrello 1.74 use Time::Local;
39 : parrello 1.99 use POSIX qw(strftime);
40 :     use Time::Zone;
41 : parrello 1.111 use Fcntl qw(:DEFAULT :flock);
42 : parrello 1.99
43 : olson 1.1
44 :     =head1 Tracing and Debugging Helpers
45 :    
46 : parrello 1.72 =head2 Tracing
47 : olson 1.1
48 :     This package provides simple tracing for debugging and reporting purposes. To use it simply call the
49 : parrello 1.72 L</TSetup> or L</ETracing> method to set the options and call L</Trace> to write out trace messages.
50 :     L</TSetup> and L</ETracing> both establish a I<trace level> and a list of I<categories>. Similarly,
51 :     each trace message has a I<trace level> and I<category> associated with it. Only messages whose trace
52 :     level is less than or equal to the setup trace level and whose category is activated will
53 : parrello 1.2 be written. Thus, a higher trace level on a message indicates that the message
54 : parrello 1.72 is less likely to be seen, while a higher trace level passed to B<TSetup> means more trace messages will
55 :     appear.
56 : olson 1.1
57 : parrello 1.72 =head3 Putting Trace Messages in Your Code
58 :    
59 :     To generate a trace message, use the following syntax.
60 :    
61 :     Trace($message) if T(errors => 4);
62 : olson 1.1
63 : parrello 1.2 This statement will produce a trace message if the trace level is 4 or more and the C<errors>
64 : parrello 1.72 category is active. There is a special category C<main> that is always active, so
65 : olson 1.1
66 : parrello 1.72 Trace($message) if T(main => 4);
67 : olson 1.1
68 :     will trace if the trace level is 4 or more.
69 :    
70 :     If the category name is the same as the package name, all you need is the number. So, if the
71 :     following call is made in the B<Sprout> package, it will appear if the C<Sprout> category is
72 :     active and the trace level is 2 or more.
73 :    
74 : parrello 1.72 Trace($message) if T(2);
75 :    
76 :     In scripts, where no package name is available, the category defaults to C<main>.
77 :    
78 :     =head3 Custom Tracing
79 :    
80 :     Many programs have customized tracing configured using the L</TSetup> method. This is no longer
81 :     the preferred method, but a knowledge of how custom tracing works can make the more modern
82 :     L</Emergency Tracing> easier to understand.
83 : olson 1.1
84 : parrello 1.72 To set up custom tracing, you call the L</TSetup> method. The method takes as input a trace level,
85 :     a list of category names, and a destination. The trace level and list of category names are
86 : olson 1.1 specified as a space-delimited string. Thus
87 :    
88 : parrello 1.72 TSetup('3 errors Sprout ERDB', 'TEXT');
89 : olson 1.1
90 : parrello 1.7 sets the trace level to 3, activates the C<errors>, C<Sprout>, and C<ERDB> categories, and
91 : parrello 1.72 specifies that messages should be sent to the standard output.
92 : parrello 1.12
93 :     To turn on tracing for ALL categories, use an asterisk. The call below sets every category to
94 :     level 3 and writes the output to the standard error output. This sort of thing might be
95 :     useful in a CGI environment.
96 :    
97 : parrello 1.72 TSetup('3 *', 'WARN');
98 : olson 1.1
99 : parrello 1.72 In addition standard error and file output for trace messages, you can specify that the trace messages
100 : olson 1.1 be queued. The messages can then be retrieved by calling the L</QTrace> method. This approach
101 :     is useful if you are building a web page. Instead of having the trace messages interspersed with
102 :     the page output, they can be gathered together and displayed at the end of the page. This makes
103 :     it easier to debug page formatting problems.
104 :    
105 : parrello 1.72 Finally, you can specify that all trace messages be emitted to a file, or the standard output and
106 :     a file at the same time. To trace to a file, specify the filename with an output character in front
107 :     of it.
108 :    
109 :     TSetup('4 SQL', ">$fileName");
110 :    
111 :     To trace to the standard output and a file at the same time, put a C<+> in front of the angle
112 :     bracket.
113 :    
114 :     TSetup('3 *', "+>$fileName");
115 : parrello 1.4
116 : olson 1.1 The flexibility of tracing makes it superior to simple use of directives like C<die> and C<warn>.
117 :     Tracer calls can be left in the code with minimal overhead and then turned on only when needed.
118 :     Thus, debugging information is available and easily retrieved even when the application is
119 :     being used out in the field.
120 :    
121 : parrello 1.72 =head3 Trace Levels
122 :    
123 : parrello 1.10 There is no hard and fast rule on how to use trace levels. The following is therefore only
124 :     a suggestion.
125 :    
126 :     =over 4
127 :    
128 : parrello 1.32 =item Error 0
129 : parrello 1.10
130 :     Message indicates an error that may lead to incorrect results or that has stopped the
131 :     application entirely.
132 :    
133 : parrello 1.32 =item Warning 1
134 : parrello 1.10
135 :     Message indicates something that is unexpected but that probably did not interfere
136 :     with program execution.
137 :    
138 : parrello 1.32 =item Notice 2
139 : parrello 1.10
140 :     Message indicates the beginning or end of a major task.
141 :    
142 : parrello 1.32 =item Information 3
143 : parrello 1.10
144 :     Message indicates a subtask. In the FIG system, a subtask generally relates to a single
145 :     genome. This would be a big loop that is not expected to execute more than 500 times or so.
146 :    
147 : parrello 1.32 =item Detail 4
148 : parrello 1.10
149 :     Message indicates a low-level loop iteration.
150 :    
151 :     =back
152 :    
153 : parrello 1.69 The format of trace messages is important because some utilities analyze trace files.
154 : parrello 1.72 There are three fields-- the time stamp, the category name, and the text.
155 :     The time stamp is between square brackets and the category name between angle brackets.
156 :     After the category name there is a colon (C<:>) followed by the message text.
157 :     If the square brackets or angle brackets are missing, then the trace management
158 :     utilities assume that they are encountering a set of pre-formatted lines.
159 :    
160 :     Note, however, that this formatting is done automatically by the tracing functions. You
161 :     only need to know about it if you want to parse a trace file.
162 :    
163 :     =head3 Emergency Tracing
164 :    
165 :     Sometimes, you need a way for tracing to happen automatically without putting parameters
166 :     in a form or on the command line. Emergency tracing does this. You invoke emergency tracing
167 : parrello 1.97 from the debug form, which is accessed from the [[DebugConsole]]. Emergency tracing requires
168 :     that you specify a tracing key. For command-line tools, the key is
169 : parrello 1.72 taken from the C<TRACING> environment variable. For web services, the key is taken from
170 :     a cookie. Either way, the key tells the tracing facility who you are, so that you control
171 :     the tracing in your environment without stepping on other users.
172 :    
173 :     The key can be anything you want. If you don't have a key, the C<SetPassword> page will
174 :     generate one for you.
175 :    
176 :     You can activate and de-activate emergency tracing from the debugging control panel, as
177 :     well as display the trace file itself.
178 :    
179 :     To enable emergency tracing in your code, call
180 :    
181 :     ETracing($cgi)
182 :    
183 :     from a web script and
184 :    
185 :     ETracing()
186 :    
187 :     from a command-line script.
188 :    
189 :     The web script will look for the tracing key in the cookies, and the command-line
190 :     script will look for it in the C<TRACING> environment variable. If you are
191 : parrello 1.97 using the L</StandardSetup> method or a [[WebApplication]], emergency tracing
192 : parrello 1.72 will be configured automatically.
193 :    
194 : olson 1.1 =cut
195 : parrello 1.2
196 : olson 1.1 # Declare the configuration variables.
197 :    
198 : parrello 1.94 my $Destination = "WARN"; # Description of where to send the trace output.
199 : parrello 1.12 my $TeeFlag = 0; # TRUE if output is going to a file and to the
200 :     # standard output
201 : parrello 1.3 my %Categories = ( main => 1 );
202 : parrello 1.12 # hash of active category names
203 : parrello 1.97 my @LevelNames = qw(error warn notice info detail);
204 : parrello 1.12 my $TraceLevel = 0; # trace level; a higher trace level produces more
205 :     # messages
206 :     my @Queue = (); # queued list of trace messages.
207 : parrello 1.7 my $LastCategory = "main"; # name of the last category interrogated
208 : parrello 1.97 my $LastLevel = 0; # level of the last test call
209 : parrello 1.11 my $SetupCount = 0; # number of times TSetup called
210 : parrello 1.12 my $AllTrace = 0; # TRUE if we are tracing all categories.
211 : parrello 1.99 my $SavedCGI; # CGI object passed to ETracing
212 : parrello 1.104 my $CommandLine; # Command line passed to StandardSetup
213 : parrello 1.99 umask 2; # Fix the damn umask so everything is group-writable.
214 : olson 1.1
215 : parrello 1.93 =head2 Tracing Methods
216 :    
217 :     =head3 Setups
218 :    
219 :     my $count = Tracer::Setups();
220 :    
221 :     Return the number of times L</TSetup> has been called.
222 :    
223 :     This method allows for the creation of conditional tracing setups where, for example, we
224 :     may want to set up tracing if nobody else has done it before us.
225 :    
226 :     =cut
227 :    
228 :     sub Setups {
229 :     return $SetupCount;
230 :     }
231 : olson 1.1
232 :     =head3 TSetup
233 :    
234 : parrello 1.92 TSetup($categoryList, $target);
235 : olson 1.1
236 :     This method is used to specify the trace options. The options are stored as package data
237 :     and interrogated by the L</Trace> and L</T> methods.
238 :    
239 :     =over 4
240 :    
241 :     =item categoryList
242 :    
243 :     A string specifying the trace level and the categories to be traced, separated by spaces.
244 :     The trace level must come first.
245 :    
246 :     =item target
247 :    
248 :     The destination for the trace output. To send the trace output to a file, specify the file
249 :     name preceded by a ">" symbol. If a double symbol is used (">>"), then the data is appended
250 : parrello 1.10 to the file. Otherwise the file is cleared before tracing begins. Precede the first ">"
251 :     symbol with a C<+> to echo output to a file AND to the standard output. In addition to
252 :     sending the trace messages to a file, you can specify a special destination. C<HTML> will
253 :     cause tracing to the standard output with each line formatted as an HTML paragraph. C<TEXT>
254 : parrello 1.5 will cause tracing to the standard output as ordinary text. C<ERROR> will cause trace
255 : parrello 1.9 messages to be sent to the standard error output as ordinary text. C<QUEUE> will cause trace
256 : parrello 1.6 messages to be stored in a queue for later retrieval by the L</QTrace> method. C<WARN> will
257 : parrello 1.9 cause trace messages to be emitted as warnings using the B<warn> directive. C<NONE> will
258 : parrello 1.6 cause tracing to be suppressed.
259 : olson 1.1
260 :     =back
261 :    
262 :     =cut
263 :    
264 :     sub TSetup {
265 : parrello 1.12 # Get the parameters.
266 :     my ($categoryList, $target) = @_;
267 :     # Parse the category list.
268 :     my @categoryData = split /\s+/, $categoryList;
269 :     # Extract the trace level.
270 :     $TraceLevel = shift @categoryData;
271 :     # Presume category-based tracing until we learn otherwise.
272 :     $AllTrace = 0;
273 :     # Build the category hash. Note that if we find a "*", we turn on non-category
274 : parrello 1.33 # tracing. We must also clear away any pre-existing data.
275 : parrello 1.34 %Categories = ( main => 1 );
276 : parrello 1.12 for my $category (@categoryData) {
277 :     if ($category eq '*') {
278 :     $AllTrace = 1;
279 :     } else {
280 : parrello 1.13 $Categories{lc $category} = 1;
281 : parrello 1.12 }
282 :     }
283 :     # Now we need to process the destination information. The most important special
284 : parrello 1.98 # case is when we're writing to a file. This is indicated by ">" (overwrite) and
285 :     # ">>" (append). A leading "+" for either indicates that we are also writing to
286 :     # the standard output (tee mode).
287 : parrello 1.12 if ($target =~ m/^\+?>>?/) {
288 :     if ($target =~ m/^\+/) {
289 :     $TeeFlag = 1;
290 :     $target = substr($target, 1);
291 :     }
292 :     if ($target =~ m/^>[^>]/) {
293 : parrello 1.98 # We need to initialize the file (which clears it).
294 : parrello 1.12 open TRACEFILE, $target;
295 : parrello 1.98 print TRACEFILE "[" . Now() . "] [notice] [Tracer] Tracing initialized.\n";
296 : parrello 1.12 close TRACEFILE;
297 : parrello 1.98 # Set to append mode now that the file has been cleared.
298 : parrello 1.12 $Destination = ">$target";
299 :     } else {
300 :     $Destination = $target;
301 :     }
302 :     } else {
303 :     $Destination = uc($target);
304 :     }
305 :     # Increment the setup counter.
306 :     $SetupCount++;
307 : parrello 1.11 }
308 :    
309 : parrello 1.93 =head3 SetLevel
310 : parrello 1.31
311 : parrello 1.93 Tracer::SetLevel($newLevel);
312 : parrello 1.31
313 : parrello 1.93 Modify the trace level. A higher trace level will cause more messages to appear.
314 : parrello 1.31
315 : parrello 1.93 =over 4
316 : parrello 1.31
317 : parrello 1.93 =item newLevel
318 : parrello 1.31
319 : parrello 1.93 Proposed new trace level.
320 : parrello 1.31
321 : parrello 1.93 =back
322 : parrello 1.31
323 : parrello 1.93 =cut
324 : parrello 1.31
325 : parrello 1.93 sub SetLevel {
326 :     $TraceLevel = $_[0];
327 :     }
328 : parrello 1.31
329 : parrello 1.97 =head3 ParseDate
330 :    
331 :     my $time = Tracer::ParseDate($dateString);
332 :    
333 :     Convert a date into a PERL time number. This method expects a date-like string
334 :     and parses it into a number. The string must be vaguely date-like or it will
335 :     return an undefined value. Our requirement is that a month and day be
336 :     present and that three pieces of the date string (time of day, month and day,
337 :     year) be separated by likely delimiters, such as spaces, commas, and such-like.
338 :    
339 :     If a time of day is present, it must be in military time with two digits for
340 :     everything but the hour.
341 : parrello 1.31
342 : parrello 1.97 The year must be exactly four digits.
343 : parrello 1.31
344 : parrello 1.97 Additional stuff can be in the string. We presume it's time zones or weekdays or something
345 :     equally innocuous. This means, however, that a sufficiently long sentence with date-like
346 :     parts in it may be interpreted as a date. Hopefully this will not be a problem.
347 :    
348 :     It should be guaranteed that this method will parse the output of the L</Now> function.
349 :    
350 :     The parameters are as follows.
351 : parrello 1.31
352 : parrello 1.93 =over 4
353 : parrello 1.31
354 : parrello 1.93 =item dateString
355 : parrello 1.31
356 : parrello 1.97 The date string to convert.
357 : parrello 1.31
358 : parrello 1.93 =item RETURN
359 : parrello 1.31
360 : parrello 1.93 Returns a PERL time, that is, a number of seconds since the epoch, or C<undef> if
361 : parrello 1.97 the date string is invalid. A valid date string must contain a month and day.
362 : parrello 1.31
363 : parrello 1.93 =back
364 : parrello 1.38
365 : parrello 1.93 =cut
366 : parrello 1.38
367 : parrello 1.97 # Universal month conversion table.
368 :     use constant MONTHS => { Jan => 0, January => 0, '01' => 0, '1' => 0,
369 :     Feb => 1, February => 1, '02' => 1, '2' => 1,
370 :     Mar => 2, March => 2, '03' => 2, '3' => 2,
371 :     Apr => 3, April => 3, '04' => 3, '4' => 3,
372 :     May => 4, May => 4, '05' => 4, '5' => 4,
373 :     Jun => 5, June => 5, '06' => 5, '6' => 5,
374 :     Jul => 6, July => 6, '07' => 6, '7' => 6,
375 :     Aug => 7, August => 7, '08' => 7, '8' => 7,
376 :     Sep => 8, September => 8, '09' => 8, '9' => 8,
377 :     Oct => 9, October => 9, '10' => 9,
378 :     Nov => 10, November => 10, '11' => 10,
379 :     Dec => 11, December => 11, '12' => 11
380 :     };
381 :    
382 :     sub ParseDate {
383 : parrello 1.93 # Get the parameters.
384 :     my ($dateString) = @_;
385 :     # Declare the return variable.
386 :     my $retVal;
387 : parrello 1.97 # Find the month and day of month. There are two ways that can happen. We check for the
388 :     # numeric style first. That way, if the user's done something like "Sun 12/22", then we
389 :     # won't be fooled into thinking the month is Sunday.
390 :     if ($dateString =~ m#\b(\d{1,2})/(\d{1,2})\b# || $dateString =~ m#\b(\w+)\s(\d{1,2})\b#) {
391 :     my ($mon, $mday) = (MONTHS->{$1}, $2);
392 :     # Insist that the month and day are valid.
393 :     if (defined($mon) && $2 >= 1 && $2 <= 31) {
394 :     # Find the time.
395 :     my ($hour, $min, $sec) = (0, 0, 0);
396 :     if ($dateString =~ /\b(\d{1,2}):(\d{2}):(\d{2})\b/) {
397 :     ($hour, $min, $sec) = ($1, $2, $3);
398 :     }
399 :     # Find the year.
400 :     my $year;
401 :     if ($dateString =~ /\b(\d{4})\b/) {
402 :     $year = $1;
403 :     } else {
404 :     # Get the default year, which is this one. Note we must convert it to
405 :     # the four-digit value expected by "timelocal".
406 :     (undef, undef, undef, undef, undef, $year) = localtime();
407 :     $year += 1900;
408 :     }
409 :     $retVal = timelocal($sec, $min, $hour, $mday, $mon, $year);
410 :     }
411 : parrello 1.93 }
412 :     # Return the result.
413 :     return $retVal;
414 :     }
415 : parrello 1.31
416 : parrello 1.93 =head3 LogErrors
417 : parrello 1.42
418 : parrello 1.93 Tracer::LogErrors($fileName);
419 : parrello 1.31
420 : parrello 1.93 Route the standard error output to a log file.
421 : parrello 1.31
422 : parrello 1.93 =over 4
423 : parrello 1.31
424 : parrello 1.93 =item fileName
425 : parrello 1.31
426 : parrello 1.93 Name of the file to receive the error output.
427 : parrello 1.31
428 : parrello 1.93 =back
429 : parrello 1.31
430 : parrello 1.93 =cut
431 : parrello 1.84
432 : parrello 1.93 sub LogErrors {
433 :     # Get the file name.
434 :     my ($fileName) = @_;
435 :     # Open the file as the standard error output.
436 :     open STDERR, '>', $fileName;
437 :     }
438 : parrello 1.84
439 : parrello 1.93 =head3 Trace
440 : parrello 1.31
441 : parrello 1.93 Trace($message);
442 : parrello 1.31
443 : parrello 1.93 Write a trace message to the target location specified in L</TSetup>. If there has not been
444 :     any prior call to B<TSetup>.
445 : parrello 1.31
446 : parrello 1.93 =over 4
447 : parrello 1.42
448 : parrello 1.93 =item message
449 : parrello 1.42
450 : parrello 1.93 Message to write.
451 : parrello 1.42
452 : parrello 1.93 =back
453 : parrello 1.72
454 : parrello 1.93 =cut
455 : parrello 1.36
456 : parrello 1.93 sub Trace {
457 :     # Get the parameters.
458 :     my ($message) = @_;
459 : parrello 1.97 # Strip off any line terminators at the end of the message. We will add
460 :     # new-line stuff ourselves.
461 :     my $stripped = Strip($message);
462 :     # Compute the caller information.
463 :     my ($callPackage, $callFile, $callLine) = caller();
464 :     my $callFileTitle = basename($callFile);
465 :     # Check the caller.
466 : parrello 1.98 my $callerInfo = ($callFileTitle ne "Tracer.pm" ? " [$callFileTitle $callLine]" : "");
467 : parrello 1.93 # Get the timestamp.
468 :     my $timeStamp = Now();
469 : parrello 1.97 # Build the prefix.
470 :     my $level = $LevelNames[$LastLevel] || "($LastLevel)";
471 : parrello 1.98 my $prefix = "[$timeStamp] [$level] [$LastCategory]$callerInfo";
472 : parrello 1.97 # Format the message.
473 :     my $formatted = "$prefix $stripped";
474 : parrello 1.93 # Process according to the destination.
475 :     if ($Destination eq "TEXT") {
476 :     # Write the message to the standard output.
477 :     print "$formatted\n";
478 :     } elsif ($Destination eq "ERROR") {
479 : parrello 1.97 # Write the message to the error output. Here, we want our prefix fields.
480 : parrello 1.93 print STDERR "$formatted\n";
481 : parrello 1.97 } elsif ($Destination eq "WARN") {
482 :     # Emit the message to the standard error output. It is presumed that the
483 : parrello 1.98 # error logger will add its own prefix fields, the notable exception being
484 :     # the caller info.
485 :     print STDERR "$callerInfo$stripped\n";
486 : parrello 1.93 } elsif ($Destination eq "QUEUE") {
487 :     # Push the message into the queue.
488 :     push @Queue, "$formatted";
489 :     } elsif ($Destination eq "HTML") {
490 :     # Convert the message to HTML and write it to the standard output.
491 : parrello 1.97 my $escapedMessage = CGI::escapeHTML($stripped);
492 :     print "<p>$timeStamp $LastCategory $LastLevel: $escapedMessage</p>\n";
493 : parrello 1.93 } elsif ($Destination =~ m/^>>/) {
494 :     # Write the trace message to an output file.
495 : parrello 1.97 open(TRACING, $Destination) || die "Tracing open for \"$Destination\" failed: $!";
496 : parrello 1.111 # Lock the file.
497 :     flock TRACING, LOCK_EX;
498 : parrello 1.93 print TRACING "$formatted\n";
499 :     close TRACING;
500 :     # If the Tee flag is on, echo it to the standard output.
501 :     if ($TeeFlag) {
502 :     print "$formatted\n";
503 :     }
504 :     }
505 :     }
506 : parrello 1.36
507 : parrello 1.93 =head3 T
508 : parrello 1.36
509 : parrello 1.93 my $switch = T($category, $traceLevel);
510 : parrello 1.36
511 : parrello 1.93 or
512 : parrello 1.44
513 : parrello 1.93 my $switch = T($traceLevel);
514 : parrello 1.44
515 : parrello 1.93 Return TRUE if the trace level is at or above a specified value and the specified category
516 :     is active, else FALSE. If no category is specified, the caller's package name is used.
517 : parrello 1.44
518 : parrello 1.93 =over 4
519 : parrello 1.44
520 : parrello 1.93 =item category
521 : parrello 1.44
522 : parrello 1.93 Category to which the message belongs. If not specified, the caller's package name is
523 :     used.
524 : parrello 1.31
525 : parrello 1.93 =item traceLevel
526 : parrello 1.31
527 : parrello 1.93 Relevant tracing level.
528 : parrello 1.31
529 : parrello 1.93 =item RETURN
530 : parrello 1.31
531 : parrello 1.93 TRUE if a message at the specified trace level would appear in the trace, else FALSE.
532 : parrello 1.31
533 : parrello 1.93 =back
534 : parrello 1.36
535 : parrello 1.93 =cut
536 :    
537 :     sub T {
538 :     # Declare the return variable.
539 :     my $retVal = 0;
540 :     # Only proceed if tracing is turned on.
541 :     if ($Destination ne "NONE") {
542 :     # Get the parameters.
543 :     my ($category, $traceLevel) = @_;
544 :     if (!defined $traceLevel) {
545 :     # Here we have no category, so we need to get the calling package.
546 :     # The calling package is normally the first parameter. If it is
547 :     # omitted, the first parameter will be the tracelevel. So, the
548 :     # first thing we do is shift the so-called category into the
549 :     # $traceLevel variable where it belongs.
550 :     $traceLevel = $category;
551 :     my ($package, $fileName, $line) = caller;
552 :     # If there is no calling package, we default to "main".
553 :     if (!$package) {
554 :     $category = "main";
555 :     } else {
556 :     my @cats = split /::/, $package;
557 :     $category = $cats[$#cats];
558 :     }
559 :     }
560 : parrello 1.97 # Save the category name and level.
561 : parrello 1.93 $LastCategory = $category;
562 : parrello 1.97 $LastLevel = $traceLevel;
563 : parrello 1.93 # Convert it to lower case before we hash it.
564 :     $category = lc $category;
565 : parrello 1.100 # Validate the trace level.
566 : parrello 1.93 if (ref $traceLevel) {
567 :     Confess("Bad trace level.");
568 :     } elsif (ref $TraceLevel) {
569 :     Confess("Bad trace config.");
570 :     }
571 : parrello 1.100 # Make the check. Note that level 0 shows even if the category is turned off.
572 :     $retVal = ($traceLevel <= $TraceLevel && ($traceLevel == 0 || $AllTrace || exists $Categories{$category}));
573 : parrello 1.93 }
574 :     # Return the computed result.
575 :     return $retVal;
576 :     }
577 :    
578 :     =head3 QTrace
579 :    
580 :     my $data = QTrace($format);
581 :    
582 :     Return the queued trace data in the specified format.
583 :    
584 :     =over 4
585 :    
586 :     =item format
587 :    
588 :     C<html> to format the data as an HTML list, C<text> to format it as straight text.
589 :    
590 :     =back
591 :    
592 :     =cut
593 :    
594 :     sub QTrace {
595 :     # Get the parameter.
596 :     my ($format) = @_;
597 :     # Create the return variable.
598 :     my $retVal = "";
599 :     # Only proceed if there is an actual queue.
600 :     if (@Queue) {
601 :     # Process according to the format.
602 :     if ($format =~ m/^HTML$/i) {
603 :     # Convert the queue into an HTML list.
604 :     $retVal = "<ul>\n";
605 :     for my $line (@Queue) {
606 :     my $escapedLine = CGI::escapeHTML($line);
607 :     $retVal .= "<li>$escapedLine</li>\n";
608 :     }
609 :     $retVal .= "</ul>\n";
610 :     } elsif ($format =~ m/^TEXT$/i) {
611 :     # Convert the queue into a list of text lines.
612 :     $retVal = join("\n", @Queue) . "\n";
613 :     }
614 :     # Clear the queue.
615 :     @Queue = ();
616 :     }
617 :     # Return the formatted list.
618 :     return $retVal;
619 :     }
620 :    
621 :     =head3 Confess
622 :    
623 :     Confess($message);
624 :    
625 :     Trace the call stack and abort the program with the specified message. When used with
626 :     the OR operator and the L</Assert> method, B<Confess> can function as a debugging assert.
627 :     So, for example
628 :    
629 :     Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
630 :    
631 :     Will abort the program with a stack trace if the value of C<$recNum> is negative.
632 :    
633 :     =over 4
634 :    
635 :     =item message
636 :    
637 :     Message to include in the trace.
638 :    
639 :     =back
640 :    
641 :     =cut
642 :    
643 :     sub Confess {
644 :     # Get the parameters.
645 :     my ($message) = @_;
646 : parrello 1.97 # Set up the category and level.
647 :     $LastCategory = "(confess)";
648 :     $LastLevel = 0;
649 : parrello 1.93 if (! defined($FIG_Config::no_tool_hdr)) {
650 :     # Here we have a tool header. Display its length so that the user can adjust the line numbers.
651 :     my $toolHeaderFile = "$FIG_Config::fig_disk/dist/releases/current/$FIG_Config::arch/tool_hdr";
652 :     # Only proceed if the tool header file is actually present.
653 :     if (-f $toolHeaderFile) {
654 : parrello 1.97 my $fh;
655 :     if (open $fh, "<$toolHeaderFile") {
656 :     my @lines = <$fh>;
657 :     Trace("Tool header has " . scalar(@lines) . " lines.");
658 :     }
659 : parrello 1.93 }
660 :     }
661 :     # Trace the call stack.
662 :     Cluck($message);
663 :     # Abort the program.
664 :     croak(">>> $message");
665 :     }
666 :    
667 : parrello 1.106 =head3 SaveCGI
668 :    
669 :     Tracer::SaveCGI($cgi);
670 :    
671 :     This method saves the CGI object but does not activate emergency tracing.
672 :     It is used to allow L</Warn> to work in situations where emergency
673 :     tracing is contra-indicated (e.g. the wiki).
674 :    
675 :     =over 4
676 :    
677 :     =item cgi
678 :    
679 :     Active CGI query object.
680 :    
681 :     =back
682 :    
683 :     =cut
684 :    
685 :     sub SaveCGI {
686 :     $SavedCGI = $_[0];
687 :     }
688 :    
689 : parrello 1.99 =head3 Warn
690 :    
691 : parrello 1.106 Warn($message, @options);
692 : parrello 1.99
693 :     This method traces an important message. If an RSS feed is configured
694 :     (via I<FIG_Config::error_feed>) and the tracing destination is C<WARN>,
695 :     then the message will be echoed to the feed. In general, a tracing
696 :     destination of C<WARN> indicates that the caller is running as a web
697 :     service in a production environment; however, this is not a requirement.
698 :    
699 : parrello 1.103 To force warnings into the RSS feed even when the tracing destination
700 :     is not C<WARN>, simply specify the C<Feed> tracing module. This can be
701 :     configured automatically when L</StandardSetup> is used.
702 :    
703 : parrello 1.99 The L</Cluck> method calls this one for its final message. Since
704 :     L</Confess> calls L</Cluck>, this means that any error which is caught
705 :     and confessed will put something in the feed. This insures that someone
706 :     will be alerted relatively quickly when a failure occurs.
707 :    
708 :     =over 4
709 :    
710 :     =item message
711 :    
712 :     Message to be traced.
713 :    
714 : parrello 1.106 =item options
715 :    
716 :     A list containing zero or more options.
717 :    
718 :     =back
719 :    
720 :     The permissible options are as follows.
721 :    
722 :     =over 4
723 :    
724 :     =item noStack
725 :    
726 :     If specified, then the stack trace is not included in the output.
727 :    
728 : parrello 1.99 =back
729 :    
730 :     =cut
731 :    
732 :     sub Warn {
733 :     # Get the parameters.
734 : parrello 1.106 my $message = shift @_;
735 :     my %options = map { $_ => 1 } @_;
736 : parrello 1.107 # Save $@;
737 :     my $savedError = $@;
738 : parrello 1.99 # Trace the message.
739 :     Trace($message);
740 : parrello 1.106 # This will contain the lock handle. If it's defined, it means we need to unlock.
741 :     my $lock;
742 : parrello 1.103 # Check for feed forcing.
743 :     my $forceFeed = exists $Categories{feed};
744 : parrello 1.106 # An error here would be disastrous. Note that if debug mode is specified,
745 :     # we do this stuff even in a test environment.
746 : parrello 1.99 eval {
747 :     # Do we need to put this in the RSS feed?
748 : parrello 1.103 if ($FIG_Config::error_feed && ($Destination eq 'WARN' || $forceFeed)) {
749 : parrello 1.109 # Probably. We need to check first, however, to see if it's from an
750 :     # ignored IP. For non-CGI situations, we default the IP to the self-referent.
751 :     my $key = "127.0.0.1";
752 :     if (defined $SavedCGI) {
753 :     # Get the IP address.
754 :     $key = $ENV{HTTP_X_FORWARDED_FOR} || $ENV{REMOTE_ADDR};
755 : parrello 1.101 }
756 : parrello 1.109 # Is the IP address in the ignore list?
757 :     my $found = scalar(grep { $_ eq $key } @FIG_Config::error_ignore_ips);
758 :     if (! $found) {
759 :     # No. We're good. We now need to compute the date, the link, and the title.
760 :     # First, the date, in a very specific format.
761 :     my $date = strftime("%a, %02e %b %H:%M:%S %Y ", localtime) .
762 :     (tz_local_offset() / 30);
763 :     # Environment data goes in here. We start with the date.
764 :     my $environment = "$date. ";
765 :     # If we need to recap the message (because it's too long to be a title), we'll
766 :     # put it in here.
767 :     my $recap;
768 :     # Copy the message and remove excess space.
769 :     my $title = $message;
770 :     $title =~ s/\s+/ /gs;
771 :     # If it's too long, we have to split it up.
772 :     if (length $title > 60) {
773 :     # Put the full message in the environment string.
774 :     $recap = $title;
775 :     # Excerpt it as the title.
776 :     $title = substr($title, 0, 50) . "...";
777 :     }
778 :     # If we have a CGI object, then this is a web error. Otherwise, it's
779 :     # command-line.
780 :     if (defined $SavedCGI) {
781 :     # We're in a web service. The environment is the user's IP, and the link
782 :     # is the URL that got us here.
783 :     $environment .= "Event Reported at IP address $key process $$.";
784 :     my $url = $SavedCGI->self_url();
785 :     # We need the user agent string and (if available) the referrer.
786 :     # The referrer will be the link.
787 :     $environment .= " User Agent $ENV{HTTP_USER_AGENT}";
788 :     if ($ENV{HTTP_REFERER}) {
789 :     my $link = $ENV{HTTP_REFERER};
790 :     $environment .= " referred from <a href=\"$link\">$link</a>.";
791 :     } else {
792 :     $environment .= " referrer unknown.";
793 :     }
794 :     # Close off the sentence with the original link.
795 :     $environment .= " URL of event is <a href=\"$url\">$url</a>.";
796 :     } else {
797 :     # No CGI object, so we're a command-line tool. Use the tracing
798 :     # key and the PID as the user identifier, and add the command.
799 :     my $key = EmergencyKey();
800 :     $environment .= "Event Reported by $key process $$.";
801 :     if ($CommandLine) {
802 :     # We're in a StandardSetup script, so we have the real command line.
803 :     $environment .= "\n<pre>" . CGI::escapeHTML($CommandLine) . "</pre>\n";
804 :     } elsif ($ENV{_}) {
805 :     # We're in a BASH script, so the command has been stored in the _ variable.
806 :     $environment .= " Command = " . CGI::escapeHTML($ENV{_}) . "\n";
807 :     }
808 :     }
809 :     # Build a GUID. We use the current time, the title, and the process ID,
810 :     # then digest the result.
811 :     my $guid = Digest::MD5::md5_base64(gettimeofday(), $title, $$);
812 :     # Finally, the description. This is a stack trace plus various environmental stuff.
813 :     # The trace is optional.
814 :     my $stackTrace;
815 :     if ($options{noStack}) {
816 :     $stackTrace = "";
817 :     } else {
818 :     my @trace = LongMess();
819 :     # Only proceed if we got something back.
820 :     if (scalar(@trace) > 0) {
821 :     $trace[0] =~ s/Tracer::Warn.+?called/Event occurred/;
822 :     $stackTrace = "Stack trace:<pre>" . join("\n", @trace, "</pre>");
823 :     }
824 :     }
825 :     # We got the stack trace. Now it's time to put it all together.
826 :     # We have a goofy thing here in that we need to HTML-escape some sections of the description
827 :     # twice. They will be escaped once here, and then once when written by XML::Simple. They are
828 :     # unescaped once when processed by the RSS reader, and stuff in the description is treated as
829 :     # HTML. So, anything escaped here is treated as a literal when viewed in the RSS reader, but
830 :     # our <br>s and <pre>s are used to format the description.
831 :     $recap = (defined $recap ? "<em>" . CGI::escapeHTML($recap) . "</em><br /><br />" : "");
832 :     my $description = "$recap$environment $stackTrace";
833 :     # Okay, we have all the pieces. Create a hash of the new event.
834 :     my $newItem = { title => $title,
835 :     description => $description,
836 :     category => $LastCategory,
837 :     pubDate => $date,
838 :     guid => $guid,
839 :     };
840 :     # We need XML capability for this.
841 :     require XML::Simple;
842 :     # The RSS document goes in here.
843 :     my $rss;
844 :     # Get the name of the RSS file. It's in the FIG temporary directory.
845 :     my $fileName = "$FIG_Config::temp/$FIG_Config::error_feed";
846 :     # Open the config file and lock it.
847 :     $lock = Open(undef, "<$FIG_Config::fig_disk/config/FIG_Config.pm");
848 :     flock $lock, LOCK_EX;
849 :     # Does it exist?
850 :     if (-s $fileName) {
851 :     # Slurp it in.
852 :     $rss = XML::Simple::XMLin($fileName, ForceArray => ['item']);
853 : parrello 1.102 } else {
854 : parrello 1.109 my $size = -s $fileName;
855 :     # Create an empty channel.
856 :     $rss = {
857 :     channel => {
858 :     title => 'NMPDR Warning Feed',
859 :     link => "$FIG_Config::temp_url/$FIG_Config::error_feed",
860 :     description => "Important messages regarding the status of the NMPDR.",
861 :     generator => "NMPDR Trace Facility",
862 :     docs => "http://blogs.law.harvard.edu/tech/rss",
863 :     item => []
864 :     },
865 :     };
866 : parrello 1.100 }
867 : parrello 1.109 # Get the channel object.
868 :     my $channel = $rss->{channel};
869 :     # Update the last-build date.
870 :     $channel->{lastBuildDate} = $date;
871 :     # Get the item array.
872 :     my $items = $channel->{item};
873 :     # Insure it has only 100 entries.
874 :     while (scalar @{$items} > 100) {
875 :     pop @{$items};
876 : parrello 1.104 }
877 : parrello 1.109 # Add our new item at the front.
878 :     unshift @{$items}, $newItem;
879 :     # Create the XML. Note we do not include the root or the declaration. XML Simple can't handle
880 :     # the requirements for those.
881 :     my $xml = XML::Simple::XMLout($channel, NoAttr => 1, RootName => 'channel', XmlDecl => '');
882 :     # Here we put in the root and declaration. The problem is that the root has to have the version attribute
883 :     # in it. So, we suppress the root and do it by hand, and that requires suppressing the declaration, too.
884 :     $xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<rss version=\"2.0\">$xml\n</rss>";
885 :     # We don't use Open here because we can't afford an error.
886 :     if (open XMLOUT, ">$fileName") {
887 :     print XMLOUT $xml;
888 :     close XMLOUT;
889 : parrello 1.106 }
890 : parrello 1.101 }
891 : parrello 1.99 }
892 :     };
893 : parrello 1.103 if ($@) {
894 :     # If the feed failed, we need to know why. The error will be traced, but this method will not be involved
895 :     # (which is a good thing).
896 : parrello 1.102 my $error = $@;
897 : parrello 1.103 Trace("Feed Error: $error") if T(Feed => 0);
898 : parrello 1.102 }
899 : parrello 1.106 # Be sure to unlock.
900 :     if ($lock) {
901 :     flock $lock, LOCK_UN;
902 :     undef $lock;
903 :     }
904 : parrello 1.107 # Restore the error message.
905 :     $@ = $savedError;
906 : parrello 1.99 }
907 :    
908 : parrello 1.106
909 :    
910 :    
911 : parrello 1.93 =head3 Assert
912 :    
913 :     Assert($condition1, $condition2, ... $conditionN);
914 :    
915 :     Return TRUE if all the conditions are true. This method can be used in conjunction with
916 :     the OR operator and the L</Confess> method as a debugging assert.
917 :     So, for example
918 :    
919 :     Assert($recNum >= 0) || Confess("Invalid record number $recNum.");
920 :    
921 :     Will abort the program with a stack trace if the value of C<$recNum> is negative.
922 :    
923 :     =cut
924 :     sub Assert {
925 :     my $retVal = 1;
926 :     LOOP: for my $condition (@_) {
927 :     if (! $condition) {
928 :     $retVal = 0;
929 :     last LOOP;
930 :     }
931 :     }
932 :     return $retVal;
933 :     }
934 :    
935 :     =head3 Cluck
936 :    
937 :     Cluck($message);
938 :    
939 :     Trace the call stack. Note that for best results, you should qualify the call with a
940 :     trace condition. For example,
941 :    
942 :     Cluck("Starting record parse.") if T(3);
943 :    
944 :     will only trace the stack if the trace level for the package is 3 or more.
945 :    
946 :     =over 4
947 :    
948 :     =item message
949 :    
950 :     Message to include in the trace.
951 :    
952 :     =back
953 :    
954 :     =cut
955 :    
956 :     sub Cluck {
957 :     # Get the parameters.
958 :     my ($message) = @_;
959 :     # Trace what's happening.
960 :     Trace("Stack trace for event: $message");
961 : parrello 1.99 # Get the stack trace.
962 :     my @trace = LongMess();
963 :     # Convert the trace to a series of messages.
964 :     for my $line (@trace) {
965 :     # Replace the tab at the beginning with spaces.
966 :     $line =~ s/^\t/ /;
967 :     # Trace the line.
968 :     Trace($line);
969 :     }
970 :     # Issue a warning. This displays the event message and inserts it into the RSS error feed.
971 :     Warn($message);
972 :     }
973 :    
974 :     =head3 LongMess
975 :    
976 :     my @lines = Tracer::LongMess();
977 :    
978 :     Return a stack trace with all tracing methods removed. The return will be in the form of a list
979 :     of message strings.
980 :    
981 :     =cut
982 :    
983 :     sub LongMess {
984 :     # Declare the return variable.
985 :     my @retVal = ();
986 :     my $confession = longmess("");
987 : parrello 1.93 for my $line (split /\s*\n/, $confession) {
988 : parrello 1.99 unless ($line =~ /Tracer\.pm/) {
989 :     # Here we have a line worth keeping. Push it onto the result list.
990 :     push @retVal, $line;
991 : parrello 1.97 }
992 : parrello 1.93 }
993 : parrello 1.99 # Return the result.
994 :     return @retVal;
995 : parrello 1.93 }
996 :    
997 :     =head3 ETracing
998 :    
999 :     ETracing($parameter);
1000 :    
1001 :     Set up emergency tracing. Emergency tracing is tracing that is turned
1002 :     on automatically for any program that calls this method. The emergency
1003 :     tracing parameters are stored in a a file identified by a tracing key.
1004 :     If this method is called with a CGI object, then the tracing key is
1005 :     taken from a cookie. If it is called with no parameters, then the tracing
1006 :     key is taken from an environment variable. If it is called with a string,
1007 :     the tracing key is that string.
1008 :    
1009 :     =over 4
1010 :    
1011 :     =item parameter
1012 :    
1013 :     A parameter from which the tracing key is computed. If it is a scalar,
1014 :     that scalar is used as the tracing key. If it is a CGI object, the
1015 :     tracing key is taken from the C<IP> cookie. If it is omitted, the
1016 :     tracing key is taken from the C<TRACING> environment variable. If it
1017 :     is a CGI object and emergency tracing is not on, the C<Trace> and
1018 :     C<TF> parameters will be used to determine the type of tracing.
1019 :    
1020 :     =back
1021 :    
1022 :     =cut
1023 :    
1024 :     sub ETracing {
1025 :     # Get the parameter.
1026 :     my ($parameter) = @_;
1027 :     # Check for CGI mode.
1028 : parrello 1.99 if (defined $parameter && ref $parameter eq 'CGI') {
1029 :     $SavedCGI = $parameter;
1030 :     } else {
1031 :     $SavedCGI = undef;
1032 :     }
1033 : parrello 1.93 # Default to no tracing except errors.
1034 :     my ($tracing, $dest) = ("0", "WARN");
1035 :     # Check for emergency tracing.
1036 :     my $tkey = EmergencyKey($parameter);
1037 :     my $emergencyFile = EmergencyFileName($tkey);
1038 :     if (-e $emergencyFile) {
1039 :     # We have the file. Read in the data.
1040 :     my @tracing = GetFile($emergencyFile);
1041 :     # Pull off the time limit.
1042 :     my $expire = shift @tracing;
1043 :     # Convert it to seconds.
1044 :     $expire *= 3600;
1045 :     # Check the file data.
1046 :     my $stat = stat($emergencyFile);
1047 :     my ($now) = gettimeofday;
1048 :     if ($now - $stat->mtime > $expire) {
1049 :     # Delete the expired file.
1050 :     unlink $emergencyFile;
1051 : parrello 1.44 } else {
1052 : parrello 1.93 # Emergency tracing is on. Pull off the destination and
1053 :     # the trace level;
1054 :     $dest = shift @tracing;
1055 :     my $level = shift @tracing;
1056 :     # Convert the destination to a real tracing destination.
1057 :     # temp directory.
1058 :     $dest = EmergencyTracingDest($tkey, $dest);
1059 :     # Insure Tracer is specified.
1060 :     my %moduleHash = map { $_ => 1 } @tracing;
1061 :     $moduleHash{Tracer} = 1;
1062 :     # Set the trace parameter.
1063 :     $tracing = join(" ", $level, sort keys %moduleHash);
1064 : parrello 1.44 }
1065 : parrello 1.99 } elsif (defined $SavedCGI) {
1066 : parrello 1.93 # There's no emergency tracing, but we have a CGI object, so check
1067 :     # for tracing from the form parameters.
1068 : parrello 1.99 if ($SavedCGI->param('Trace')) {
1069 : parrello 1.93 # Here the user has requested tracing via a form.
1070 : parrello 1.99 $dest = ($SavedCGI->param('TF') ? ">$FIG_Config::temp/Trace$$.log" : "QUEUE");
1071 :     $tracing = $SavedCGI->param('Trace') . " Tracer";
1072 : parrello 1.36 }
1073 :     }
1074 : parrello 1.93 # Setup the tracing we've determined from all the stuff above.
1075 :     TSetup($tracing, $dest);
1076 : parrello 1.94 # Check to see if we're a web script.
1077 : parrello 1.99 if (defined $SavedCGI) {
1078 : parrello 1.94 # Yes we are. Trace the form and environment data.
1079 : parrello 1.99 TraceParms($SavedCGI);
1080 : parrello 1.94 # Check for RAW mode. In raw mode, we print a fake header so that we see everything
1081 :     # emitted by the script in its raw form.
1082 :     if (T(Raw => 3)) {
1083 :     print CGI::header(-type => 'text/plain', -tracing => 'Raw');
1084 :     }
1085 : parrello 1.83 }
1086 : parrello 1.31 }
1087 :    
1088 : parrello 1.93 =head3 EmergencyFileName
1089 :    
1090 :     my $fileName = Tracer::EmergencyFileName($tkey);
1091 :    
1092 :     Return the emergency tracing file name. This is the file that specifies
1093 :     the tracing information.
1094 :    
1095 :     =over 4
1096 :    
1097 :     =item tkey
1098 :    
1099 :     Tracing key for the current program.
1100 : parrello 1.11
1101 : parrello 1.93 =item RETURN
1102 : parrello 1.11
1103 : parrello 1.93 Returns the name of the file to contain the emergency tracing information.
1104 : parrello 1.11
1105 : parrello 1.93 =back
1106 : parrello 1.11
1107 :     =cut
1108 :    
1109 : parrello 1.93 sub EmergencyFileName {
1110 :     # Get the parameters.
1111 :     my ($tkey) = @_;
1112 :     # Compute the emergency tracing file name.
1113 :     return "$FIG_Config::temp/Emergency$tkey.txt";
1114 : olson 1.1 }
1115 :    
1116 : parrello 1.93 =head3 EmergencyFileTarget
1117 : parrello 1.10
1118 : parrello 1.93 my $fileName = Tracer::EmergencyFileTarget($tkey);
1119 : parrello 1.10
1120 : parrello 1.93 Return the emergency tracing target file name. This is the file that receives
1121 :     the tracing output for file-based tracing.
1122 : parrello 1.10
1123 : parrello 1.93 =over 4
1124 : parrello 1.10
1125 : parrello 1.93 =item tkey
1126 : parrello 1.10
1127 : parrello 1.93 Tracing key for the current program.
1128 : parrello 1.10
1129 : parrello 1.93 =item RETURN
1130 : parrello 1.10
1131 : parrello 1.93 Returns the name of the file to contain the trace output.
1132 : parrello 1.10
1133 : parrello 1.93 =back
1134 : parrello 1.10
1135 : parrello 1.93 =cut
1136 : parrello 1.10
1137 : parrello 1.93 sub EmergencyFileTarget {
1138 :     # Get the parameters.
1139 :     my ($tkey) = @_;
1140 :     # Compute the emergency tracing file name.
1141 :     return "$FIG_Config::temp/trace$tkey.log";
1142 :     }
1143 : parrello 1.10
1144 : parrello 1.93 =head3 EmergencyTracingDest
1145 : parrello 1.10
1146 : parrello 1.93 my $dest = Tracer::EmergencyTracingDest($tkey, $myDest);
1147 : parrello 1.10
1148 : parrello 1.93 This method converts an emergency tracing destination to a real
1149 :     tracing destination. The main difference is that if the
1150 :     destination is C<FILE> or C<APPEND>, we convert it to file
1151 :     output. If the destination is C<DUAL>, we convert it to file
1152 :     and standard output.
1153 : parrello 1.10
1154 :     =over 4
1155 :    
1156 : parrello 1.93 =item tkey
1157 : parrello 1.10
1158 : parrello 1.93 Tracing key for this environment.
1159 : parrello 1.10
1160 : parrello 1.93 =item myDest
1161 : parrello 1.10
1162 : parrello 1.93 Destination from the emergency tracing file.
1163 : parrello 1.10
1164 :     =item RETURN
1165 :    
1166 : parrello 1.93 Returns a destination that can be passed into L</TSetup>.
1167 : parrello 1.10
1168 :     =back
1169 :    
1170 :     =cut
1171 :    
1172 : parrello 1.93 sub EmergencyTracingDest {
1173 : parrello 1.12 # Get the parameters.
1174 : parrello 1.93 my ($tkey, $myDest) = @_;
1175 :     # Declare the return variable.
1176 :     my $retVal = $myDest;
1177 :     # Process according to the destination value.
1178 :     if ($myDest eq 'FILE') {
1179 :     $retVal = ">" . EmergencyFileTarget($tkey);
1180 :     } elsif ($myDest eq 'APPEND') {
1181 :     $retVal = ">>" . EmergencyFileTarget($tkey);
1182 :     } elsif ($myDest eq 'DUAL') {
1183 :     $retVal = "+>" . EmergencyFileTarget($tkey);
1184 : parrello 1.97 } elsif ($myDest eq 'WARN') {
1185 :     $retVal = "WARN";
1186 : parrello 1.12 }
1187 : parrello 1.93 # Return the result.
1188 :     return $retVal;
1189 : parrello 1.10 }
1190 :    
1191 : parrello 1.93 =head3 Emergency
1192 :    
1193 :     Emergency($key, $hours, $dest, $level, @modules);
1194 :    
1195 :     Turn on emergency tracing. This method is normally invoked over the web from
1196 :     a debugging console, but it can also be called by the C<trace.pl> script.
1197 :     The caller specifies the duration of the emergency in hours, the desired tracing
1198 :     destination, the trace level, and a list of the trace modules to activate.
1199 :     For the length of the duration, when a program in an environment with the
1200 :     specified tracing key active invokes a Sprout CGI script, tracing will be
1201 :     turned on automatically. See L</TSetup> for more about tracing setup and
1202 :     L</ETracing> for more about emergency tracing.
1203 :    
1204 :     =over 4
1205 : parrello 1.11
1206 : parrello 1.93 =item tkey
1207 : parrello 1.11
1208 : parrello 1.93 The tracing key. This is used to identify the control file and the trace file.
1209 : parrello 1.11
1210 : parrello 1.93 =item hours
1211 : parrello 1.11
1212 : parrello 1.93 Number of hours to keep emergency tracing alive.
1213 : parrello 1.11
1214 : parrello 1.93 =item dest
1215 : parrello 1.11
1216 : parrello 1.93 Tracing destination. If no path information is specified for a file
1217 :     destination, it is put in the FIG temporary directory.
1218 : parrello 1.11
1219 : parrello 1.93 =item level
1220 : parrello 1.11
1221 : parrello 1.93 Tracing level. A higher level means more trace messages.
1222 : parrello 1.11
1223 : parrello 1.93 =item modules
1224 : parrello 1.11
1225 : parrello 1.93 A list of the tracing modules to activate.
1226 : parrello 1.11
1227 :     =back
1228 :    
1229 :     =cut
1230 : parrello 1.93
1231 :     sub Emergency {
1232 : parrello 1.11 # Get the parameters.
1233 : parrello 1.93 my ($tkey, $hours, $dest, $level, @modules) = @_;
1234 :     # Create the emergency file.
1235 :     my $specFile = EmergencyFileName($tkey);
1236 :     my $outHandle = Open(undef, ">$specFile");
1237 :     print $outHandle join("\n", $hours, $dest, $level, @modules, "");
1238 : parrello 1.11 }
1239 :    
1240 : parrello 1.93 =head3 EmergencyKey
1241 :    
1242 :     my $tkey = EmergencyKey($parameter);
1243 :    
1244 :     Return the Key to be used for emergency tracing. This could be an IP address,
1245 :     a session ID, or a user name, depending on the environment.
1246 : parrello 1.11
1247 : parrello 1.93 =over 4
1248 : parrello 1.11
1249 : parrello 1.93 =item parameter
1250 : parrello 1.11
1251 : parrello 1.93 Parameter defining the method for finding the tracing key. If it is a scalar,
1252 :     then it is presumed to be the tracing key itself. If it is a CGI object, then
1253 :     the tracing key is taken from the C<IP> cookie. Otherwise, the tracing key is
1254 :     taken from the C<TRACING> environment variable.
1255 : parrello 1.29
1256 : parrello 1.93 =item RETURN
1257 : parrello 1.11
1258 : parrello 1.93 Returns the key to be used for labels in emergency tracing.
1259 : parrello 1.11
1260 : parrello 1.93 =back
1261 : parrello 1.11
1262 : parrello 1.93 =cut
1263 : parrello 1.29
1264 : parrello 1.93 sub EmergencyKey {
1265 :     # Get the parameters.
1266 :     my ($parameter) = @_;
1267 :     # Declare the return variable.
1268 :     my $retVal;
1269 :     # Determine the parameter type.
1270 :     if (! defined $parameter) {
1271 : parrello 1.99 # Here we're supposed to check the environment. If that fails, we
1272 :     # get the effective login ID.
1273 :     $retVal = $ENV{TRACING} || scalar getpwuid($<);
1274 : parrello 1.93 } else {
1275 :     my $ptype = ref $parameter;
1276 :     if ($ptype eq 'CGI') {
1277 :     # Here we were invoked from a web page. Look for a cookie.
1278 :     $retVal = $parameter->cookie('IP');
1279 :     } elsif (! $ptype) {
1280 :     # Here the key was passed in.
1281 :     $retVal = $parameter;
1282 :     }
1283 :     }
1284 :     # If no luck finding a key, use the PID.
1285 :     if (! defined $retVal) {
1286 :     $retVal = $$;
1287 :     }
1288 :     # Return the result.
1289 :     return $retVal;
1290 :     }
1291 : parrello 1.11
1292 :    
1293 : parrello 1.93 =head3 TraceParms
1294 : parrello 1.11
1295 : parrello 1.93 Tracer::TraceParms($cgi);
1296 : parrello 1.11
1297 : parrello 1.93 Trace the CGI parameters at trace level CGI => 3 and the environment variables
1298 : parrello 1.94 at level CGI => 4. A self-referencing URL is traced at level CGI => 2.
1299 : parrello 1.11
1300 : parrello 1.93 =over 4
1301 : parrello 1.11
1302 : parrello 1.93 =item cgi
1303 : parrello 1.31
1304 : parrello 1.93 CGI query object containing the parameters to trace.
1305 : parrello 1.31
1306 : parrello 1.11 =back
1307 :    
1308 :     =cut
1309 : parrello 1.93
1310 :     sub TraceParms {
1311 : parrello 1.11 # Get the parameters.
1312 : parrello 1.93 my ($cgi) = @_;
1313 : parrello 1.94 if (T(CGI => 2)) {
1314 :     # Here we trace the GET-style URL for the script.
1315 : parrello 1.97 Trace("[URL] " . $cgi->url(-relative => 1, -query => 1));
1316 : parrello 1.94 }
1317 : parrello 1.93 if (T(CGI => 3)) {
1318 :     # Here we want to trace the parameter data.
1319 :     my @names = $cgi->param;
1320 :     for my $parmName (sort @names) {
1321 :     # Note we skip the Trace parameters, which are for our use only.
1322 :     if ($parmName ne 'Trace' && $parmName ne 'TF') {
1323 :     my @values = $cgi->param($parmName);
1324 : parrello 1.97 Trace("[CGI] $parmName = " . join(", ", @values));
1325 : parrello 1.93 }
1326 :     }
1327 :     # Display the request method.
1328 :     my $method = $cgi->request_method();
1329 :     Trace("Method: $method");
1330 :     }
1331 :     if (T(CGI => 4)) {
1332 :     # Here we want the environment data too.
1333 :     for my $envName (sort keys %ENV) {
1334 : parrello 1.97 Trace("[ENV] $envName = $ENV{$envName}");
1335 : parrello 1.12 }
1336 :     }
1337 : parrello 1.11 }
1338 :    
1339 : parrello 1.94 =head3 TraceImages
1340 :    
1341 :     Tracer::TraceImages($htmlString);
1342 :    
1343 :     Trace information about all of an html document's images. The tracing
1344 :     will be for type "IMG" at level 3. The image's source string
1345 :     will be displayed. This is generally either the URL of the image or
1346 :     raw data for the image itself. If the source is too long, only the first 300
1347 :     characters will be shown at trace level 3. The entire source will be shown,
1348 :     however, at trace level 4. This method is not very smart, and might catch
1349 :     Javascript code, but it is still useful when debugging the arcane
1350 :     behavior of images in multiple browser environments.
1351 :    
1352 :     =over 4
1353 :    
1354 :     =item htmlString
1355 :    
1356 :     HTML text for an outgoing web page.
1357 :    
1358 :     =back
1359 :    
1360 :     =cut
1361 :    
1362 :     sub TraceImages {
1363 :     # Only proceed if we're at the proper trace level.
1364 :     if (T(IMG => 3)) {
1365 :     # For performance reasons we're manipulating $_[0] instead of retrieving the string
1366 :     # into a variable called "$htmlString". This is because we expect html strings to be
1367 :     # long, and don't want to copy them any more than we have to.
1368 :     Trace(length($_[0]) . " characters in web page.");
1369 :     # Loop through the HTML, culling image tags.
1370 :     while ($_[0] =~ /<img\s+[^>]+?src="([^"]+)"/sgi) {
1371 :     # Extract the source string and determine whether or not it's too long.
1372 :     my $srcString = $1;
1373 :     my $pos = pos($_[0]) - length($srcString);
1374 :     my $excess = length($srcString) - 300;
1375 :     # We'll put the display string in here.
1376 :     my $srcDisplay = $srcString;
1377 :     # If it's a data string, split it at the comma.
1378 :     $srcDisplay =~ s/^(data[^,]+,)/$1\n/;
1379 :     # If there's no excess or we're at trace level 4, we're done. At level 3 with
1380 :     # a long string, however, we only show the first 300 characters.
1381 :     if ($excess > 0 && ! T(IMG => 4)) {
1382 :     $srcDisplay = substr($srcDisplay,0,300) . "\nplus $excess characters.";
1383 :     }
1384 :     # Output the trace message.
1385 :     Trace("Image tag at position $pos:\n$srcDisplay");
1386 :     }
1387 :     }
1388 :     }
1389 :    
1390 : parrello 1.93 =head2 Command-Line Utility Methods
1391 : olson 1.1
1392 : parrello 1.93 =head3 SendSMS
1393 : olson 1.1
1394 : parrello 1.93 my $msgID = Tracer::SendSMS($phoneNumber, $msg);
1395 : olson 1.1
1396 : parrello 1.93 Send a text message to a phone number using Clickatell. The FIG_Config file must contain the
1397 :     user name, password, and API ID for the relevant account in the hash reference variable
1398 :     I<$FIG_Config::phone>, using the keys C<user>, C<password>, and C<api_id>. For
1399 :     example, if the user name is C<BruceTheHumanPet>, the password is C<silly>, and the API ID
1400 :     is C<2561022>, then the FIG_Config file must contain
1401 : olson 1.1
1402 : parrello 1.93 $phone = { user => 'BruceTheHumanPet',
1403 :     password => 'silly',
1404 :     api_id => '2561022' };
1405 : olson 1.1
1406 : parrello 1.93 The original purpose of this method was to insure Bruce would be notified immediately when the
1407 :     Sprout Load terminates. Care should be taken if you do not wish Bruce to be notified immediately
1408 :     when you call this method.
1409 : olson 1.1
1410 : parrello 1.93 The message ID will be returned if successful, and C<undef> if an error occurs.
1411 : parrello 1.74
1412 : parrello 1.93 =over 4
1413 : parrello 1.74
1414 : parrello 1.93 =item phoneNumber
1415 : parrello 1.74
1416 : parrello 1.93 Phone number to receive the message, in international format. A United States phone number
1417 :     would be prefixed by "1". A British phone number would be prefixed by "44".
1418 : parrello 1.74
1419 : parrello 1.93 =item msg
1420 : parrello 1.74
1421 : parrello 1.93 Message to send to the specified phone.
1422 : parrello 1.74
1423 :     =item RETURN
1424 :    
1425 : parrello 1.93 Returns the message ID if successful, and C<undef> if the message could not be sent.
1426 : parrello 1.74
1427 : parrello 1.78 =back
1428 :    
1429 : parrello 1.74 =cut
1430 :    
1431 : parrello 1.93 sub SendSMS {
1432 : parrello 1.74 # Get the parameters.
1433 : parrello 1.93 my ($phoneNumber, $msg) = @_;
1434 :     # Declare the return variable. If we do not change it, C<undef> will be returned.
1435 : parrello 1.74 my $retVal;
1436 : parrello 1.93 # Only proceed if we have phone support.
1437 :     if (! defined $FIG_Config::phone) {
1438 :     Trace("Phone support not present in FIG_Config.") if T(1);
1439 :     } else {
1440 :     # Get the phone data.
1441 :     my $parms = $FIG_Config::phone;
1442 :     # Get the Clickatell URL.
1443 :     my $url = "http://api.clickatell.com/http/";
1444 :     # Create the user agent.
1445 :     my $ua = LWP::UserAgent->new;
1446 :     # Request a Clickatell session.
1447 :     my $resp = $ua->post("$url/sendmsg", { user => $parms->{user},
1448 :     password => $parms->{password},
1449 :     api_id => $parms->{api_id},
1450 :     to => $phoneNumber,
1451 :     text => $msg});
1452 :     # Check for an error.
1453 :     if (! $resp->is_success) {
1454 :     Trace("Alert failed.") if T(1);
1455 :     } else {
1456 :     # Get the message ID.
1457 :     my $rstring = $resp->content;
1458 :     if ($rstring =~ /^ID:\s+(.*)$/) {
1459 :     $retVal = $1;
1460 :     } else {
1461 :     Trace("Phone attempt failed with $rstring") if T(1);
1462 :     }
1463 :     }
1464 : parrello 1.74 }
1465 :     # Return the result.
1466 :     return $retVal;
1467 :     }
1468 :    
1469 : parrello 1.93 =head3 StandardSetup
1470 : olson 1.1
1471 : parrello 1.93 my ($options, @parameters) = StandardSetup(\@categories, \%options, $parmHelp, @ARGV);
1472 : olson 1.1
1473 : parrello 1.93 This method performs standard command-line parsing and tracing setup. The return
1474 :     values are a hash of the command-line options and a list of the positional
1475 :     parameters. Tracing is automatically set up and the command-line options are
1476 :     validated.
1477 : olson 1.1
1478 : parrello 1.93 This is a complex method that does a lot of grunt work. The parameters can
1479 :     be more easily understood, however, once they are examined individually.
1480 : olson 1.1
1481 : parrello 1.93 The I<categories> parameter is the most obtuse. It is a reference to a list of
1482 :     special-purpose tracing categories. Most tracing categories are PERL package
1483 :     names. So, for example, if you wanted to turn on tracing inside the B<Sprout>,
1484 :     B<ERDB>, and B<SproutLoad> packages, you would specify the categories
1485 : olson 1.1
1486 : parrello 1.93 ["Sprout", "SproutLoad", "ERDB"]
1487 : olson 1.1
1488 : parrello 1.93 This would cause trace messages in the specified three packages to appear in
1489 :     the output. There are two special tracing categories that are automatically
1490 :     handled by this method. In other words, if you used L</TSetup> you would need
1491 :     to include these categories manually, but if you use this method they are turned
1492 :     on automatically.
1493 : parrello 1.5
1494 :     =over 4
1495 :    
1496 : parrello 1.93 =item SQL
1497 : parrello 1.5
1498 : parrello 1.93 Traces SQL commands and activity.
1499 : parrello 1.5
1500 : parrello 1.93 =item Tracer
1501 : parrello 1.5
1502 : parrello 1.93 Traces error messages and call stacks.
1503 : parrello 1.5
1504 :     =back
1505 :    
1506 : parrello 1.93 C<SQL> is only turned on if the C<-sql> option is specified in the command line.
1507 :     The trace level is specified using the C<-trace> command-line option. For example,
1508 :     the following command line for C<TransactFeatures> turns on SQL tracing and runs
1509 :     all tracing at level 3.
1510 : parrello 1.5
1511 : parrello 1.93 TransactFeatures -trace=3 -sql register ../xacts IDs.tbl
1512 : parrello 1.5
1513 : parrello 1.93 Standard tracing is output to the standard output and echoed to the file
1514 :     C<trace>I<$$>C<.log> in the FIG temporary directory, where I<$$> is the
1515 :     process ID. You can also specify the C<user> parameter to put a user ID
1516 :     instead of a process ID in the trace file name. So, for example
1517 : olson 1.1
1518 : parrello 1.93 The default trace level is 2. To get all messages, specify a trace level of 4.
1519 :     For a genome-by-genome update, use 3.
1520 : olson 1.1
1521 : parrello 1.93 TransactFeatures -trace=3 -sql -user=Bruce register ../xacts IDs.tbl
1522 : olson 1.1
1523 : parrello 1.93 would send the trace output to C<traceBruce.log> in the temporary directory.
1524 : olson 1.1
1525 : parrello 1.93 The I<options> parameter is a reference to a hash containing the command-line
1526 :     options, their default values, and an explanation of what they mean. Command-line
1527 :     options may be in the form of switches or keywords. In the case of a switch, the
1528 :     option value is 1 if it is specified and 0 if it is not specified. In the case
1529 :     of a keyword, the value is separated from the option name by an equal sign. You
1530 :     can see this last in the command-line example above.
1531 : olson 1.1
1532 : parrello 1.93 You can specify a different default trace level by setting C<$options->{trace}>
1533 :     prior to calling this method.
1534 : olson 1.1
1535 : parrello 1.93 An example at this point would help. Consider, for example, the command-line utility
1536 :     C<TransactFeatures>. It accepts a list of positional parameters plus the options
1537 :     C<safe>, C<noAlias>, C<start>, and C<tblFiles>. To start up this command, we execute
1538 :     the following code.
1539 : olson 1.1
1540 : parrello 1.93 my ($options, @parameters) = Tracer::StandardSetup(["DocUtils"],
1541 :     { safe => [0, "use database transactions"],
1542 :     noAlias => [0, "do not expect aliases in CHANGE transactions"],
1543 :     start => [' ', "start with this genome"],
1544 :     tblFiles => [0, "output TBL files containing the corrected IDs"] },
1545 :     "<command> <transactionDirectory> <IDfile>",
1546 :     @ARGV);
1547 : olson 1.1
1548 :    
1549 : parrello 1.93 The call to C<ParseCommand> specifies the default values for the options and
1550 :     stores the actual options in a hash that is returned as C<$options>. The
1551 :     positional parameters are returned in C<@parameters>.
1552 : olson 1.1
1553 : parrello 1.93 The following is a sample command line for C<TransactFeatures>.
1554 : olson 1.1
1555 : parrello 1.93 TransactFeatures -trace=2 -noAlias register ../xacts IDs.tbl
1556 : olson 1.1
1557 : parrello 1.93 Single and double hyphens are equivalent. So, you could also code the
1558 :     above command as
1559 : olson 1.1
1560 : parrello 1.93 TransactFeatures --trace=2 --noAlias register ../xacts IDs.tbl
1561 : olson 1.1
1562 : parrello 1.93 In this case, C<register>, C<../xacts>, and C<IDs.tbl> are the positional
1563 :     parameters, and would find themselves in I<@parameters> after executing the
1564 :     above code fragment. The tracing would be set to level 2, and the categories
1565 :     would be C<Tracer>, and <DocUtils>. C<Tracer> is standard,
1566 :     and C<DocUtils> was included because it came in within the first parameter
1567 :     to this method. The I<$options> hash would be
1568 : olson 1.1
1569 : parrello 1.93 { trace => 2, sql => 0, safe => 0,
1570 :     noAlias => 1, start => ' ', tblFiles => 0 }
1571 : olson 1.1
1572 : parrello 1.93 Use of C<StandardSetup> in this way provides a simple way of performing
1573 :     standard tracing setup and command-line parsing. Note that the caller is
1574 :     not even aware of the command-line switches C<-trace> and C<-sql>, which
1575 :     are used by this method to control the tracing. If additional tracing features
1576 :     need to be added in the future, they can be processed by this method without
1577 :     upsetting the command-line utilities.
1578 : olson 1.1
1579 : parrello 1.93 If the C<background> option is specified on the command line, then the
1580 :     standard and error outputs will be directed to files in the temporary
1581 :     directory, using the same suffix as the trace file. So, if the command
1582 :     line specified
1583 : olson 1.1
1584 : parrello 1.93 -user=Bruce -background
1585 : olson 1.1
1586 : parrello 1.93 then the trace output would go to C<traceBruce.log>, the standard output to
1587 :     C<outBruce.log>, and the error output to C<errBruce.log>. This is designed to
1588 :     simplify starting a command in the background.
1589 : olson 1.1
1590 : parrello 1.93 The user name is also used as the tracing key for L</Emergency Tracing>.
1591 :     Specifying a value of C<E> for the trace level causes emergency tracing to
1592 :     be used instead of custom tracing. If the user name is not specified,
1593 :     the tracing key is taken from the C<Tracing> environment variable. If there
1594 : parrello 1.103 is no value for that variable, the tracing key will be computed from the active
1595 :     login ID.
1596 :    
1597 :     Since the default situation in StandardSetup is to trace to the standard
1598 :     output, errors that occur in command-line scripts will not generate
1599 :     RSS events. To force the events, use the C<warn> option.
1600 :    
1601 :     TransactFeatures -background -warn register ../xacts IDs.tbl
1602 : olson 1.1
1603 : parrello 1.93 Finally, if the special option C<-help> is specified, the option
1604 :     names will be traced at level 0 and the program will exit without processing.
1605 :     This provides a limited help capability. For example, if the user enters
1606 : olson 1.1
1607 : parrello 1.93 TransactFeatures -help
1608 : olson 1.1
1609 : parrello 1.93 he would see the following output.
1610 : olson 1.1
1611 : parrello 1.93 TransactFeatures [options] <command> <transactionDirectory> <IDfile>
1612 :     -trace tracing level (default E)
1613 :     -sql trace SQL commands
1614 :     -safe use database transactions
1615 :     -noAlias do not expect aliases in CHANGE transactions
1616 :     -start start with this genome
1617 :     -tblFiles output TBL files containing the corrected IDs
1618 : parrello 1.111 -forked do not erase the trace file before tracing
1619 : olson 1.1
1620 : parrello 1.93 The caller has the option of modifying the tracing scheme by placing a value
1621 :     for C<trace> in the incoming options hash. The default value can be overridden,
1622 :     or the tracing to the standard output can be turned off by suffixing a minus
1623 :     sign to the trace level. So, for example,
1624 : olson 1.1
1625 : parrello 1.93 { trace => [0, "tracing level (default 0)"],
1626 :     ...
1627 : olson 1.1
1628 : parrello 1.93 would set the default trace level to 0 instead of E, while
1629 : olson 1.1
1630 : parrello 1.93 { trace => ["2-", "tracing level (default 2)"],
1631 :     ...
1632 : olson 1.1
1633 : parrello 1.93 would set the default to 2, but trace only to the log file, not to the
1634 :     standard output.
1635 : olson 1.1
1636 : parrello 1.93 The parameters to this method are as follows.
1637 : olson 1.1
1638 : parrello 1.93 =over 4
1639 : olson 1.1
1640 : parrello 1.93 =item categories
1641 : parrello 1.2
1642 : parrello 1.93 Reference to a list of tracing category names. These should be names of
1643 :     packages whose internal workings will need to be debugged to get the
1644 :     command working.
1645 : olson 1.1
1646 : parrello 1.93 =item options
1647 : olson 1.1
1648 : parrello 1.93 Reference to a hash containing the legal options for the current command mapped
1649 :     to their default values and descriptions. The user can override the defaults
1650 :     by specifying the options as command-line switches prefixed by a hyphen.
1651 :     Tracing-related options may be added to this hash. If the C<-h> option is
1652 :     specified on the command line, the option descriptions will be used to
1653 :     explain the options. To turn off tracing to the standard output, add a
1654 :     minus sign to the value for C<trace> (see above).
1655 : olson 1.1
1656 : parrello 1.93 =item parmHelp
1657 : olson 1.1
1658 : parrello 1.93 A string that vaguely describes the positional parameters. This is used
1659 :     if the user specifies the C<-h> option.
1660 : olson 1.1
1661 : parrello 1.93 =item argv
1662 : olson 1.1
1663 : parrello 1.93 List of command line parameters, including the option switches, which must
1664 :     precede the positional parameters and be prefixed by a hyphen.
1665 : olson 1.1
1666 :     =item RETURN
1667 :    
1668 : parrello 1.93 Returns a list. The first element of the list is the reference to a hash that
1669 :     maps the command-line option switches to their values. These will either be the
1670 :     default values or overrides specified on the command line. The remaining
1671 :     elements of the list are the position parameters, in order.
1672 : olson 1.1
1673 :     =back
1674 :    
1675 :     =cut
1676 :    
1677 : parrello 1.93 sub StandardSetup {
1678 :     # Get the parameters.
1679 :     my ($categories, $options, $parmHelp, @argv) = @_;
1680 :     # Get the default tracing key.
1681 :     my $tkey = EmergencyKey();
1682 : parrello 1.104 # Save the command line.
1683 :     $CommandLine = join(" ", $0, map { $_ =~ /\s/ ? "\"$_\"" : $_ } @argv);
1684 : parrello 1.93 # Add the tracing options.
1685 :     if (! exists $options->{trace}) {
1686 :     $options->{trace} = ['2', "tracing level (E for emergency tracing)"];
1687 :     }
1688 : parrello 1.112 if (! exists $options->{forked}) {
1689 :     $options->{forked} = [0, "keep old trace file"];
1690 :     }
1691 : parrello 1.93 $options->{sql} = [0, "turn on SQL tracing"];
1692 :     $options->{help} = [0, "display command-line options"];
1693 :     $options->{user} = [$tkey, "tracing key"];
1694 :     $options->{background} = [0, "spool standard and error output"];
1695 : parrello 1.103 $options->{warn} = [0, "send errors to RSS feed"];
1696 : parrello 1.93 # Create a parsing hash from the options hash. The parsing hash
1697 :     # contains the default values rather than the default value
1698 :     # and the description. While we're at it, we'll memorize the
1699 :     # length of the longest option name.
1700 :     my $longestName = 0;
1701 :     my %parseOptions = ();
1702 :     for my $key (keys %{$options}) {
1703 :     if (length $key > $longestName) {
1704 :     $longestName = length $key;
1705 :     }
1706 :     $parseOptions{$key} = $options->{$key}->[0];
1707 :     }
1708 :     # Parse the command line.
1709 :     my ($retOptions, @retParameters) = ParseCommand(\%parseOptions, @argv);
1710 :     # Get the logfile suffix.
1711 :     my $suffix = $retOptions->{user};
1712 :     # Check for background mode.
1713 :     if ($retOptions->{background}) {
1714 : parrello 1.111 my $outFileName = "$FIG_Config::temp/out$suffix$$.log";
1715 :     my $errFileName = "$FIG_Config::temp/err$suffix$$.log";
1716 : parrello 1.93 open STDOUT, ">$outFileName";
1717 :     open STDERR, ">$errFileName";
1718 :     # Check for phone support. If we have phone support and a phone number,
1719 :     # we want to turn it on.
1720 :     if ($ENV{PHONE} && defined($FIG_Config::phone)) {
1721 :     $retOptions->{phone} = $ENV{PHONE};
1722 :     }
1723 :     }
1724 :     # Now we want to set up tracing. First, we need to know if the user
1725 :     # wants emergency tracing.
1726 :     if ($retOptions->{trace} eq 'E') {
1727 :     ETracing($retOptions->{user});
1728 :     } else {
1729 :     # Here the tracing is controlled from the command line.
1730 :     my @cats = @{$categories};
1731 :     if ($retOptions->{sql}) {
1732 :     push @cats, "SQL";
1733 :     }
1734 : parrello 1.103 if ($retOptions->{warn}) {
1735 :     push @cats, "Feed";
1736 :     }
1737 : parrello 1.93 # Add the default categories.
1738 :     push @cats, "Tracer";
1739 :     # Next, we create the category string by joining the categories.
1740 :     my $cats = join(" ", @cats);
1741 :     # Check to determine whether or not the caller wants to turn off tracing
1742 :     # to the standard output.
1743 :     my $traceLevel = $retOptions->{trace};
1744 :     my $textOKFlag = 1;
1745 :     if ($traceLevel =~ /^(.)-/) {
1746 :     $traceLevel = $1;
1747 :     $textOKFlag = 0;
1748 :     }
1749 :     # Now we set up the trace mode.
1750 :     my $traceMode;
1751 :     # Verify that we can open a file in the FIG temporary directory.
1752 :     my $traceFileName = "$FIG_Config::temp/trace$suffix.log";
1753 : parrello 1.111 my $traceFileSpec = ($retOptions->{forked} ? ">>$traceFileName" : ">$traceFileName");
1754 :     if (open TESTTRACE, "$traceFileSpec") {
1755 : parrello 1.93 # Here we can trace to a file.
1756 : parrello 1.111 $traceMode = ">>$traceFileName";
1757 : parrello 1.93 if ($textOKFlag) {
1758 :     # Echo to standard output if the text-OK flag is set.
1759 :     $traceMode = "+$traceMode";
1760 :     }
1761 :     # Close the test file.
1762 :     close TESTTRACE;
1763 :     } else {
1764 : parrello 1.98 # Here we can't trace to a file. Complain about this.
1765 :     warn "Could not open trace file $traceFileName: $!\n";
1766 :     # We trace to the standard output if it's
1767 :     # okay, and the error log otherwise.
1768 : parrello 1.93 if ($textOKFlag) {
1769 :     $traceMode = "TEXT";
1770 : parrello 1.12 } else {
1771 : parrello 1.93 $traceMode = "WARN";
1772 : parrello 1.12 }
1773 :     }
1774 : parrello 1.93 # Now set up the tracing.
1775 :     TSetup("$traceLevel $cats", $traceMode);
1776 :     }
1777 :     # Check for the "help" option. If it is specified, dump the command-line
1778 :     # options and exit the program.
1779 :     if ($retOptions->{help}) {
1780 :     $0 =~ m#[/\\](\w+)(\.pl)?$#i;
1781 :     print "$1 [options] $parmHelp\n";
1782 :     for my $key (sort keys %{$options}) {
1783 :     my $name = Pad($key, $longestName, 0, ' ');
1784 :     my $desc = $options->{$key}->[1];
1785 :     if ($options->{$key}->[0]) {
1786 :     $desc .= " (default " . $options->{$key}->[0] . ")";
1787 :     }
1788 :     print " $name $desc\n";
1789 : parrello 1.36 }
1790 : parrello 1.93 exit(0);
1791 :     }
1792 :     # Trace the options, if applicable.
1793 :     if (T(3)) {
1794 :     my @parms = grep { $retOptions->{$_} } keys %{$retOptions};
1795 :     Trace("Selected options: " . join(", ", sort @parms) . ".");
1796 : parrello 1.3 }
1797 : parrello 1.93 # Return the parsed parameters.
1798 :     return ($retOptions, @retParameters);
1799 : olson 1.1 }
1800 :    
1801 : parrello 1.93 =head3 ReadOptions
1802 : olson 1.1
1803 : parrello 1.93 my %options = Tracer::ReadOptions($fileName);
1804 : olson 1.1
1805 : parrello 1.93 Read a set of options from a file. Each option is encoded in a line of text that has the
1806 :     format
1807 : olson 1.1
1808 : parrello 1.93 I<optionName>C<=>I<optionValue>C<; >I<comment>
1809 : olson 1.1
1810 : parrello 1.93 The option name must consist entirely of letters, digits, and the punctuation characters
1811 :     C<.> and C<_>, and is case sensitive. Blank lines and lines in which the first nonblank
1812 :     character is a semi-colon will be ignored. The return hash will map each option name to
1813 :     the corresponding option value.
1814 : olson 1.1
1815 :     =over 4
1816 :    
1817 : parrello 1.93 =item fileName
1818 : olson 1.1
1819 : parrello 1.93 Name of the file containing the option data.
1820 : olson 1.1
1821 :     =item RETURN
1822 :    
1823 : parrello 1.93 Returns a hash mapping the option names specified in the file to their corresponding option
1824 :     value.
1825 : olson 1.1
1826 :     =back
1827 :    
1828 :     =cut
1829 :    
1830 : parrello 1.93 sub ReadOptions {
1831 : parrello 1.12 # Get the parameters.
1832 : parrello 1.93 my ($fileName) = @_;
1833 :     # Open the file.
1834 :     (open CONFIGFILE, "<$fileName") || Confess("Could not open option file $fileName.");
1835 :     # Count the number of records read.
1836 :     my ($records, $comments) = 0;
1837 :     # Create the return hash.
1838 :     my %retVal = ();
1839 :     # Loop through the file, accumulating key-value pairs.
1840 :     while (my $line = <CONFIGFILE>) {
1841 :     # Denote we've read a line.
1842 :     $records++;
1843 :     # Determine the line type.
1844 :     if ($line =~ /^\s*[\n\r]/) {
1845 :     # A blank line is a comment.
1846 :     $comments++;
1847 :     } elsif ($line =~ /^\s*([A-Za-z0-9_\.]+)=([^;]*);/) {
1848 :     # Here we have an option assignment.
1849 :     retVal{$1} = $2;
1850 :     } elsif ($line =~ /^\s*;/) {
1851 :     # Here we have a text comment.
1852 :     $comments++;
1853 : parrello 1.12 } else {
1854 : parrello 1.93 # Here we have an invalid line.
1855 :     Trace("Invalid option statement in record $records.") if T(0);
1856 : parrello 1.12 }
1857 :     }
1858 : parrello 1.93 # Return the hash created.
1859 :     return %retVal;
1860 : olson 1.1 }
1861 :    
1862 : parrello 1.93 =head3 GetOptions
1863 : parrello 1.9
1864 : parrello 1.93 Tracer::GetOptions(\%defaults, \%options);
1865 : parrello 1.9
1866 : parrello 1.93 Merge a specified set of options into a table of defaults. This method takes two hash references
1867 :     as input and uses the data from the second to update the first. If the second does not exist,
1868 :     there will be no effect. An error will be thrown if one of the entries in the second hash does not
1869 :     exist in the first.
1870 : parrello 1.9
1871 : parrello 1.93 Consider the following example.
1872 : parrello 1.9
1873 : parrello 1.93 my $optionTable = GetOptions({ dbType => 'mySQL', trace => 0 }, $options);
1874 : parrello 1.9
1875 : parrello 1.93 In this example, the variable B<$options> is expected to contain at most two options-- B<dbType> and
1876 :     B<trace>. The default database type is C<mySQL> and the default trace level is C<0>. If the value of
1877 :     B<$options> is C<< {dbType => 'Oracle'} >>, then the database type will be changed to C<Oracle> and
1878 :     the trace level will remain at 0. If B<$options> is undefined, then the database type and trace level
1879 :     will remain C<mySQL> and C<0>. If, on the other hand, B<$options> is defined as
1880 : parrello 1.9
1881 : parrello 1.93 {databaseType => 'Oracle'}
1882 : parrello 1.9
1883 : parrello 1.93 an error will occur because the B<databaseType> option does not exist.
1884 : parrello 1.9
1885 : parrello 1.93 =over 4
1886 : parrello 1.9
1887 : parrello 1.93 =item defaults
1888 : parrello 1.9
1889 : parrello 1.93 Table of default option values.
1890 : parrello 1.9
1891 : parrello 1.93 =item options
1892 : olson 1.1
1893 : parrello 1.93 Table of overrides, if any.
1894 : olson 1.1
1895 :     =item RETURN
1896 :    
1897 : parrello 1.93 Returns a reference to the default table passed in as the first parameter.
1898 : olson 1.1
1899 :     =back
1900 :    
1901 :     =cut
1902 :    
1903 : parrello 1.93 sub GetOptions {
1904 :     # Get the parameters.
1905 :     my ($defaults, $options) = @_;
1906 :     # Check for overrides.
1907 :     if ($options) {
1908 :     # Loop through the overrides.
1909 :     while (my ($option, $setting) = each %{$options}) {
1910 :     # Insure this override exists.
1911 :     if (!exists $defaults->{$option}) {
1912 :     croak "Unrecognized option $option encountered.";
1913 : parrello 1.12 } else {
1914 : parrello 1.93 # Apply the override.
1915 :     $defaults->{$option} = $setting;
1916 : parrello 1.12 }
1917 :     }
1918 :     }
1919 : parrello 1.93 # Return the merged table.
1920 :     return $defaults;
1921 : olson 1.1 }
1922 :    
1923 : parrello 1.93 =head3 MergeOptions
1924 : olson 1.1
1925 : parrello 1.93 Tracer::MergeOptions(\%table, \%defaults);
1926 : olson 1.1
1927 : parrello 1.93 Merge default values into a hash table. This method looks at the key-value pairs in the
1928 :     second (default) hash, and if a matching key is not found in the first hash, the default
1929 :     pair is copied in. The process is similar to L</GetOptions>, but there is no error-
1930 :     checking and no return value.
1931 : olson 1.1
1932 :     =over 4
1933 :    
1934 : parrello 1.93 =item table
1935 : olson 1.1
1936 : parrello 1.93 Hash table to be updated with the default values.
1937 : olson 1.1
1938 : parrello 1.93 =item defaults
1939 : olson 1.1
1940 : parrello 1.93 Default values to be merged into the first hash table if they are not already present.
1941 : olson 1.1
1942 :     =back
1943 :    
1944 :     =cut
1945 :    
1946 : parrello 1.93 sub MergeOptions {
1947 :     # Get the parameters.
1948 :     my ($table, $defaults) = @_;
1949 :     # Loop through the defaults.
1950 :     while (my ($key, $value) = each %{$defaults}) {
1951 :     if (!exists $table->{$key}) {
1952 :     $table->{$key} = $value;
1953 :     }
1954 : parrello 1.12 }
1955 : olson 1.1 }
1956 :    
1957 : parrello 1.111 =head3 UnparseOptions
1958 :    
1959 :     my $optionString = Tracer::UnparseOptions(\%options);
1960 :    
1961 :     Convert an option hash into a command-line string. This will not
1962 :     necessarily be the same text that came in, but it will nonetheless
1963 :     produce the same ultimate result when parsed by L</StandardSetup>.
1964 :    
1965 :     =over 4
1966 :    
1967 :     =item options
1968 :    
1969 :     Reference to a hash of options to convert into an option string.
1970 :    
1971 :     =item RETURN
1972 :    
1973 :     Returns a string that will parse to the same set of options when
1974 :     parsed by L</StandardSetup>.
1975 :    
1976 :     =back
1977 :    
1978 :     =cut
1979 :    
1980 :     sub UnparseOptions {
1981 :     # Get the parameters.
1982 :     my ($options) = @_;
1983 :     # The option segments will be put in here.
1984 :     my @retVal = ();
1985 :     # Loop through the options.
1986 :     for my $key (keys %$options) {
1987 :     # Get the option value.
1988 :     my $value = $options->{$key};
1989 :     # Only use it if it's nonempty.
1990 :     if (defined $value && $value ne "") {
1991 :     my $segment = "--$key=$value";
1992 :     # Quote it if necessary.
1993 :     if ($segment =~ /[ |<>*]/) {
1994 :     $segment = '"' . $segment . '"';
1995 :     }
1996 :     # Add it to the return list.
1997 :     push @retVal, $segment;
1998 :     }
1999 :     }
2000 :     # Return the result.
2001 :     return join(" ", @retVal);
2002 :     }
2003 :    
2004 : parrello 1.93 =head3 ParseCommand
2005 : olson 1.1
2006 : parrello 1.93 my ($options, @arguments) = Tracer::ParseCommand(\%optionTable, @inputList);
2007 : olson 1.1
2008 : parrello 1.93 Parse a command line consisting of a list of parameters. The initial parameters may be option
2009 :     specifiers of the form C<->I<option> or C<->I<option>C<=>I<value>. The options are stripped
2010 :     off and merged into a table of default options. The remainder of the command line is
2011 :     returned as a list of positional arguments. For example, consider the following invocation.
2012 : olson 1.1
2013 : parrello 1.93 my ($options, @arguments) = ParseCommand({ errors => 0, logFile => 'trace.log'}, @words);
2014 : olson 1.1
2015 : parrello 1.93 In this case, the list @words will be treated as a command line and there are two options available,
2016 :     B<errors> and B<logFile>. If @words has the following format
2017 : olson 1.1
2018 : parrello 1.93 -logFile=error.log apple orange rutabaga
2019 : olson 1.1
2020 : parrello 1.93 then at the end of the invocation, C<$options> will be
2021 : olson 1.1
2022 : parrello 1.93 { errors => 0, logFile => 'error.log' }
2023 : olson 1.1
2024 : parrello 1.93 and C<@arguments> will contain
2025 : olson 1.1
2026 : parrello 1.93 apple orange rutabaga
2027 : olson 1.1
2028 : parrello 1.93 The parser allows for some escape sequences. See L</UnEscape> for a description. There is no
2029 :     support for quote characters. Options can be specified with single or double hyphens.
2030 : parrello 1.54
2031 :     =over 4
2032 :    
2033 : parrello 1.93 =item optionTable
2034 : parrello 1.54
2035 : parrello 1.93 Table of default options.
2036 : parrello 1.54
2037 : parrello 1.93 =item inputList
2038 : parrello 1.54
2039 : parrello 1.93 List of words on the command line.
2040 : parrello 1.54
2041 :     =item RETURN
2042 :    
2043 : parrello 1.93 Returns a reference to the option table and a list of the positional arguments.
2044 : parrello 1.54
2045 :     =back
2046 :    
2047 :     =cut
2048 :    
2049 : parrello 1.93 sub ParseCommand {
2050 : parrello 1.54 # Get the parameters.
2051 : parrello 1.93 my ($optionTable, @inputList) = @_;
2052 :     # Process any options in the input list.
2053 :     my %overrides = ();
2054 :     while ((@inputList > 0) && ($inputList[0] =~ /^--?/)) {
2055 :     # Get the current option.
2056 :     my $arg = shift @inputList;
2057 :     # Pull out the option name.
2058 :     $arg =~ /^--?([^=]*)/g;
2059 :     my $name = $1;
2060 :     # Check for an option value.
2061 :     if ($arg =~ /\G=(.*)$/g) {
2062 :     # Here we have a value for the option.
2063 :     $overrides{$name} = UnEscape($1);
2064 :     } else {
2065 :     # Here there is no value, so we use 1.
2066 :     $overrides{$name} = 1;
2067 :     }
2068 :     }
2069 :     # Merge the options into the defaults.
2070 :     GetOptions($optionTable, \%overrides);
2071 :     # Translate the remaining parameters.
2072 :     my @retVal = ();
2073 :     for my $inputParm (@inputList) {
2074 :     push @retVal, UnEscape($inputParm);
2075 : parrello 1.54 }
2076 : parrello 1.93 # Return the results.
2077 :     return ($optionTable, @retVal);
2078 : parrello 1.54 }
2079 :    
2080 : parrello 1.93
2081 :     =head2 File Utility Methods
2082 :    
2083 : olson 1.1 =head3 GetFile
2084 :    
2085 : parrello 1.92 my @fileContents = Tracer::GetFile($fileName);
2086 : olson 1.1
2087 : parrello 1.35 or
2088 :    
2089 : parrello 1.92 my $fileContents = Tracer::GetFile($fileName);
2090 : parrello 1.35
2091 :     Return the entire contents of a file. In list context, line-ends are removed and
2092 :     each line is a list element. In scalar context, line-ends are replaced by C<\n>.
2093 : olson 1.1
2094 :     =over 4
2095 :    
2096 :     =item fileName
2097 :    
2098 :     Name of the file to read.
2099 :    
2100 :     =item RETURN
2101 :    
2102 : parrello 1.6 In a list context, returns the entire file as a list with the line terminators removed.
2103 : parrello 1.39 In a scalar context, returns the entire file as a string. If an error occurs opening
2104 :     the file, an empty list will be returned.
2105 : olson 1.1
2106 :     =back
2107 :    
2108 :     =cut
2109 :    
2110 :     sub GetFile {
2111 : parrello 1.12 # Get the parameters.
2112 :     my ($fileName) = @_;
2113 :     # Declare the return variable.
2114 :     my @retVal = ();
2115 :     # Open the file for input.
2116 : parrello 1.60 my $handle = Open(undef, "<$fileName");
2117 :     # Read the whole file into the return variable, stripping off any terminator
2118 :     # characters.
2119 :     my $lineCount = 0;
2120 :     while (my $line = <$handle>) {
2121 :     $lineCount++;
2122 :     $line = Strip($line);
2123 :     push @retVal, $line;
2124 :     }
2125 :     # Close it.
2126 :     close $handle;
2127 :     my $actualLines = @retVal;
2128 : parrello 1.77 Trace("$actualLines lines read from file $fileName.") if T(File => 2);
2129 : parrello 1.12 # Return the file's contents in the desired format.
2130 : parrello 1.9 if (wantarray) {
2131 : parrello 1.12 return @retVal;
2132 : parrello 1.6 } else {
2133 :     return join "\n", @retVal;
2134 :     }
2135 : olson 1.1 }
2136 :    
2137 : parrello 1.60 =head3 PutFile
2138 :    
2139 : parrello 1.92 Tracer::PutFile($fileName, \@lines);
2140 : parrello 1.60
2141 :     Write out a file from a list of lines of text.
2142 :    
2143 :     =over 4
2144 :    
2145 :     =item fileName
2146 :    
2147 :     Name of the output file.
2148 :    
2149 :     =item lines
2150 :    
2151 :     Reference to a list of text lines. The lines will be written to the file in order, with trailing
2152 : parrello 1.66 new-line characters. Alternatively, may be a string, in which case the string will be written without
2153 :     modification.
2154 : parrello 1.60
2155 :     =back
2156 :    
2157 :     =cut
2158 :    
2159 :     sub PutFile {
2160 :     # Get the parameters.
2161 :     my ($fileName, $lines) = @_;
2162 :     # Open the output file.
2163 :     my $handle = Open(undef, ">$fileName");
2164 : parrello 1.77 # Count the lines written.
2165 : parrello 1.66 if (ref $lines ne 'ARRAY') {
2166 :     # Here we have a scalar, so we write it raw.
2167 :     print $handle $lines;
2168 : parrello 1.77 Trace("Scalar put to file $fileName.") if T(File => 3);
2169 : parrello 1.66 } else {
2170 :     # Write the lines one at a time.
2171 : parrello 1.77 my $count = 0;
2172 : parrello 1.66 for my $line (@{$lines}) {
2173 :     print $handle "$line\n";
2174 : parrello 1.77 $count++;
2175 : parrello 1.66 }
2176 : parrello 1.77 Trace("$count lines put to file $fileName.") if T(File => 3);
2177 : parrello 1.60 }
2178 :     # Close the output file.
2179 :     close $handle;
2180 :     }
2181 :    
2182 : parrello 1.93 =head3 ParseRecord
2183 : olson 1.1
2184 : parrello 1.93 my @fields = Tracer::ParseRecord($line);
2185 : olson 1.1
2186 : parrello 1.93 Parse a tab-delimited data line. The data line is split into field values. Embedded tab
2187 :     and new-line characters in the data line must be represented as C<\t> and C<\n>, respectively.
2188 :     These will automatically be converted.
2189 : olson 1.1
2190 :     =over 4
2191 :    
2192 : parrello 1.93 =item line
2193 :    
2194 :     Line of data containing the tab-delimited fields.
2195 :    
2196 :     =item RETURN
2197 : olson 1.1
2198 : parrello 1.93 Returns a list of the fields found in the data line.
2199 : olson 1.1
2200 :     =back
2201 :    
2202 :     =cut
2203 :    
2204 : parrello 1.93 sub ParseRecord {
2205 : parrello 1.12 # Get the parameter.
2206 : parrello 1.93 my ($line) = @_;
2207 :     # Remove the trailing new-line, if any.
2208 :     chomp $line;
2209 :     # Split the line read into pieces using the tab character.
2210 :     my @retVal = split /\t/, $line;
2211 :     # Trim and fix the escapes in each piece.
2212 :     for my $value (@retVal) {
2213 :     # Trim leading whitespace.
2214 :     $value =~ s/^\s+//;
2215 :     # Trim trailing whitespace.
2216 :     $value =~ s/\s+$//;
2217 :     # Delete the carriage returns.
2218 :     $value =~ s/\r//g;
2219 :     # Convert the escapes into their real values.
2220 :     $value =~ s/\\t/"\t"/ge;
2221 :     $value =~ s/\\n/"\n"/ge;
2222 :     }
2223 :     # Return the result.
2224 :     return @retVal;
2225 :     }
2226 :    
2227 :     =head3 Merge
2228 :    
2229 :     my @mergedList = Tracer::Merge(@inputList);
2230 :    
2231 :     Sort a list of strings and remove duplicates.
2232 :    
2233 :     =over 4
2234 :    
2235 :     =item inputList
2236 :    
2237 :     List of scalars to sort and merge.
2238 :    
2239 :     =item RETURN
2240 :    
2241 :     Returns a list containing the same elements sorted in ascending order with duplicates
2242 :     removed.
2243 :    
2244 :     =back
2245 :    
2246 :     =cut
2247 :    
2248 :     sub Merge {
2249 :     # Get the input list in sort order.
2250 :     my @inputList = sort @_;
2251 :     # Only proceed if the list has at least two elements.
2252 :     if (@inputList > 1) {
2253 :     # Now we want to move through the list splicing out duplicates.
2254 :     my $i = 0;
2255 :     while ($i < @inputList) {
2256 :     # Get the current entry.
2257 :     my $thisEntry = $inputList[$i];
2258 :     # Find out how many elements duplicate the current entry.
2259 :     my $j = $i + 1;
2260 :     my $dup1 = $i + 1;
2261 :     while ($j < @inputList && $inputList[$j] eq $thisEntry) { $j++; };
2262 :     # If the number is nonzero, splice out the duplicates found.
2263 :     if ($j > $dup1) {
2264 :     splice @inputList, $dup1, $j - $dup1;
2265 : parrello 1.14 }
2266 : parrello 1.93 # Now the element at position $dup1 is different from the element before it
2267 :     # at position $i. We push $i forward one position and start again.
2268 :     $i++;
2269 : parrello 1.14 }
2270 : parrello 1.12 }
2271 : parrello 1.93 # Return the merged list.
2272 :     return @inputList;
2273 : olson 1.1 }
2274 :    
2275 : parrello 1.93 =head3 Open
2276 : olson 1.1
2277 : parrello 1.93 my $handle = Open($fileHandle, $fileSpec, $message);
2278 : olson 1.1
2279 : parrello 1.93 Open a file.
2280 : olson 1.1
2281 : parrello 1.93 The I<$fileSpec> is essentially the second argument of the PERL C<open>
2282 :     function. The mode is specified using Unix-like shell information. So, for
2283 :     example,
2284 : olson 1.1
2285 : parrello 1.93 Open(\*LOGFILE, '>>/usr/spool/news/twitlog', "Could not open twit log.");
2286 : olson 1.1
2287 : parrello 1.93 would open for output appended to the specified file, and
2288 : olson 1.1
2289 : parrello 1.93 Open(\*DATASTREAM, "| sort -u >$outputFile", "Could not open $outputFile.");
2290 : olson 1.1
2291 : parrello 1.93 would open a pipe that sorts the records written and removes duplicates. Note
2292 :     the use of file handle syntax in the Open call. To use anonymous file handles,
2293 :     code as follows.
2294 : olson 1.1
2295 : parrello 1.93 my $logFile = Open(undef, '>>/usr/spool/news/twitlog', "Could not open twit log.");
2296 : olson 1.1
2297 : parrello 1.93 The I<$message> parameter is used if the open fails. If it is set to C<0>, then
2298 :     the open returns TRUE if successful and FALSE if an error occurred. Otherwise, a
2299 :     failed open will throw an exception and the third parameter will be used to construct
2300 :     an error message. If the parameter is omitted, a standard message is constructed
2301 :     using the file spec.
2302 : olson 1.1
2303 : parrello 1.93 Could not open "/usr/spool/news/twitlog"
2304 : olson 1.1
2305 : parrello 1.93 Note that the mode characters are automatically cleaned from the file name.
2306 :     The actual error message from the file system will be captured and appended to the
2307 :     message in any case.
2308 : parrello 1.6
2309 : parrello 1.93 Could not open "/usr/spool/news/twitlog": file not found.
2310 : parrello 1.6
2311 : parrello 1.93 In some versions of PERL the only error message we get is a number, which
2312 :     corresponds to the C++ C<errno> value.
2313 : parrello 1.6
2314 : parrello 1.93 Could not open "/usr/spool/news/twitlog": 6.
2315 : parrello 1.6
2316 : parrello 1.93 =over 4
2317 : parrello 1.6
2318 : parrello 1.93 =item fileHandle
2319 : parrello 1.6
2320 : parrello 1.93 File handle. If this parameter is C<undef>, a file handle will be generated
2321 :     and returned as the value of this method.
2322 : olson 1.1
2323 : parrello 1.93 =item fileSpec
2324 : olson 1.1
2325 : parrello 1.93 File name and mode, as per the PERL C<open> function.
2326 : olson 1.1
2327 : parrello 1.93 =item message (optional)
2328 : olson 1.1
2329 : parrello 1.93 Error message to use if the open fails. If omitted, a standard error message
2330 :     will be generated. In either case, the error information from the file system
2331 :     is appended to the message. To specify a conditional open that does not throw
2332 :     an error if it fails, use C<0>.
2333 : olson 1.1
2334 : parrello 1.93 =item RETURN
2335 : olson 1.1
2336 : parrello 1.93 Returns the name of the file handle assigned to the file, or C<undef> if the
2337 :     open failed.
2338 : olson 1.1
2339 :     =back
2340 :    
2341 :     =cut
2342 :    
2343 : parrello 1.93 sub Open {
2344 : parrello 1.12 # Get the parameters.
2345 : parrello 1.93 my ($fileHandle, $fileSpec, $message) = @_;
2346 :     # Attempt to open the file.
2347 :     my $rv = open $fileHandle, $fileSpec;
2348 :     # If the open failed, generate an error message.
2349 :     if (! $rv) {
2350 :     # Save the system error message.
2351 :     my $sysMessage = $!;
2352 :     # See if we need a default message.
2353 :     if (!$message) {
2354 :     # Clean any obvious mode characters and leading spaces from the
2355 :     # filename.
2356 :     my ($fileName) = FindNamePart($fileSpec);
2357 :     $message = "Could not open \"$fileName\"";
2358 :     }
2359 :     # Terminate with an error using the supplied message and the
2360 :     # error message from the file system.
2361 :     Confess("$message: $!");
2362 : parrello 1.12 }
2363 : parrello 1.93 # Return the file handle.
2364 :     return $fileHandle;
2365 : olson 1.1 }
2366 :    
2367 : parrello 1.93 =head3 FindNamePart
2368 :    
2369 :     my ($fileName, $start, $len) = Tracer::FindNamePart($fileSpec);
2370 :    
2371 :     Extract the portion of a file specification that contains the file name.
2372 :    
2373 :     A file specification is the string passed to an C<open> call. It specifies the file
2374 :     mode and name. In a truly complex situation, it can specify a pipe sequence. This
2375 :     method assumes that the file name is whatever follows the first angle bracket
2376 :     sequence. So, for example, in the following strings the file name is
2377 :     C</usr/fig/myfile.txt>.
2378 : parrello 1.5
2379 : parrello 1.93 >>/usr/fig/myfile.txt
2380 :     </usr/fig/myfile.txt
2381 :     | sort -u > /usr/fig/myfile.txt
2382 : parrello 1.5
2383 : parrello 1.93 If the method cannot find a file name using its normal methods, it will return the
2384 :     whole incoming string.
2385 : parrello 1.5
2386 :     =over 4
2387 :    
2388 : parrello 1.93 =item fileSpec
2389 : parrello 1.5
2390 : parrello 1.93 File specification string from which the file name is to be extracted.
2391 : parrello 1.5
2392 :     =item RETURN
2393 :    
2394 : parrello 1.93 Returns a three-element list. The first element contains the file name portion of
2395 :     the specified string, or the whole string if a file name cannot be found via normal
2396 :     methods. The second element contains the start position of the file name portion and
2397 :     the third element contains the length.
2398 : parrello 1.5
2399 :     =back
2400 :    
2401 :     =cut
2402 : parrello 1.93 #: Return Type $;
2403 :     sub FindNamePart {
2404 :     # Get the parameters.
2405 :     my ($fileSpec) = @_;
2406 :     # Default to the whole input string.
2407 :     my ($retVal, $pos, $len) = ($fileSpec, 0, length $fileSpec);
2408 :     # Parse out the file name if we can.
2409 :     if ($fileSpec =~ m/(<|>>?)(.+?)(\s*)$/) {
2410 :     $retVal = $2;
2411 :     $len = length $retVal;
2412 :     $pos = (length $fileSpec) - (length $3) - $len;
2413 : parrello 1.12 }
2414 : parrello 1.93 # Return the result.
2415 :     return ($retVal, $pos, $len);
2416 : parrello 1.5 }
2417 :    
2418 : parrello 1.93 =head3 OpenDir
2419 : parrello 1.5
2420 : parrello 1.93 my @files = OpenDir($dirName, $filtered, $flag);
2421 : parrello 1.5
2422 : parrello 1.93 Open a directory and return all the file names. This function essentially performs
2423 :     the functions of an C<opendir> and C<readdir>. If the I<$filtered> parameter is
2424 :     set to TRUE, all filenames beginning with a period (C<.>), dollar sign (C<$>),
2425 :     or pound sign (C<#>) and all filenames ending with a tilde C<~>) will be
2426 :     filtered out of the return list. If the directory does not open and I<$flag> is not
2427 :     set, an exception is thrown. So, for example,
2428 : parrello 1.5
2429 : parrello 1.93 my @files = OpenDir("/Volumes/fig/contigs", 1);
2430 : parrello 1.5
2431 : parrello 1.93 is effectively the same as
2432 : parrello 1.5
2433 : parrello 1.93 opendir(TMP, "/Volumes/fig/contigs") || Confess("Could not open /Volumes/fig/contigs.");
2434 :     my @files = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir(TMP);
2435 : parrello 1.5
2436 : parrello 1.93 Similarly, the following code
2437 : parrello 1.5
2438 : parrello 1.93 my @files = grep { $_ =~ /^\d/ } OpenDir("/Volumes/fig/orgs", 0, 1);
2439 : parrello 1.5
2440 : parrello 1.93 Returns the names of all files in C</Volumes/fig/orgs> that begin with digits and
2441 :     automatically returns an empty list if the directory fails to open.
2442 : parrello 1.5
2443 : parrello 1.93 =over 4
2444 : parrello 1.5
2445 : parrello 1.93 =item dirName
2446 : parrello 1.5
2447 : parrello 1.93 Name of the directory to open.
2448 : parrello 1.5
2449 : parrello 1.93 =item filtered
2450 : parrello 1.5
2451 : parrello 1.93 TRUE if files whose names begin with a period (C<.>) should be automatically removed
2452 :     from the list, else FALSE.
2453 : parrello 1.5
2454 : parrello 1.93 =item flag
2455 : parrello 1.5
2456 : parrello 1.93 TRUE if a failure to open is okay, else FALSE
2457 : parrello 1.5
2458 : parrello 1.93 =back
2459 : parrello 1.5
2460 : parrello 1.93 =cut
2461 :     #: Return Type @;
2462 :     sub OpenDir {
2463 :     # Get the parameters.
2464 :     my ($dirName, $filtered, $flag) = @_;
2465 :     # Declare the return variable.
2466 :     my @retVal = ();
2467 :     # Open the directory.
2468 :     if (opendir(my $dirHandle, $dirName)) {
2469 :     # The directory opened successfully. Get the appropriate list according to the
2470 :     # strictures of the filter parameter.
2471 :     if ($filtered) {
2472 :     @retVal = grep { $_ !~ /^[\.\$\#]/ && $_ !~ /~$/ } readdir $dirHandle;
2473 :     } else {
2474 :     @retVal = readdir $dirHandle;
2475 :     }
2476 :     } elsif (! $flag) {
2477 :     # Here the directory would not open and it's considered an error.
2478 :     Confess("Could not open directory $dirName.");
2479 :     }
2480 :     # Return the result.
2481 :     return @retVal;
2482 :     }
2483 : parrello 1.5
2484 :    
2485 : parrello 1.93 =head3 Insure
2486 : parrello 1.5
2487 : parrello 1.93 Insure($dirName, $chmod);
2488 : parrello 1.5
2489 : parrello 1.93 Insure a directory is present.
2490 : parrello 1.5
2491 : parrello 1.93 =over 4
2492 : parrello 1.5
2493 : parrello 1.93 =item dirName
2494 : olson 1.1
2495 : parrello 1.93 Name of the directory to check. If it does not exist, it will be created.
2496 : parrello 1.7
2497 : parrello 1.93 =item chmod (optional)
2498 : parrello 1.7
2499 : parrello 1.93 Security privileges to be given to the directory if it is created.
2500 : parrello 1.7
2501 : parrello 1.93 =back
2502 : parrello 1.7
2503 :     =cut
2504 :    
2505 : parrello 1.93 sub Insure {
2506 :     my ($dirName, $chmod) = @_;
2507 :     if (! -d $dirName) {
2508 :     Trace("Creating $dirName directory.") if T(2);
2509 :     eval {
2510 :     mkpath $dirName;
2511 :     # If we have permissions specified, set them here.
2512 :     if (defined($chmod)) {
2513 :     chmod $chmod, $dirName;
2514 :     }
2515 :     };
2516 :     if ($@) {
2517 :     Confess("Error creating $dirName: $@");
2518 :     }
2519 : parrello 1.12 }
2520 : parrello 1.9 }
2521 :    
2522 : parrello 1.93 =head3 ChDir
2523 : parrello 1.9
2524 : parrello 1.93 ChDir($dirName);
2525 : parrello 1.9
2526 : parrello 1.93 Change to the specified directory.
2527 : parrello 1.9
2528 :     =over 4
2529 :    
2530 : parrello 1.93 =item dirName
2531 : parrello 1.9
2532 : parrello 1.93 Name of the directory to which we want to change.
2533 : parrello 1.9
2534 :     =back
2535 :    
2536 :     =cut
2537 :    
2538 : parrello 1.93 sub ChDir {
2539 :     my ($dirName) = @_;
2540 :     if (! -d $dirName) {
2541 :     Confess("Cannot change to directory $dirName: no such directory.");
2542 :     } else {
2543 :     Trace("Changing to directory $dirName.") if T(File => 4);
2544 :     my $okFlag = chdir $dirName;
2545 :     if (! $okFlag) {
2546 :     Confess("Error switching to directory $dirName.");
2547 :     }
2548 :     }
2549 : parrello 1.9 }
2550 :    
2551 : parrello 1.93 =head3 SetPermissions
2552 :    
2553 :     Tracer::SetPermissions($dirName, $group, $mask, %otherMasks);
2554 : parrello 1.9
2555 : parrello 1.93 Set the permissions for a directory and all the files and folders inside it.
2556 :     In addition, the group ownership will be changed to the specified value.
2557 : parrello 1.9
2558 : parrello 1.93 This method is more vulnerable than most to permission and compatability
2559 :     problems, so it does internal error recovery.
2560 : parrello 1.9
2561 :     =over 4
2562 :    
2563 : parrello 1.93 =item dirName
2564 :    
2565 :     Name of the directory to process.
2566 :    
2567 :     =item group
2568 : parrello 1.9
2569 : parrello 1.93 Name of the group to be assigned.
2570 : parrello 1.9
2571 : parrello 1.93 =item mask
2572 : parrello 1.9
2573 : parrello 1.93 Permission mask. Bits that are C<1> in this mask will be ORed into the
2574 :     permission bits of any file or directory that does not already have them
2575 :     set to 1.
2576 : parrello 1.9
2577 : parrello 1.93 =item otherMasks
2578 : parrello 1.9
2579 : parrello 1.93 Map of search patterns to permission masks. If a directory name matches
2580 :     one of the patterns, that directory and all its members and subdirectories
2581 :     will be assigned the new pattern. For example, the following would
2582 : parrello 1.110 assign 0664 to most files, but would use 0777 for directories named C<tmp>.
2583 : parrello 1.9
2584 : parrello 1.93 Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp$' => 01777);
2585 : parrello 1.9
2586 : parrello 1.93 The list is ordered, so the following would use 0777 for C<tmp1> and
2587 :     0666 for C<tmp>, C<tmp2>, or C<tmp3>.
2588 : parrello 1.22
2589 : parrello 1.93 Tracer::SetPermissions($dirName, 'fig', 01664, '^tmp1' => 0777,
2590 :     '^tmp' => 0666);
2591 : parrello 1.9
2592 : parrello 1.93 Note that the pattern matches are all case-insensitive, and only directory
2593 :     names are matched, not file names.
2594 : parrello 1.9
2595 :     =back
2596 :    
2597 :     =cut
2598 :    
2599 : parrello 1.93 sub SetPermissions {
2600 : parrello 1.12 # Get the parameters.
2601 : parrello 1.93 my ($dirName, $group, $mask, @otherMasks) = @_;
2602 :     # Set up for error recovery.
2603 :     eval {
2604 :     # Switch to the specified directory.
2605 :     ChDir($dirName);
2606 :     # Get the group ID.
2607 :     my $gid = getgrnam($group);
2608 :     # Get the mask for tracing.
2609 :     my $traceMask = sprintf("%04o", $mask) . "($mask)";
2610 :     Trace("Fixing permissions for directory $dirName using group $group($gid) and mask $traceMask.") if T(File => 2);
2611 :     my $fixCount = 0;
2612 :     my $lookCount = 0;
2613 :     # @dirs will be a stack of directories to be processed.
2614 :     my @dirs = (getcwd());
2615 :     while (scalar(@dirs) > 0) {
2616 :     # Get the current directory.
2617 :     my $dir = pop @dirs;
2618 :     # Check for a match to one of the specified directory names. To do
2619 :     # that, we need to pull the individual part of the name off of the
2620 :     # whole path.
2621 :     my $simpleName = $dir;
2622 :     if ($dir =~ m!/([^/]+)$!) {
2623 :     $simpleName = $1;
2624 :     }
2625 :     Trace("Simple directory name for $dir is $simpleName.") if T(File => 4);
2626 :     # Search for a match.
2627 :     my $match = 0;
2628 :     my $i;
2629 :     for ($i = 0; $i < $#otherMasks && ! $match; $i += 2) {
2630 :     my $pattern = $otherMasks[$i];
2631 :     if ($simpleName =~ /$pattern/i) {
2632 :     $match = 1;
2633 :     }
2634 :     }
2635 : parrello 1.110 # Find out if we have a match. Note we use $i-1 because the loop added 2
2636 : parrello 1.93 # before terminating due to the match.
2637 :     if ($match && $otherMasks[$i-1] != $mask) {
2638 :     # This directory matches one of the incoming patterns, and it's
2639 :     # a different mask, so we process it recursively with that mask.
2640 :     SetPermissions($dir, $group, $otherMasks[$i-1], @otherMasks);
2641 :     } else {
2642 :     # Here we can process normally. Get all of the non-hidden members.
2643 :     my @submems = OpenDir($dir, 1);
2644 :     for my $submem (@submems) {
2645 :     # Get the full name.
2646 :     my $thisMem = "$dir/$submem";
2647 :     Trace("Checking member $thisMem.") if T(4);
2648 :     $lookCount++;
2649 :     if ($lookCount % 1000 == 0) {
2650 :     Trace("$lookCount members examined. Current is $thisMem. Mask is $traceMask") if T(File => 3);
2651 :     }
2652 :     # Fix the group.
2653 :     chown -1, $gid, $thisMem;
2654 :     # Insure this member is not a symlink.
2655 :     if (! -l $thisMem) {
2656 :     # Get its info.
2657 :     my $fileInfo = stat $thisMem;
2658 :     # Only proceed if we got the info. Otherwise, it's a hard link
2659 :     # and we want to skip it anyway.
2660 :     if ($fileInfo) {
2661 :     my $fileMode = $fileInfo->mode;
2662 :     if (($fileMode & $mask) != $mask) {
2663 :     # Fix this member.
2664 :     $fileMode |= $mask;
2665 :     chmod $fileMode, $thisMem;
2666 :     $fixCount++;
2667 :     }
2668 :     # If it's a subdirectory, stack it.
2669 :     if (-d $thisMem) {
2670 :     push @dirs, $thisMem;
2671 :     }
2672 :     }
2673 :     }
2674 :     }
2675 :     }
2676 : parrello 1.12 }
2677 : parrello 1.93 Trace("$lookCount files and directories processed, $fixCount fixed.") if T(File => 2);
2678 :     };
2679 :     # Check for an error.
2680 :     if ($@) {
2681 :     Confess("SetPermissions error: $@");
2682 : parrello 1.12 }
2683 : parrello 1.7 }
2684 :    
2685 : parrello 1.93 =head3 GetLine
2686 : parrello 1.29
2687 : parrello 1.93 my @data = Tracer::GetLine($handle);
2688 : parrello 1.15
2689 : parrello 1.93 Read a line of data from a tab-delimited file.
2690 : parrello 1.15
2691 :     =over 4
2692 :    
2693 : parrello 1.93 =item handle
2694 : parrello 1.15
2695 : parrello 1.93 Open file handle from which to read.
2696 : parrello 1.15
2697 :     =item RETURN
2698 :    
2699 : parrello 1.93 Returns a list of the fields in the record read. The fields are presumed to be
2700 :     tab-delimited. If we are at the end of the file, then an empty list will be
2701 :     returned. If an empty line is read, a single list item consisting of a null
2702 :     string will be returned.
2703 : parrello 1.15
2704 :     =back
2705 :    
2706 :     =cut
2707 : parrello 1.93
2708 :     sub GetLine {
2709 : parrello 1.15 # Get the parameters.
2710 : parrello 1.93 my ($handle) = @_;
2711 :     # Declare the return variable.
2712 :     my @retVal = ();
2713 :     Trace("File position is " . tell($handle) . ". EOF flag is " . eof($handle) . ".") if T(File => 4);
2714 :     # Read from the file.
2715 :     my $line = <$handle>;
2716 :     # Only proceed if we found something.
2717 :     if (defined $line) {
2718 :     # Remove the new-line. We are a bit over-cautious here because the file may be coming in via an
2719 :     # upload control and have a nonstandard EOL combination.
2720 :     $line =~ s/(\r|\n)+$//;
2721 :     # Here we do some fancy tracing to help in debugging complicated EOL marks.
2722 :     if (T(File => 4)) {
2723 :     my $escapedLine = $line;
2724 :     $escapedLine =~ s/\n/\\n/g;
2725 :     $escapedLine =~ s/\r/\\r/g;
2726 :     $escapedLine =~ s/\t/\\t/g;
2727 :     Trace("Line read: -->$escapedLine<--");
2728 :     }
2729 :     # If the line is empty, return a single empty string; otherwise, parse
2730 :     # it into fields.
2731 :     if ($line eq "") {
2732 :     push @retVal, "";
2733 :     } else {
2734 :     push @retVal, split /\t/,$line;
2735 :     }
2736 :     } else {
2737 :     # Trace the reason the read failed.
2738 :     Trace("End of file: $!") if T(File => 3);
2739 : parrello 1.15 }
2740 : parrello 1.93 # Return the result.
2741 :     return @retVal;
2742 : parrello 1.15 }
2743 :    
2744 : parrello 1.93 =head3 PutLine
2745 :    
2746 :     Tracer::PutLine($handle, \@fields, $eol);
2747 : parrello 1.35
2748 : parrello 1.93 Write a line of data to a tab-delimited file. The specified field values will be
2749 :     output in tab-separated form, with a trailing new-line.
2750 : parrello 1.35
2751 : parrello 1.93 =over 4
2752 : parrello 1.35
2753 : parrello 1.93 =item handle
2754 : parrello 1.69
2755 : parrello 1.93 Output file handle.
2756 : parrello 1.69
2757 : parrello 1.93 =item fields
2758 : parrello 1.69
2759 : parrello 1.93 List of field values.
2760 : parrello 1.69
2761 : parrello 1.93 =item eol (optional)
2762 : parrello 1.69
2763 : parrello 1.93 End-of-line character (default is "\n").
2764 : parrello 1.69
2765 :     =back
2766 : parrello 1.35
2767 :     =cut
2768 :    
2769 : parrello 1.93 sub PutLine {
2770 : parrello 1.69 # Get the parameters.
2771 : parrello 1.93 my ($handle, $fields, $eol) = @_;
2772 :     # Write the data.
2773 :     print $handle join("\t", @{$fields}) . ($eol || "\n");
2774 : parrello 1.69 }
2775 :    
2776 :    
2777 : parrello 1.97 =head3 PrintLine
2778 :    
2779 :     Tracer::PrintLine($line);
2780 :    
2781 :     Print a line of text with a trailing new-line.
2782 :    
2783 :     =over 4
2784 :    
2785 :     =item line
2786 :    
2787 :     Line of text to print.
2788 :    
2789 :     =back
2790 :    
2791 :     =cut
2792 :    
2793 :     sub PrintLine {
2794 :     # Get the parameters.
2795 :     my ($line) = @_;
2796 :     # Print the line.
2797 :     print "$line\n";
2798 :     }
2799 :    
2800 : parrello 1.69
2801 : parrello 1.93 =head2 Other Useful Methods
2802 :    
2803 :     =head3 ParseParm
2804 :    
2805 :     my $listValue = Tracer::ParseParm($string);
2806 :    
2807 :     Convert a parameter into a list reference. If the parameter is undefined,
2808 :     an undefined value will be returned. Otherwise, it will be parsed as a
2809 :     comma-separated list of values.
2810 : parrello 1.69
2811 :     =over 4
2812 :    
2813 : parrello 1.93 =item string
2814 :    
2815 :     Incoming string.
2816 :    
2817 :     =item RETURN
2818 : parrello 1.69
2819 : parrello 1.93 Returns a reference to a list of values, or C<undef> if the incoming value
2820 :     was undefined.
2821 : parrello 1.69
2822 :     =back
2823 :    
2824 :     =cut
2825 :    
2826 : parrello 1.93 sub ParseParm {
2827 :     # Get the parameters.
2828 :     my ($string) = @_;
2829 :     # Declare the return variable.
2830 :     my $retVal;
2831 :     # Check for data.
2832 :     if (defined $string) {
2833 :     # We have some, so split it into a list.
2834 :     $retVal = [ split /\s*,\s*/, $string];
2835 : parrello 1.72 }
2836 : parrello 1.93 # Return the result.
2837 :     return $retVal;
2838 : parrello 1.69 }
2839 :    
2840 : parrello 1.97 =head3 Now
2841 :    
2842 :     my $string = Tracer::Now();
2843 :    
2844 :     Return a displayable time stamp containing the local time. Whatever format this
2845 :     method produces must be parseable by L</ParseDate>.
2846 :    
2847 :     =cut
2848 :    
2849 :     sub Now {
2850 :     return DisplayTime(time);
2851 :     }
2852 :    
2853 :     =head3 DisplayTime
2854 :    
2855 :     my $string = Tracer::DisplayTime($time);
2856 : parrello 1.69
2857 : parrello 1.97 Convert a time value to a displayable time stamp. Whatever format this
2858 :     method produces must be parseable by L</ParseDate>.
2859 :    
2860 :     =over 4
2861 : parrello 1.69
2862 : parrello 1.97 =item time
2863 : parrello 1.69
2864 : parrello 1.97 Time to display, in seconds since the epoch, or C<undef> if the time is unknown.
2865 :    
2866 :     =item RETURN
2867 : parrello 1.69
2868 : parrello 1.97 Returns a displayable time, or C<(n/a)> if the incoming time is undefined.
2869 : parrello 1.69
2870 : parrello 1.97 =back
2871 : parrello 1.69
2872 : parrello 1.93 =cut
2873 : parrello 1.69
2874 : parrello 1.97 sub DisplayTime {
2875 :     my ($time) = @_;
2876 :     my $retVal = "(n/a)";
2877 :     if (defined $time) {
2878 :     my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($time);
2879 :     $retVal = _p2($mon+1) . "/" . _p2($mday) . "/" . ($year + 1900) . " " .
2880 :     _p2($hour) . ":" . _p2($min) . ":" . _p2($sec);
2881 :     }
2882 : parrello 1.93 return $retVal;
2883 :     }
2884 : parrello 1.69
2885 : parrello 1.93 # Pad a number to 2 digits.
2886 :     sub _p2 {
2887 :     my ($value) = @_;
2888 :     $value = "0$value" if ($value < 10);
2889 :     return $value;
2890 : parrello 1.69 }
2891 :    
2892 : parrello 1.93 =head3 Escape
2893 : parrello 1.69
2894 : parrello 1.93 my $codedString = Tracer::Escape($realString);
2895 : parrello 1.69
2896 : parrello 1.93 Escape a string for use in a command. Tabs will be replaced by C<\t>, new-lines
2897 :     replaced by C<\n>, carriage returns will be deleted, and backslashes will be doubled. The
2898 :     result is to reverse the effect of L</UnEscape>.
2899 : parrello 1.69
2900 :     =over 4
2901 :    
2902 : parrello 1.93 =item realString
2903 : parrello 1.69
2904 : parrello 1.93 String to escape.
2905 : parrello 1.69
2906 :     =item RETURN
2907 :    
2908 : parrello 1.93 Escaped equivalent of the real string.
2909 :    
2910 :     =back
2911 :    
2912 :     =cut
2913 :    
2914 :     sub Escape {
2915 :     # Get the parameter.
2916 :     my ($realString) = @_;
2917 :     # Initialize the return variable.
2918 :     my $retVal = "";
2919 :     # Loop through the parameter string, looking for sequences to escape.
2920 :     while (length $realString > 0) {
2921 :     # Look for the first sequence to escape.
2922 :     if ($realString =~ /^(.*?)([\n\t\r\\])/) {
2923 :     # Here we found it. The text preceding the sequence is in $1. The sequence
2924 :     # itself is in $2. First, move the clear text to the return variable.
2925 :     $retVal .= $1;
2926 :     # Strip the processed section off the real string.
2927 :     $realString = substr $realString, (length $2) + (length $1);
2928 :     # Get the matched character.
2929 :     my $char = $2;
2930 :     # If we have a CR, we are done.
2931 :     if ($char ne "\r") {
2932 :     # It's not a CR, so encode the escape sequence.
2933 :     $char =~ tr/\t\n/tn/;
2934 :     $retVal .= "\\" . $char;
2935 :     }
2936 :     } else {
2937 :     # Here there are no more escape sequences. The rest of the string is
2938 :     # transferred unmodified.
2939 :     $retVal .= $realString;
2940 :     $realString = "";
2941 :     }
2942 :     }
2943 :     # Return the result.
2944 :     return $retVal;
2945 : parrello 1.69 }
2946 :    
2947 : parrello 1.93 =head3 UnEscape
2948 : parrello 1.69
2949 : parrello 1.93 my $realString = Tracer::UnEscape($codedString);
2950 : parrello 1.69
2951 : parrello 1.93 Replace escape sequences with their actual equivalents. C<\t> will be replaced by
2952 :     a tab, C<\n> by a new-line character, and C<\\> by a backslash. C<\r> codes will
2953 :     be deleted.
2954 : parrello 1.69
2955 :     =over 4
2956 :    
2957 : parrello 1.93 =item codedString
2958 : parrello 1.69
2959 : parrello 1.93 String to un-escape.
2960 : parrello 1.69
2961 :     =item RETURN
2962 :    
2963 : parrello 1.93 Returns a copy of the original string with the escape sequences converted to their actual
2964 :     values.
2965 : parrello 1.69
2966 :     =back
2967 :    
2968 :     =cut
2969 :    
2970 : parrello 1.93 sub UnEscape {
2971 :     # Get the parameter.
2972 :     my ($codedString) = @_;
2973 :     # Initialize the return variable.
2974 :     my $retVal = "";
2975 :     # Only proceed if the incoming string is nonempty.
2976 :     if (defined $codedString) {
2977 :     # Loop through the parameter string, looking for escape sequences. We can't do
2978 :     # translating because it causes problems with the escaped slash. ("\\t" becomes
2979 :     # "\<tab>" no matter what we do.)
2980 :     while (length $codedString > 0) {
2981 :     # Look for the first escape sequence.
2982 :     if ($codedString =~ /^(.*?)\\(\\|n|t|r)/) {
2983 :     # Here we found it. The text preceding the sequence is in $1. The sequence
2984 :     # itself is in $2. First, move the clear text to the return variable.
2985 :     $retVal .= $1;
2986 :     $codedString = substr $codedString, (2 + length $1);
2987 :     # Get the escape value.
2988 :     my $char = $2;
2989 :     # If we have a "\r", we are done.
2990 :     if ($char ne 'r') {
2991 :     # Here it's not an 'r', so we convert it.
2992 :     $char =~ tr/\\tn/\\\t\n/;
2993 :     $retVal .= $char;
2994 :     }
2995 :     } else {
2996 :     # Here there are no more escape sequences. The rest of the string is
2997 :     # transferred unmodified.
2998 :     $retVal .= $codedString;
2999 :     $codedString = "";
3000 :     }
3001 :     }
3002 : parrello 1.35 }
3003 : parrello 1.69 # Return the result.
3004 :     return $retVal;
3005 :     }
3006 :    
3007 : parrello 1.93 =head3 Percent
3008 : parrello 1.69
3009 : parrello 1.93 my $percent = Tracer::Percent($number, $base);
3010 : parrello 1.69
3011 : parrello 1.93 Returns the percent of the base represented by the given number. If the base
3012 :     is zero, returns zero.
3013 : parrello 1.69
3014 :     =over 4
3015 :    
3016 : parrello 1.93 =item number
3017 : parrello 1.69
3018 : parrello 1.93 Percent numerator.
3019 : parrello 1.69
3020 : parrello 1.93 =item base
3021 : parrello 1.69
3022 : parrello 1.93 Percent base.
3023 : parrello 1.69
3024 : parrello 1.93 =item RETURN
3025 : parrello 1.69
3026 : parrello 1.93 Returns the percentage of the base represented by the numerator.
3027 : parrello 1.69
3028 :     =back
3029 :    
3030 :     =cut
3031 :    
3032 : parrello 1.93 sub Percent {
3033 : parrello 1.69 # Get the parameters.
3034 : parrello 1.93 my ($number, $base) = @_;
3035 :     # Declare the return variable.
3036 :     my $retVal = 0;
3037 :     # Compute the percent.
3038 :     if ($base != 0) {
3039 :     $retVal = $number * 100 / $base;
3040 :     }
3041 :     # Return the result.
3042 :     return $retVal;
3043 : parrello 1.69 }
3044 :    
3045 : parrello 1.97 =head3 Constrain
3046 :    
3047 :     my $constrained = Constrain($value, $min, $max);
3048 :    
3049 :     Modify a numeric value to bring it to a point in between a maximum and a minimum.
3050 :    
3051 :     =over 4
3052 :    
3053 :     =item value
3054 :    
3055 :     Value to constrain.
3056 :    
3057 :     =item min (optional)
3058 :    
3059 :     Minimum permissible value. If this parameter is undefined, no minimum constraint will be applied.
3060 :    
3061 :     =item max (optional)
3062 :    
3063 :     Maximum permissible value. If this parameter is undefined, no maximum constraint will be applied.
3064 :    
3065 :     =item RETURN
3066 :    
3067 :     Returns the incoming value, constrained according to the other parameters.
3068 :    
3069 :     =back
3070 :    
3071 :     =cut
3072 :    
3073 :     sub Constrain {
3074 :     # Get the parameters.
3075 :     my ($value, $min, $max) = @_;
3076 :     # Declare the return variable.
3077 :     my $retVal = $value;
3078 :     # Apply the minimum constraint.
3079 :     if (defined $min && $retVal < $min) {
3080 :     $retVal = $min;
3081 :     }
3082 :     # Apply the maximum constraint.
3083 :     if (defined $max && $retVal > $max) {
3084 :     $retVal = $max;
3085 :     }
3086 :     # Return the result.
3087 :     return $retVal;
3088 :     }
3089 :    
3090 : parrello 1.93 =head3 Min
3091 : parrello 1.69
3092 : parrello 1.93 my $min = Min($value1, $value2, ... $valueN);
3093 : parrello 1.69
3094 : parrello 1.93 Return the minimum argument. The arguments are treated as numbers.
3095 : parrello 1.69
3096 :     =over 4
3097 :    
3098 : parrello 1.93 =item $value1, $value2, ... $valueN
3099 : parrello 1.69
3100 : parrello 1.93 List of numbers to compare.
3101 : parrello 1.69
3102 :     =item RETURN
3103 :    
3104 : parrello 1.93 Returns the lowest number in the list.
3105 : parrello 1.69
3106 :     =back
3107 :    
3108 :     =cut
3109 :    
3110 : parrello 1.93 sub Min {
3111 :     # Get the parameters. Note that we prime the return value with the first parameter.
3112 :     my ($retVal, @values) = @_;
3113 :     # Loop through the remaining parameters, looking for the lowest.
3114 :     for my $value (@values) {
3115 :     if ($value < $retVal) {
3116 :     $retVal = $value;
3117 : parrello 1.72 }
3118 :     }
3119 : parrello 1.93 # Return the minimum found.
3120 : parrello 1.70 return $retVal;
3121 : parrello 1.35 }
3122 :    
3123 : parrello 1.93 =head3 Max
3124 :    
3125 :     my $max = Max($value1, $value2, ... $valueN);
3126 : parrello 1.69
3127 : parrello 1.93 Return the maximum argument. The arguments are treated as numbers.
3128 : parrello 1.65
3129 : parrello 1.93 =over 4
3130 : parrello 1.65
3131 : parrello 1.93 =item $value1, $value2, ... $valueN
3132 : parrello 1.65
3133 : parrello 1.93 List of numbers to compare.
3134 : parrello 1.65
3135 : parrello 1.93 =item RETURN
3136 : parrello 1.65
3137 : parrello 1.93 Returns the highest number in the list.
3138 : parrello 1.65
3139 :     =back
3140 :    
3141 :     =cut
3142 :    
3143 : parrello 1.93 sub Max {
3144 :     # Get the parameters. Note that we prime the return value with the first parameter.
3145 :     my ($retVal, @values) = @_;
3146 :     # Loop through the remaining parameters, looking for the highest.
3147 :     for my $value (@values) {
3148 :     if ($value > $retVal) {
3149 :     $retVal = $value;
3150 : parrello 1.65 }
3151 :     }
3152 : parrello 1.93 # Return the maximum found.
3153 :     return $retVal;
3154 : parrello 1.65 }
3155 :    
3156 : parrello 1.93 =head3 Strip
3157 : parrello 1.37
3158 : parrello 1.93 my $string = Tracer::Strip($line);
3159 : parrello 1.37
3160 : parrello 1.93 Strip all line terminators off a string. This is necessary when dealing with files
3161 :     that may have been transferred back and forth several times among different
3162 :     operating environments.
3163 : parrello 1.37
3164 :     =over 4
3165 :    
3166 : parrello 1.93 =item line
3167 : parrello 1.37
3168 : parrello 1.93 Line of text to be stripped.
3169 : parrello 1.37
3170 : parrello 1.93 =item RETURN
3171 : parrello 1.91
3172 : parrello 1.93 The same line of text with all the line-ending characters chopped from the end.
3173 : parrello 1.91
3174 : parrello 1.37 =back
3175 :    
3176 :     =cut
3177 :    
3178 : parrello 1.93 sub Strip {
3179 :     # Get a copy of the parameter string.
3180 :     my ($string) = @_;
3181 :     my $retVal = (defined $string ? $string : "");
3182 :     # Strip the line terminator characters.
3183 :     $retVal =~ s/(\r|\n)+$//g;
3184 :     # Return the result.
3185 :     return $retVal;
3186 : parrello 1.43 }
3187 :    
3188 : parrello 1.93 =head3 Pad
3189 : parrello 1.43
3190 : parrello 1.93 my $paddedString = Tracer::Pad($string, $len, $left, $padChar);
3191 : parrello 1.43
3192 : parrello 1.93 Pad a string to a specified length. The pad character will be a
3193 :     space, and the padding will be on the right side unless specified
3194 :     in the third parameter.
3195 : parrello 1.43
3196 :     =over 4
3197 :    
3198 : parrello 1.93 =item string
3199 :    
3200 :     String to be padded.
3201 :    
3202 :     =item len
3203 :    
3204 :     Desired length of the padded string.
3205 :    
3206 :     =item left (optional)
3207 :    
3208 :     TRUE if the string is to be left-padded; otherwise it will be padded on the right.
3209 :    
3210 :     =item padChar (optional)
3211 :    
3212 :     Character to use for padding. The default is a space.
3213 :    
3214 :     =item RETURN
3215 : parrello 1.43
3216 : parrello 1.93 Returns a copy of the original string with the pad character added to the
3217 :     specified end so that it achieves the desired length.
3218 : parrello 1.43
3219 :     =back
3220 :    
3221 :     =cut
3222 :    
3223 : parrello 1.93 sub Pad {
3224 :     # Get the parameters.
3225 :     my ($string, $len, $left, $padChar) = @_;
3226 :     # Compute the padding character.
3227 :     if (! defined $padChar) {
3228 :     $padChar = " ";
3229 :     }
3230 :     # Compute the number of spaces needed.
3231 :     my $needed = $len - length $string;
3232 :     # Copy the string into the return variable.
3233 :     my $retVal = $string;
3234 :     # Only proceed if padding is needed.
3235 :     if ($needed > 0) {
3236 :     # Create the pad string.
3237 :     my $pad = $padChar x $needed;
3238 :     # Affix it to the return value.
3239 :     if ($left) {
3240 :     $retVal = $pad . $retVal;
3241 :     } else {
3242 :     $retVal .= $pad;
3243 : parrello 1.43 }
3244 : parrello 1.37 }
3245 : parrello 1.93 # Return the result.
3246 :     return $retVal;
3247 : parrello 1.37 }
3248 :    
3249 : parrello 1.93 =head3 EOF
3250 :    
3251 :     This is a constant that is lexically greater than any useful string.
3252 :    
3253 :     =cut
3254 :    
3255 :     sub EOF {
3256 :     return "\xFF\xFF\xFF\xFF\xFF";
3257 :     }
3258 : parrello 1.59
3259 : parrello 1.93 =head3 TICK
3260 : parrello 1.59
3261 : parrello 1.93 my @results = TICK($commandString);
3262 : parrello 1.59
3263 : parrello 1.93 Perform a back-tick operation on a command. If this is a Windows environment, any leading
3264 :     dot-slash (C<./> will be removed. So, for example, if you were doing
3265 : parrello 1.59
3266 : parrello 1.93 `./protein.cgi`
3267 : parrello 1.59
3268 : parrello 1.93 from inside a CGI script, it would work fine in Unix, but would issue an error message
3269 :     in Windows complaining that C<'.'> is not a valid command. If instead you code
3270 : parrello 1.59
3271 : parrello 1.93 TICK("./protein.cgi")
3272 : parrello 1.59
3273 : parrello 1.93 it will work correctly in both environments.
3274 : parrello 1.59
3275 : parrello 1.93 =over 4
3276 : parrello 1.59
3277 : parrello 1.93 =item commandString
3278 : parrello 1.59
3279 : parrello 1.93 The command string to pass to the system.
3280 : parrello 1.59
3281 :     =item RETURN
3282 :    
3283 : parrello 1.93 Returns the standard output from the specified command, as a list.
3284 : parrello 1.59
3285 :     =back
3286 :    
3287 :     =cut
3288 : parrello 1.93 #: Return Type @;
3289 :     sub TICK {
3290 : parrello 1.59 # Get the parameters.
3291 : parrello 1.93 my ($commandString) = @_;
3292 :     # Chop off the dot-slash if this is Windows.
3293 :     if ($FIG_Config::win_mode) {
3294 :     $commandString =~ s!^\./!!;
3295 : parrello 1.59 }
3296 : parrello 1.93 # Activate the command and return the result.
3297 :     return `$commandString`;
3298 : parrello 1.59 }
3299 :    
3300 : parrello 1.93
3301 : parrello 1.55 =head3 CommaFormat
3302 :    
3303 : parrello 1.92 my $formatted = Tracer::CommaFormat($number);
3304 : parrello 1.55
3305 :     Insert commas into a number.
3306 :    
3307 :     =over 4
3308 :    
3309 :     =item number
3310 :    
3311 :     A sequence of digits.
3312 :    
3313 :     =item RETURN
3314 :    
3315 :     Returns the same digits with commas strategically inserted.
3316 :    
3317 :     =back
3318 :    
3319 :     =cut
3320 :    
3321 :     sub CommaFormat {
3322 :     # Get the parameters.
3323 :     my ($number) = @_;
3324 :     # Pad the length up to a multiple of three.
3325 :     my $padded = "$number";
3326 :     $padded = " " . $padded while length($padded) % 3 != 0;
3327 :     # This is a fancy PERL trick. The parentheses in the SPLIT pattern
3328 :     # cause the delimiters to be included in the output stream. The
3329 :     # GREP removes the empty strings in between the delimiters.
3330 :     my $retVal = join(",", grep { $_ ne '' } split(/(...)/, $padded));
3331 :     # Clean out the spaces.
3332 :     $retVal =~ s/ //g;
3333 :     # Return the result.
3334 :     return $retVal;
3335 :     }
3336 : parrello 1.46
3337 :    
3338 : parrello 1.62 =head3 CompareLists
3339 :    
3340 : parrello 1.92 my ($inserted, $deleted) = Tracer::CompareLists(\@newList, \@oldList, $keyIndex);
3341 : parrello 1.62
3342 :     Compare two lists of tuples, and return a hash analyzing the differences. The lists
3343 :     are presumed to be sorted alphabetically by the value in the $keyIndex column.
3344 :     The return value contains a list of items that are only in the new list
3345 :     (inserted) and only in the old list (deleted).
3346 :    
3347 :     =over 4
3348 :    
3349 :     =item newList
3350 :    
3351 :     Reference to a list of new tuples.
3352 :    
3353 :     =item oldList
3354 :    
3355 :     Reference to a list of old tuples.
3356 :    
3357 :     =item keyIndex (optional)
3358 :    
3359 :     Index into each tuple of its key field. The default is 0.
3360 :    
3361 :     =item RETURN
3362 :    
3363 :     Returns a 2-tuple consisting of a reference to the list of items that are only in the new
3364 :     list (inserted) followed by a reference to the list of items that are only in the old
3365 :     list (deleted).
3366 :    
3367 :     =back
3368 :    
3369 :     =cut
3370 :    
3371 :     sub CompareLists {
3372 :     # Get the parameters.
3373 :     my ($newList, $oldList, $keyIndex) = @_;
3374 :     if (! defined $keyIndex) {
3375 :     $keyIndex = 0;
3376 :     }
3377 :     # Declare the return variables.
3378 :     my ($inserted, $deleted) = ([], []);
3379 :     # Loop through the two lists simultaneously.
3380 :     my ($newI, $oldI) = (0, 0);
3381 :     my ($newN, $oldN) = (scalar @{$newList}, scalar @{$oldList});
3382 :     while ($newI < $newN || $oldI < $oldN) {
3383 :     # Get the current object in each list. Note that if one
3384 :     # of the lists is past the end, we'll get undef.
3385 :     my $newItem = $newList->[$newI];
3386 :     my $oldItem = $oldList->[$oldI];
3387 : parrello 1.63 if (! defined($newItem) || defined($oldItem) && $newItem->[$keyIndex] gt $oldItem->[$keyIndex]) {
3388 : parrello 1.62 # The old item is not in the new list, so mark it deleted.
3389 :     push @{$deleted}, $oldItem;
3390 :     $oldI++;
3391 :     } elsif (! defined($oldItem) || $oldItem->[$keyIndex] gt $newItem->[$keyIndex]) {
3392 :     # The new item is not in the old list, so mark it inserted.
3393 :     push @{$inserted}, $newItem;
3394 :     $newI++;
3395 :     } else {
3396 :     # The item is in both lists, so push forward.
3397 :     $oldI++;
3398 :     $newI++;
3399 :     }
3400 :     }
3401 :     # Return the result.
3402 :     return ($inserted, $deleted);
3403 :     }
3404 :    
3405 : parrello 1.105 =head3 Cmp
3406 :    
3407 :     my $cmp = Tracer::Cmp($a, $b);
3408 :    
3409 :     This method performs a universal sort comparison. Each value coming in is
3410 :     separated into a leading text part and a trailing number part. The text
3411 :     part is string compared, and if both parts are equal, then the number
3412 :     parts are compared numerically. A stream of just numbers or a stream of
3413 :     just strings will sort correctly, and a mixed stream will sort with the
3414 :     numbers first. Strings with a label and a number will sort in the
3415 :     expected manner instead of lexically.
3416 :    
3417 :     =over 4
3418 :    
3419 :     =item a
3420 :    
3421 :     First item to compare.
3422 :    
3423 :     =item b
3424 :    
3425 :     Second item to compare.
3426 :    
3427 :     =item RETURN
3428 :    
3429 :     Returns a negative number if the first item should sort first (is less), a positive
3430 :     number if the first item should sort second (is greater), and a zero if the items are
3431 :     equal.
3432 :    
3433 :     =back
3434 :    
3435 :     =cut
3436 :    
3437 :     sub Cmp {
3438 :     # Get the parameters.
3439 :     my ($a, $b) = @_;
3440 :     # Declare the return value.
3441 :     my $retVal;
3442 :     # Check for nulls.
3443 :     if (! defined($a)) {
3444 :     $retVal = (! defined($b) ? 0 : -1);
3445 :     } elsif (! defined($b)) {
3446 :     $retVal = 1;
3447 :     } else {
3448 :     # Here we have two real values. Parse the two strings.
3449 :     $a =~ /^(\D*)(\d*)$/;
3450 :     my $aParsed = [$1, $2];
3451 :     $b =~ /^(\D*)(\d*)$/;
3452 :     my $bParsed = [$1, $2];
3453 :     # Compare the string parts.
3454 :     $retVal = $aParsed->[0] cmp $bParsed->[0];
3455 :     if (! $retVal) {
3456 :     $retVal = $aParsed->[1] <=> $bParsed->[1];
3457 :     }
3458 :     }
3459 :     # Return the result.
3460 :     return $retVal;
3461 :     }
3462 :    
3463 : parrello 1.108 =head3 ListEQ
3464 :    
3465 :     my $flag = Tracer::ListEQ(\@a, \@b);
3466 :    
3467 :     Return TRUE if the specified lists contain the same strings in the same
3468 :     order, else FALSE.
3469 :    
3470 :     =over 4
3471 :    
3472 :     =item a
3473 :    
3474 :     Reference to the first list.
3475 :    
3476 :     =item b
3477 :    
3478 :     Reference to the second list.
3479 :    
3480 :     =item RETURN
3481 :    
3482 :     Returns TRUE if the two parameters are identical string lists, else FALSE.
3483 :    
3484 :     =back
3485 :    
3486 :     =cut
3487 :    
3488 :     sub ListEQ {
3489 :     # Get the parameters.
3490 :     my ($a, $b) = @_;
3491 :     # Declare the return variable. Start by checking the lengths.
3492 :     my $n = scalar(@$a);
3493 :     my $retVal = ($n == scalar(@$b));
3494 :     # Now compare the list elements.
3495 :     for (my $i = 0; $retVal && $i < $n; $i++) {
3496 :     $retVal = ($a->[$i] eq $b->[$i]);
3497 :     }
3498 :     # Return the result.
3499 :     return $retVal;
3500 :     }
3501 :    
3502 : parrello 1.105 =head2 CGI Script Utilities
3503 :    
3504 :     =head3 ScriptSetup (deprecated)
3505 :    
3506 :     my ($cgi, $varHash) = ScriptSetup($noTrace);
3507 :    
3508 :     Perform standard tracing and debugging setup for scripts. The value returned is
3509 :     the CGI object followed by a pre-built variable hash. At the end of the script,
3510 :     the client should call L</ScriptFinish> to output the web page.
3511 :    
3512 :     This method calls L</ETracing> to configure tracing, which allows the tracing
3513 :     to be configured via the emergency tracing form on the debugging control panel.
3514 :     Tracing will then be turned on automatically for all programs that use the L</ETracing>
3515 :     method, which includes every program that uses this method or L</StandardSetup>.
3516 :    
3517 :     =over 4
3518 :    
3519 :     =item noTrace (optional)
3520 :    
3521 :     If specified, tracing will be suppressed. This is useful if the script wants to set up
3522 :     tracing manually.
3523 :    
3524 :     =item RETURN
3525 :    
3526 :     Returns a two-element list consisting of a CGI query object and a variable hash for
3527 :     the output page.
3528 :    
3529 :     =back
3530 :    
3531 :     =cut
3532 :    
3533 :     sub ScriptSetup {
3534 :     # Get the parameters.
3535 :     my ($noTrace) = @_;
3536 :     # Get the CGI query object.
3537 :     my $cgi = CGI->new();
3538 :     # Set up tracing if it's not suppressed.
3539 :     ETracing($cgi) unless $noTrace;
3540 :     # Create the variable hash.
3541 :     my $varHash = { results => '' };
3542 :     # Return the query object and variable hash.
3543 :     return ($cgi, $varHash);
3544 :     }
3545 :    
3546 :     =head3 ScriptFinish (deprecated)
3547 :    
3548 :     ScriptFinish($webData, $varHash);
3549 :    
3550 :     Output a web page at the end of a script. Either the string to be output or the
3551 :     name of a template file can be specified. If the second parameter is omitted,
3552 :     it is assumed we have a string to be output; otherwise, it is assumed we have the
3553 :     name of a template file. The template should have the variable C<DebugData>
3554 :     specified in any form that invokes a standard script. If debugging mode is turned
3555 :     on, a form field will be put in that allows the user to enter tracing data.
3556 :     Trace messages will be placed immediately before the terminal C<BODY> tag in
3557 :     the output, formatted as a list.
3558 :    
3559 :     A typical standard script would loook like the following.
3560 :    
3561 :     BEGIN {
3562 :     # Print the HTML header.
3563 :     print "CONTENT-TYPE: text/html\n\n";
3564 :     }
3565 :     use Tracer;
3566 :     use CGI;
3567 :     use FIG;
3568 :     # ... more uses ...
3569 :    
3570 :     my ($cgi, $varHash) = ScriptSetup();
3571 :     eval {
3572 :     # ... get data from $cgi, put it in $varHash ...
3573 :     };
3574 :     if ($@) {
3575 :     Trace("Script Error: $@") if T(0);
3576 :     }
3577 :     ScriptFinish("Html/MyTemplate.html", $varHash);
3578 :    
3579 :     The idea here is that even if the script fails, you'll see trace messages and
3580 :     useful output.
3581 :    
3582 :     =over 4
3583 :    
3584 :     =item webData
3585 :    
3586 :     A string containing either the full web page to be written to the output or the
3587 :     name of a template file from which the page is to be constructed. If the name
3588 :     of a template file is specified, then the second parameter must be present;
3589 :     otherwise, it must be absent.
3590 :    
3591 :     =item varHash (optional)
3592 :    
3593 :     If specified, then a reference to a hash mapping variable names for a template
3594 :     to their values. The template file will be read into memory, and variable markers
3595 :     will be replaced by data in this hash reference.
3596 :    
3597 :     =back
3598 :    
3599 :     =cut
3600 :    
3601 :     sub ScriptFinish {
3602 :     # Get the parameters.
3603 :     my ($webData, $varHash) = @_;
3604 :     # Check for a template file situation.
3605 :     my $outputString;
3606 :     if (defined $varHash) {
3607 :     # Here we have a template file. We need to determine the template type.
3608 :     my $template;
3609 :     if ($FIG_Config::template_url && $webData =~ /\.php$/) {
3610 :     $template = "$FIG_Config::template_url/$webData";
3611 :     } else {
3612 :     $template = "<<$webData";
3613 :     }
3614 :     $outputString = PageBuilder::Build($template, $varHash, "Html");
3615 :     } else {
3616 :     # Here the user gave us a raw string.
3617 :     $outputString = $webData;
3618 :     }
3619 :     # Check for trace messages.
3620 :     if ($Destination ne "NONE" && $TraceLevel > 0) {
3621 :     # We have trace messages, so we want to put them at the end of the body. This
3622 :     # is either at the end of the whole string or at the beginning of the BODY
3623 :     # end-tag.
3624 :     my $pos = length $outputString;
3625 :     if ($outputString =~ m#</body>#gi) {
3626 :     $pos = (pos $outputString) - 7;
3627 :     }
3628 :     # If the trace messages were queued, we unroll them. Otherwise, we display the
3629 :     # destination.
3630 :     my $traceHtml;
3631 :     if ($Destination eq "QUEUE") {
3632 :     $traceHtml = QTrace('Html');
3633 :     } elsif ($Destination =~ /^>>(.+)$/) {
3634 :     # Here the tracing output it to a file. We code it as a hyperlink so the user
3635 :     # can copy the file name into the clipboard easily.
3636 :     my $actualDest = $1;
3637 :     $traceHtml = "<p>Tracing output to $actualDest.</p>\n";
3638 :     } else {
3639 :     # Here we have one of the special destinations.
3640 :     $traceHtml = "<P>Tracing output type is $Destination.</p>\n";
3641 :     }
3642 :     substr $outputString, $pos, 0, $traceHtml;
3643 :     }
3644 :     # Write the output string.
3645 :     print $outputString;
3646 :     }
3647 :    
3648 : parrello 1.65 =head3 GenerateURL
3649 :    
3650 : parrello 1.92 my $queryUrl = Tracer::GenerateURL($page, %parameters);
3651 : parrello 1.65
3652 :     Generate a GET-style URL for the specified page with the specified parameter
3653 :     names and values. The values will be URL-escaped automatically. So, for
3654 :     example
3655 :    
3656 :     Tracer::GenerateURL("form.cgi", type => 1, string => "\"high pass\" or highway")
3657 :    
3658 :     would return
3659 :    
3660 : parrello 1.79 form.cgi?type=1;string=%22high%20pass%22%20or%20highway
3661 : parrello 1.65
3662 :     =over 4
3663 :    
3664 :     =item page
3665 :    
3666 :     Page URL.
3667 :    
3668 :     =item parameters
3669 :    
3670 :     Hash mapping parameter names to parameter values.
3671 :    
3672 :     =item RETURN
3673 :    
3674 :     Returns a GET-style URL that goes to the specified page and passes in the
3675 :     specified parameters and values.
3676 :    
3677 :     =back
3678 :    
3679 :     =cut
3680 :    
3681 :     sub GenerateURL {
3682 :     # Get the parameters.
3683 :     my ($page, %parameters) = @_;
3684 :     # Prime the return variable with the page URL.
3685 :     my $retVal = $page;
3686 :     # Loop through the parameters, creating parameter elements in a list.
3687 :     my @parmList = map { "$_=" . uri_escape($parameters{$_}) } keys %parameters;
3688 :     # If the list is nonempty, tack it on.
3689 :     if (@parmList) {
3690 : parrello 1.79 $retVal .= "?" . join(";", @parmList);
3691 : parrello 1.65 }
3692 :     # Return the result.
3693 :     return $retVal;
3694 :     }
3695 :    
3696 : parrello 1.78 =head3 ApplyURL
3697 :    
3698 : parrello 1.92 Tracer::ApplyURL($table, $target, $url);
3699 : parrello 1.78
3700 :     Run through a two-dimensional table (or more accurately, a list of lists), converting the
3701 :     I<$target> column to HTML text having a hyperlink to a URL in the I<$url> column. The
3702 :     URL column will be deleted by this process and the target column will be HTML-escaped.
3703 :    
3704 :     This provides a simple way to process the results of a database query into something
3705 :     displayable by combining a URL with text.
3706 :    
3707 :     =over 4
3708 :    
3709 :     =item table
3710 :    
3711 :     Reference to a list of lists. The elements in the containing list will be updated by
3712 :     this method.
3713 :    
3714 :     =item target
3715 :    
3716 :     The index of the column to be converted into HTML.
3717 :    
3718 :     =item url
3719 :    
3720 :     The index of the column containing the URL. Note that the URL must have a recognizable
3721 :     C<http:> at the beginning.
3722 :    
3723 :     =back
3724 :    
3725 :     =cut
3726 :    
3727 :     sub ApplyURL {
3728 :     # Get the parameters.
3729 :     my ($table, $target, $url) = @_;
3730 :     # Loop through the table.
3731 :     for my $row (@{$table}) {
3732 :     # Apply the URL to the target cell.
3733 :     $row->[$target] = CombineURL($row->[$target], $row->[$url]);
3734 :     # Delete the URL from the row.
3735 :     delete $row->[$url];
3736 :     }
3737 :     }
3738 :    
3739 :     =head3 CombineURL
3740 :    
3741 : parrello 1.92 my $combinedHtml = Tracer::CombineURL($text, $url);
3742 : parrello 1.78
3743 :     This method will convert the specified text into HTML hyperlinked to the specified
3744 :     URL. The hyperlinking will only take place if the URL looks legitimate: that is, it
3745 :     is defined and begins with an C<http:> header.
3746 :    
3747 :     =over 4
3748 :    
3749 :     =item text
3750 :    
3751 :     Text to return. This will be HTML-escaped automatically.
3752 :    
3753 :     =item url
3754 :    
3755 :     A URL to be hyperlinked to the text. If it does not look like a URL, then the text
3756 :     will be returned without any hyperlinking.
3757 :    
3758 :     =item RETURN
3759 :    
3760 :     Returns the original text, HTML-escaped, with the URL hyperlinked to it. If the URL
3761 :     doesn't look right, the HTML-escaped text will be returned without any further
3762 :     modification.
3763 :    
3764 :     =back
3765 :    
3766 :     =cut
3767 :    
3768 :     sub CombineURL {
3769 :     # Get the parameters.
3770 :     my ($text, $url) = @_;
3771 :     # Declare the return variable.
3772 :     my $retVal = CGI::escapeHTML($text);
3773 :     # Verify the URL.
3774 :     if (defined($url) && $url =~ m!http://!i) {
3775 :     # It's good, so we apply it to the text.
3776 :     $retVal = "<a href=\"$url\">$retVal</a>";
3777 :     }
3778 :     # Return the result.
3779 :     return $retVal;
3780 :     }
3781 :    
3782 : parrello 1.97 =head3 TrackingCode
3783 :    
3784 :     my $html = Tracer::TrackingCode();
3785 :    
3786 :     Returns the HTML code for doing web page traffic monitoring. If the
3787 :     current environment is a test system, then it returns a null string;
3788 :     otherwise, it returns a bunch of javascript containing code for turning
3789 :     on SiteMeter and Google Analytics.
3790 :    
3791 :     =cut
3792 :    
3793 :     sub TrackingCode {
3794 :     # Declare the return variable.
3795 :     my $retVal = "<!-- tracking off -->";
3796 :     # Determine if we're in production.
3797 :     if ($FIG_Config::site_meter) {
3798 :     $retVal = <<END_HTML
3799 :     <!-- Site Meter -->
3800 :     <script type="text/javascript" src="http://s20.sitemeter.com/js/counter.js?site=s20nmpdr">
3801 :     </script>
3802 :     <noscript>
3803 :     <a href="http://s20.sitemeter.com/stats.asp?site=s20nmpdr" target="_top">
3804 :     <img src="http://s20.sitemeter.com/meter.asp?site=s20nmpdr" alt="Site Meter" border="0"/></a>
3805 :     </noscript>
3806 :     <!-- Copyright (c)2006 Site Meter -->
3807 :     END_HTML
3808 :     }
3809 :     return $retVal;
3810 :     }
3811 :    
3812 : parrello 1.105 =head3 Clean
3813 :    
3814 :     my $cleaned = Tracer::Clean($string);
3815 :    
3816 :     Clean up a string for HTML display. This not only converts special
3817 :     characters to HTML entity names, it also removes control characters.
3818 :    
3819 :     =over 4
3820 :    
3821 :     =item string
3822 :    
3823 :     String to convert.
3824 :    
3825 :     =item RETURN
3826 :    
3827 :     Returns the input string with anything that might disrupt an HTML literal removed. An
3828 :     undefined value will be converted to an empty string.
3829 :    
3830 :     =back
3831 :    
3832 :     =cut
3833 :    
3834 :     sub Clean {
3835 :     # Get the parameters.
3836 :     my ($string) = @_;
3837 :     # Declare the return variable.
3838 :     my $retVal = "";
3839 :     # Only proceed if the value exists.
3840 :     if (defined $string) {
3841 :     # Get the string.
3842 :     $retVal = $string;
3843 :     # Clean the control characters.
3844 :     $retVal =~ tr/\x00-\x1F/?/;
3845 :     # Escape the rest.
3846 :     $retVal = CGI::escapeHTML($retVal);
3847 :     }
3848 :     # Return the result.
3849 :     return $retVal;
3850 :     }
3851 :    
3852 :    
3853 :    
3854 : parrello 1.97
3855 : olson 1.88 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3