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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : efrank 1.1 package FIG;
2 :    
3 : olson 1.111 use strict;
4 :    
5 : overbeek 1.135 use Fcntl qw/:flock/; # import LOCK_* constants
6 :    
7 : olson 1.116 use POSIX;
8 : olson 1.158 use IPC::Open2;
9 : olson 1.116
10 : efrank 1.1 use DBrtns;
11 :     use Sim;
12 :     use Blast;
13 :     use FIG_Config;
14 : overbeek 1.36 use tree_utilities;
15 : olson 1.93 use Subsystem;
16 : olson 1.162 use SeedDas;
17 : olson 1.79
18 :     #
19 :     # Conditionally evaluate this in case its prerequisites are not available.
20 :     #
21 :    
22 :     our $ClearinghouseOK = eval {
23 :     require Clearinghouse;
24 :     };
25 : efrank 1.1
26 : olson 1.10 use IO::Socket;
27 :    
28 : efrank 1.1 use FileHandle;
29 :    
30 :     use Carp;
31 :     use Data::Dumper;
32 : overbeek 1.25 use Time::Local;
33 : olson 1.93 use File::Spec;
34 : olson 1.123 use File::Copy;
35 : olson 1.112 #
36 :     # Try to load the RPC stuff; it might fail on older versions of the software.
37 :     #
38 :     eval {
39 :     require FIGrpc;
40 :     };
41 :    
42 :     my $xmlrpc_available = 1;
43 :     if ($@ ne "")
44 :     {
45 :     $xmlrpc_available = 0;
46 :     }
47 :    
48 : efrank 1.1
49 : olson 1.111 use FIGAttributes;
50 :     use base 'FIGAttributes';
51 :    
52 :     use vars qw(%_FunctionAttributes);
53 :    
54 :     use Data::Dumper;
55 :    
56 : olson 1.124 #
57 :     # Force all new files to be all-writable.
58 :     #
59 :    
60 :     umask 0;
61 :    
62 : efrank 1.1 sub new {
63 :     my($class) = @_;
64 :    
65 : olson 1.102 #
66 :     # Check to see if we have a FIG_URL environment variable set.
67 :     # If we do, don't actually create a FIG object, but rather
68 :     # create a FIGrpc and return that as the return from this constructor.
69 :     #
70 :    
71 : olson 1.112 if ($ENV{FIG_URL} ne "" && $xmlrpc_available)
72 : olson 1.102 {
73 : olson 1.103 print "Creating figrpc for '$ENV{FIG_URL}'\n";
74 : olson 1.102 my $figrpc = new FIGrpc($ENV{FIG_URL});
75 :     return $figrpc;
76 :     }
77 :    
78 : efrank 1.1 my $rdbH = new DBrtns;
79 :     bless {
80 :     _dbf => $rdbH,
81 :     }, $class;
82 :     }
83 :    
84 :     sub DESTROY {
85 :     my($self) = @_;
86 :     my($rdbH);
87 :    
88 :     if ($rdbH = $self->db_handle)
89 :     {
90 :     $rdbH->DESTROY;
91 :     }
92 :     }
93 :    
94 : overbeek 1.7 sub delete_genomes {
95 :     my($self,$genomes) = @_;
96 :     my $tmpD = "$FIG_Config::temp/tmp.deleted.$$";
97 :     my $tmp_Data = "$FIG_Config::temp/Data.$$";
98 :    
99 :     my %to_del = map { $_ => 1 } @$genomes;
100 :     open(TMP,">$tmpD") || die "could not open $tmpD";
101 :    
102 :     my $genome;
103 :     foreach $genome ($self->genomes)
104 :     {
105 :     if (! $to_del{$genome})
106 :     {
107 :     print TMP "$genome\n";
108 :     }
109 :     }
110 :     close(TMP);
111 :    
112 :     &run("extract_genomes $tmpD $FIG_Config::data $tmp_Data");
113 : overbeek 1.47
114 :     # &run("mv $FIG_Config::data $FIG_Config::data.deleted; mv $tmp_Data $FIG_Config::data; fig load_all; rm -rf $FIG_Config::data.deleted");
115 :    
116 :     &run("mv $FIG_Config::data $FIG_Config::data.deleted");
117 :     &run("mv $tmp_Data $FIG_Config::data");
118 :     &run("fig load_all");
119 :     &run("rm -rf $FIG_Config::data.deleted");
120 : overbeek 1.7 }
121 :    
122 : efrank 1.1 sub add_genome {
123 :     my($self,$genomeF) = @_;
124 :    
125 :     my $rc = 0;
126 : olson 1.93
127 :     my(undef, $path, $genome) = File::Spec->splitpath($genomeF);
128 :    
129 :     if ($genome !~ /^\d+\.\d+$/)
130 :     {
131 :     warn "Invalid genome filename $genomeF\n";
132 :     return $rc;
133 :     }
134 :    
135 :     if (-d $FIG_Config::organisms/$genome)
136 :     {
137 :     warn "Organism already exists for $genome\n";
138 :     return $rc;
139 :     }
140 :    
141 :    
142 :     #
143 :     # We're okay, it doesn't exist.
144 :     #
145 :    
146 :     my @errors = `$FIG_Config::bin/verify_genome_directory $genomeF`;
147 :    
148 :     if (@errors)
149 : efrank 1.1 {
150 : olson 1.93 warn "Errors found while verifying genome directory $genomeF:\n";
151 :     print join("", @errors);
152 :     return $rc;
153 :     }
154 :    
155 :     &run("cp -r $genomeF $FIG_Config::organisms");
156 :     &run("chmod -R 777 $FIG_Config::organisms/$genome");
157 :    
158 :     &run("index_contigs $genome");
159 :     &run("compute_genome_counts $genome");
160 :     &run("load_features $genome");
161 :    
162 :     $rc = 1;
163 :     if (-s "$FIG_Config::organisms/$genome/Features/peg/fasta")
164 :     {
165 :     &run("index_translations $genome");
166 :     my @tmp = `cut -f1 $FIG_Config::organisms/$genome/Features/peg/tbl`;
167 :     chomp @tmp;
168 :     &run("cat $FIG_Config::organisms/$genome/Features/peg/fasta >> $FIG_Config::data/Global/nr");
169 :     &enqueue_similarities(\@tmp);
170 :     }
171 :     if ((-s "$FIG_Config::organisms/$genome/assigned_functions") ||
172 :     (-d "$FIG_Config::organisms/$genome/UserModels"))
173 :     {
174 :     &run("add_assertions_of_function $genome");
175 : efrank 1.1 }
176 : olson 1.93
177 : efrank 1.1 return $rc;
178 :     }
179 :    
180 : olson 1.93 =pod
181 :    
182 :     =head1 enqueue_similarities
183 :    
184 :     usage: enqueue_similarities(\@sims)
185 :    
186 :     Queue the passed fids (a reference to a list) for similarity
187 :     computation.
188 :    
189 :     =cut
190 :     sub enqueue_similarities {
191 : efrank 1.1 my($fids) = @_;
192 :     my $fid;
193 :    
194 : olson 1.93 my $sim_q = "$FIG_Config::global/queued_similarities";
195 :    
196 :     open(TMP,">>$sim_q")
197 :     || die "could not open $sim_q";
198 :    
199 :     #
200 :     # We need to lock here so that if a computation is creating a snapshot of the
201 :     # queue, we block until it's done.
202 :     #
203 :    
204 :     flock(TMP, LOCK_EX) or die "Cannot lock $sim_q\n";
205 :    
206 : efrank 1.1 foreach $fid (@$fids)
207 :     {
208 :     print TMP "$fid\n";
209 :     }
210 :     close(TMP);
211 : olson 1.10 }
212 :    
213 : olson 1.93 =pod
214 :    
215 :     =head1 create_sim_askfor_pool
216 :    
217 :     usage: create_sim_askfor_pool()
218 :    
219 : olson 1.123 Creates an askfor pool, a snapshot of the current NR and similarity
220 :     queue. Zeros out the old queue.
221 :    
222 :     The askfor pool needs to keep track of which sequences need to be
223 :     calculated, which have been handed out, etc. To simplify this task we
224 :     chunk the sequences into fairly small numbers (10-20 sequences) and
225 :     allocate work on a per-chunk basis. We make use of the relational
226 :     database to keep track of chunk status as well as the seek locations
227 :     into the file of sequence data. The initial creation of the pool
228 :     involves indexing the sequence data with seek offsets and lengths and
229 :     populating the sim_askfor_index table with this information and with
230 :     initial status information.
231 : olson 1.93
232 :     =cut
233 :    
234 :     sub create_sim_askfor_pool
235 :     {
236 : olson 1.123 my($self, $chunk_size) = @_;
237 :    
238 :     $chunk_size = 15 unless $chunk_size =~ /^\d+$/;
239 : olson 1.93
240 :     my $pool_dir = "$FIG_Config::global/sim_pools";
241 :     &verify_dir($pool_dir);
242 :    
243 :     #
244 :     # Lock the pool directory.
245 :     #
246 :     open(my $lock, ">$pool_dir/lockfile");
247 :    
248 :     flock($lock, LOCK_EX);
249 :    
250 :     my $num = 0;
251 :     if (open(my $toc, "<$pool_dir/TOC"))
252 :     {
253 :     while (<$toc>)
254 :     {
255 :     chomp;
256 : olson 1.123 # print STDERR "Have toc entry $_\n";
257 : olson 1.93 my ($idx, $time, $str) = split(/\s+/, $_, 3);
258 :    
259 :     $num = max($num, $idx);
260 :     }
261 :     close($toc);
262 :     }
263 :     $num++;
264 :     open(my $toc, ">>$pool_dir/TOC") or die "Cannot write $pool_dir/TOC: $!\n";
265 :    
266 :     print $toc "$num ", time(), " New toc entry\n";
267 :     close($toc);
268 :    
269 : olson 1.123 my $cpool_id = sprintf "%04d", $num;
270 :     my $cpool_dir = "$pool_dir/$cpool_id";
271 : olson 1.93
272 :     #
273 :     # All set, create the directory for this pool.
274 :     #
275 :    
276 :     &verify_dir($cpool_dir);
277 :    
278 :     #
279 :     # Now we can copy the nr and sim queue here.
280 :     # Do this stuff inside an eval so we can clean up
281 :     # the lockfile.
282 :     #
283 :    
284 :     eval {
285 :     my $sim_q = "$FIG_Config::global/queued_similarities";
286 :    
287 : olson 1.123 copy("$sim_q", "$cpool_dir/q");
288 :     copy("$FIG_Config::data/Global/nr", "$cpool_dir/nr");
289 : olson 1.93
290 :     open(F, ">$sim_q") or die "Cannot open $sim_q to truncate it: $!\n";
291 :     close(F);
292 :     };
293 :    
294 :     unlink("$pool_dir/lockfile");
295 :     close($lock);
296 : olson 1.123
297 :     #
298 :     # We've created our pool; we can now run the formatdb and
299 :     # extract the sequences for the blast run.
300 :     #
301 :     my $child_pid = $self->run_in_background(sub {
302 :     #
303 :     # Need to close db or there's all sorts of trouble.
304 :     #
305 :    
306 :     my $cmd = "$FIG_Config::ext_bin/formatdb -i $cpool_dir/nr -p T -l $cpool_dir/formatdb.log";
307 :     print "Will run '$cmd'\n";
308 :     &run($cmd);
309 :     print "finished. Logfile:\n";
310 :     print &FIG::file_read("$cpool_dir/formatdb.log");
311 :     unlink("$cpool_dir/formatdb.pid");
312 :     });
313 :     print "Running formatdb in background job $child_pid\n";
314 :     open(FPID, ">$cpool_dir/formatdb.pid");
315 :     print FPID "$child_pid\n";
316 :     close(FPID);
317 :    
318 :     my $db = $self->db_handle();
319 :     if (!$db->table_exists("sim_queue"))
320 :     {
321 :     $db->create_table(tbl => "sim_queue",
322 :     flds => "qid varchar(32), chunk_id INTEGER, seek INTEGER, len INTEGER, " .
323 :     "assigned BOOL, finished BOOL, output_file varchar(255), " .
324 :     "assignment_expires INTEGER, worker_info varchar(255)"
325 :     );
326 :     }
327 :    
328 :     #
329 :     # Write the fasta input file. Keep track of how many have been written,
330 :     # and write seek info into the database as appropriate.
331 :     #
332 :    
333 :     open(my $seq_fh, ">$cpool_dir/fasta.in");
334 :    
335 :     my($chunk_idx, $chunk_begin, $seq_idx);
336 :    
337 :     $chunk_idx = 0;
338 :     $chunk_begin = 0;
339 :     $seq_idx = 0;
340 :    
341 :     my(@seeks);
342 :    
343 :     open(my $q_fh, "<$cpool_dir/q");
344 :     while (my $id = <$q_fh>)
345 :     {
346 :     chomp $id;
347 :    
348 :     my $seq = $self->get_translation($id);
349 :    
350 :     #
351 :     # check if we're at the beginning of a chunk
352 :     #
353 :    
354 :     print $seq_fh ">$id\n$seq\n";
355 :    
356 :     #
357 :     # Check if we're at the end of a chunk
358 :     #
359 :    
360 :     if ((($seq_idx + 1) % $chunk_size) == 0)
361 :     {
362 :     my $chunk_end = tell($seq_fh);
363 :     my $chunk_len = $chunk_end - $chunk_begin;
364 :    
365 :     push(@seeks, [$cpool_id, $chunk_idx, $chunk_begin, $chunk_len]);
366 :     $chunk_idx++;
367 :     $chunk_begin = $chunk_end;
368 :     }
369 :     $seq_idx++;
370 :     }
371 :    
372 :     if ((($seq_idx) % $chunk_size) != 0)
373 :     {
374 :     my $chunk_end = tell($seq_fh);
375 :     my $chunk_len = $chunk_end - $chunk_begin;
376 :    
377 :     push(@seeks, [$cpool_id, $chunk_idx, $chunk_begin, $chunk_len]);
378 :    
379 :     $chunk_idx++;
380 :     $chunk_begin = $chunk_end;
381 :     }
382 :    
383 :     close($q_fh);
384 :     close($seq_fh);
385 :    
386 :     print "Write seqs\n";
387 :    
388 :     for my $seek (@seeks)
389 :     {
390 :     my($cpool_id, $chunk_idx, $chunk_begin, $chunk_len) = @$seek;
391 :    
392 :     $db->SQL("insert into sim_queue (qid, chunk_id, seek, len, assigned, finished) " .
393 :     "values('$cpool_id', $chunk_idx, $chunk_begin, $chunk_len, FALSE, FALSE)");
394 :     }
395 : olson 1.93
396 : olson 1.123 return $cpool_id;
397 :     }
398 :    
399 :     =pod
400 :    
401 :     =head1 get_sim_queue
402 :    
403 :     usage: get_sim_queue($pool_id, $all_sims)
404 :    
405 :     Returns the sims in the given pool. If $all_sims is true, return the entire queue. Otherwise,
406 :     just return the sims awaiting processing.
407 :    
408 :     =cut
409 :    
410 :     sub get_sim_queue
411 :     {
412 :     my($self, $pool_id, $all_sims) = @_;
413 :     }
414 :    
415 :     =pod
416 :    
417 :     =head1 get_active_sim_pools
418 :    
419 :     usage: get_active_sim_pools()
420 :    
421 :     Return a list of the pool id's for the sim processing queues that have entries awaiting
422 :     computation.
423 :    
424 :     =cut
425 :    
426 :     sub get_active_sim_pools
427 :     {
428 :     my($self) = @_;
429 :    
430 :     my $dbh = $self->db_handle();
431 :    
432 :     my $res = $dbh->SQL("select distinct qid from sim_queue where not finished");
433 :     return undef unless $res;
434 :    
435 :     return map { $_->[0] } @$res;
436 :     }
437 :    
438 :     =pod
439 :    
440 :     =head1 get_sim_pool_info
441 :    
442 :     usage: get_sim_pool_info($pool_id)
443 :    
444 :     Return information about the given sim pool. Return value
445 :     is a list ($total_entries, $n_finished, $n_assigned, $n_unassigned)
446 :    
447 :     =cut
448 :    
449 :     sub get_sim_pool_info
450 :     {
451 :     my($self, $pool_id) = @_;
452 :     my($dbh, $res, $total_entries, $n_finished, $n_assigned, $n_unassigned);
453 :    
454 :     $dbh = $self->db_handle();
455 :    
456 :     $res = $dbh->SQL("select count(chunk_id) from sim_queue where qid = '$pool_id'");
457 :     $total_entries = $res->[0]->[0];
458 :    
459 :     $res = $dbh->SQL("select count(chunk_id) from sim_queue where qid = '$pool_id' and finished");
460 :     $n_finished = $res->[0]->[0];
461 :    
462 :     $res = $dbh->SQL("select count(chunk_id) from sim_queue where qid = '$pool_id' and assigned and not finished");
463 :     $n_assigned = $res->[0]->[0];
464 :    
465 :     $res = $dbh->SQL("select count(chunk_id) from sim_queue where qid = '$pool_id' and not finished and not assigned");
466 :     $n_unassigned = $res->[0]->[0];
467 :    
468 :     return ($total_entries, $n_finished, $n_assigned, $n_unassigned);
469 : olson 1.93 }
470 :    
471 :     =pod
472 :    
473 :     =head1 get_sim_chunk
474 :    
475 :     usage: get_sim_chunk($n_seqs, $worker_id)
476 :    
477 :     Returns a chunk of $n_seqs of work.
478 :    
479 : olson 1.123 From Ross, about how sims are processed:
480 :    
481 :     Here is how I process them:
482 :    
483 :    
484 :     bash$ cd /Volumes/seed/olson/Sims/June22.out
485 :     bash$ for i in really*
486 :     > do
487 :     > cat < $i >> /Volumes/laptop/new.sims
488 :     > done
489 :    
490 :    
491 :     Then, I need to "reformat" them by adding to columns to each one
492 :     and split the result into files of about 3M each This I do using
493 :    
494 :     reduce_sims /Volumes/laptop/NR/NewNR/peg.synonyms.june21 300 < /Volumes/laptop/new.sims |
495 :     reformat_sims /Volumes/laptop/NR/NewNR/checked.nr.june21 > /Volumes/laptop/reformated.sims
496 :     rm /Volumes/laptop/new.sims
497 :     split_sims /Volumes/laptop/NewSims sims.june24 reformated.sims
498 :     rm reformatted.sims
499 :    
500 :    
501 : olson 1.93 =cut
502 :     sub get_sim_chunk
503 :     {
504 :     my($self, $n_seqs, $worker_id) = @_;
505 :    
506 :    
507 :     }
508 :    
509 : olson 1.10 sub get_local_hostname {
510 : olson 1.52
511 :     #
512 :     # See if there is a FIGdisk/config/hostname file. If there
513 :     # is, force the hostname to be that.
514 :     #
515 :    
516 :     my $hostfile = "$FIG_Config::fig_disk/config/hostname";
517 :     if (-f $hostfile)
518 :     {
519 :     my $fh;
520 :     if (open($fh, $hostfile))
521 :     {
522 :     my $hostname = <$fh>;
523 :     chomp($hostname);
524 :     return $hostname;
525 :     }
526 :     }
527 :    
528 : olson 1.10 #
529 :     # First check to see if we our hostname is correct.
530 :     #
531 :     # Map it to an IP address, and try to bind to that ip.
532 :     #
533 :    
534 :     my $tcp = getprotobyname('tcp');
535 :    
536 :     my $hostname = `hostname`;
537 : golsen 1.44 chomp($hostname);
538 : olson 1.10
539 :     my @hostent = gethostbyname($hostname);
540 :    
541 :     if (@hostent > 0)
542 :     {
543 :     my $sock;
544 :     my $ip = $hostent[4];
545 :    
546 :     socket($sock, PF_INET, SOCK_STREAM, $tcp);
547 :     if (bind($sock, sockaddr_in(0, $ip)))
548 :     {
549 :     #
550 :     # It worked. Reverse-map back to a hopefully fqdn.
551 :     #
552 :    
553 :     my @rev = gethostbyaddr($ip, AF_INET);
554 :     if (@rev > 0)
555 :     {
556 : olson 1.28 my $host = $rev[0];
557 :     #
558 :     # Check to see if we have a FQDN.
559 :     #
560 :    
561 :     if ($host =~ /\./)
562 :     {
563 :     #
564 :     # Good.
565 :     #
566 :     return $host;
567 :     }
568 :     else
569 :     {
570 :     #
571 :     # We didn't get a fqdn; bail and return the IP address.
572 :     #
573 :     return get_hostname_by_adapter()
574 :     }
575 : olson 1.10 }
576 :     else
577 :     {
578 :     return inet_ntoa($ip);
579 :     }
580 :     }
581 :     else
582 :     {
583 :     #
584 :     # Our hostname must be wrong; we can't bind to the IP
585 :     # address it maps to.
586 :     # Return the name associated with the adapter.
587 :     #
588 :     return get_hostname_by_adapter()
589 :     }
590 :     }
591 :     else
592 :     {
593 :     #
594 :     # Our hostname isn't known to DNS. This isn't good.
595 :     # Return the name associated with the adapter.
596 :     #
597 :     return get_hostname_by_adapter()
598 :     }
599 :     }
600 :    
601 :     sub get_hostname_by_adapter {
602 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
603 : olson 1.10 #
604 :     # Attempt to determine our local hostname based on the
605 :     # network environment.
606 :     #
607 :     # This implementation reads the routing table for the default route.
608 :     # We then look at the interface config for the interface that holds the default.
609 :     #
610 :     #
611 :     # Linux routing table:
612 :     # [olson@yips 0.0.0]$ netstat -rn
613 :     # Kernel IP routing table
614 :     # Destination Gateway Genmask Flags MSS Window irtt Iface
615 :     # 140.221.34.32 0.0.0.0 255.255.255.224 U 0 0 0 eth0
616 :     # 169.254.0.0 0.0.0.0 255.255.0.0 U 0 0 0 eth0
617 :     # 127.0.0.0 0.0.0.0 255.0.0.0 U 0 0 0 lo
618 :     # 0.0.0.0 140.221.34.61 0.0.0.0 UG 0 0 0 eth0
619 :     #
620 :     # Mac routing table:
621 :     #
622 :     # bash-2.05a$ netstat -rn
623 :     # Routing tables
624 :     #
625 :     # Internet:
626 :     # Destination Gateway Flags Refs Use Netif Expire
627 :     # default 140.221.11.253 UGSc 12 120 en0
628 :     # 127.0.0.1 127.0.0.1 UH 16 8415486 lo0
629 :     # 140.221.8/22 link#4 UCS 12 0 en0
630 :     # 140.221.8.78 0:6:5b:f:51:c4 UHLW 0 183 en0 408
631 :     # 140.221.8.191 0:3:93:84:ab:e8 UHLW 0 92 en0 622
632 :     # 140.221.8.198 0:e0:98:8e:36:e2 UHLW 0 5 en0 691
633 :     # 140.221.9.6 0:6:5b:f:51:d6 UHLW 1 63 en0 1197
634 :     # 140.221.10.135 0:d0:59:34:26:34 UHLW 2 2134 en0 1199
635 :     # 140.221.10.152 0:30:1b:b0:ec:dd UHLW 1 137 en0 1122
636 :     # 140.221.10.153 127.0.0.1 UHS 0 0 lo0
637 :     # 140.221.11.37 0:9:6b:53:4e:4b UHLW 1 624 en0 1136
638 :     # 140.221.11.103 0:30:48:22:59:e6 UHLW 3 973 en0 1016
639 :     # 140.221.11.224 0:a:95:6f:7:10 UHLW 1 1 en0 605
640 :     # 140.221.11.237 0:1:30:b8:80:c0 UHLW 0 0 en0 1158
641 :     # 140.221.11.250 0:1:30:3:1:0 UHLW 0 0 en0 1141
642 :     # 140.221.11.253 0:d0:3:e:70:a UHLW 13 0 en0 1199
643 :     # 169.254 link#4 UCS 0 0 en0
644 :     #
645 :     # Internet6:
646 :     # Destination Gateway Flags Netif Expire
647 :     # UH lo0
648 :     # fe80::%lo0/64 Uc lo0
649 :     # link#1 UHL lo0
650 :     # fe80::%en0/64 link#4 UC en0
651 :     # 0:a:95:a8:26:68 UHL lo0
652 :     # ff01::/32 U lo0
653 :     # ff02::%lo0/32 UC lo0
654 :     # ff02::%en0/32 link#4 UC en0
655 :    
656 :     my($fh);
657 :    
658 :     if (!open($fh, "netstat -rn |"))
659 :     {
660 :     warn "Cannot run netstat to determine local IP address\n";
661 :     return "localhost";
662 :     }
663 :    
664 :     my $interface_name;
665 :    
666 :     while (<$fh>)
667 :     {
668 :     my @cols = split();
669 :    
670 :     if ($cols[0] eq "default" || $cols[0] eq "0.0.0.0")
671 :     {
672 :     $interface_name = $cols[$#cols];
673 :     }
674 :     }
675 :     close($fh);
676 :    
677 : olson 1.11 # print "Default route on $interface_name\n";
678 : olson 1.10
679 :     #
680 :     # Find ifconfig.
681 :     #
682 :    
683 :     my $ifconfig;
684 :    
685 :     for my $dir ((split(":", $ENV{PATH}), "/sbin", "/usr/sbin"))
686 :     {
687 :     if (-x "$dir/ifconfig")
688 :     {
689 :     $ifconfig = "$dir/ifconfig";
690 :     last;
691 :     }
692 :     }
693 :    
694 :     if ($ifconfig eq "")
695 :     {
696 :     warn "Ifconfig not found\n";
697 :     return "localhost";
698 :     }
699 : olson 1.11 # print "Foudn $ifconfig\n";
700 : olson 1.10
701 :     if (!open($fh, "$ifconfig $interface_name |"))
702 :     {
703 :     warn "Could not run $ifconfig: $!\n";
704 :     return "localhost";
705 :     }
706 :    
707 :     my $ip;
708 :     while (<$fh>)
709 :     {
710 :     #
711 :     # Mac:
712 :     # inet 140.221.10.153 netmask 0xfffffc00 broadcast 140.221.11.255
713 :     # Linux:
714 :     # inet addr:140.221.34.37 Bcast:140.221.34.63 Mask:255.255.255.224
715 :     #
716 :    
717 :     chomp;
718 :     s/^\s*//;
719 :    
720 : olson 1.11 # print "Have '$_'\n";
721 : olson 1.10 if (/inet\s+addr:(\d+\.\d+\.\d+\.\d+)\s+/)
722 :     {
723 :     #
724 :     # Linux hit.
725 :     #
726 :     $ip = $1;
727 : olson 1.11 # print "Got linux $ip\n";
728 : olson 1.10 last;
729 :     }
730 :     elsif (/inet\s+(\d+\.\d+\.\d+\.\d+)\s+/)
731 :     {
732 :     #
733 :     # Mac hit.
734 :     #
735 :     $ip = $1;
736 : olson 1.11 # print "Got mac $ip\n";
737 : olson 1.10 last;
738 :     }
739 :     }
740 :     close($fh);
741 :    
742 :     if ($ip eq "")
743 :     {
744 :     warn "Didn't find an IP\n";
745 :     return "localhost";
746 :     }
747 :    
748 :     return $ip;
749 : efrank 1.1 }
750 :    
751 : olson 1.38 sub get_seed_id {
752 :     #
753 :     # Retrieve the seed identifer from FIGdisk/config/seed_id.
754 :     #
755 :     # If it's not there, create one, and make it readonly.
756 :     #
757 :    
758 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
759 : olson 1.38 my $id;
760 :     my $id_file = "$FIG_Config::fig_disk/config/seed_id";
761 :     if (! -f $id_file)
762 :     {
763 :     my $newid = `uuidgen`;
764 :     if (!$newid)
765 :     {
766 :     die "Cannot run uuidgen: $!";
767 :     }
768 :    
769 :     chomp($newid);
770 :     my $fh = new FileHandle(">$id_file");
771 :     if (!$fh)
772 :     {
773 :     die "error creating $id_file: $!";
774 :     }
775 :     print $fh "$newid\n";
776 :     $fh->close();
777 :     chmod(0444, $id_file);
778 :     }
779 :     my $fh = new FileHandle("<$id_file");
780 :     $id = <$fh>;
781 :     chomp($id);
782 :     return $id;
783 :     }
784 :    
785 : olson 1.155 =pod
786 :    
787 :     =head1 get_release_info
788 :    
789 :     Return the current data release information. This will be a tuple or a
790 :     hash or something, but the format is not yet defined so we return
791 :     undef.
792 :    
793 :     =cut
794 :    
795 :     sub get_release_info
796 :     {
797 :     my($self) = @_;
798 :    
799 :     return undef;
800 :     }
801 :    
802 :     =pod
803 :    
804 :     =head1 get_peer_last_update
805 :    
806 :     Return the timestamp from the last successful peer-to-peer update with
807 :     the given peer.
808 :    
809 :     We store this information in FIG/Data/Global/Peers/<peer-id>.
810 :    
811 :     =cut
812 :    
813 :     sub get_peer_last_update
814 :     {
815 :     my($self, $peer_id) = @_;
816 :    
817 :     my $dir = "$FIG_Config::data/Global/Peers";
818 :     &verify_dir($dir);
819 :     $dir .= "/$peer_id";
820 :     &verify_dir($dir);
821 :    
822 :     my $update_file = "$dir/last_update";
823 :     if (-f $update_file)
824 :     {
825 :     my $time = file_head($update_file, 1);
826 :     chomp $time;
827 :     return $time;
828 :     }
829 :     else
830 :     {
831 :     return undef;
832 :     }
833 :     }
834 :    
835 :     sub set_peer_last_update
836 :     {
837 :     my($self, $peer_id, $time) = @_;
838 :    
839 :     my $dir = "$FIG_Config::data/Global/Peers";
840 :     &verify_dir($dir);
841 :     $dir .= "/$peer_id";
842 :     &verify_dir($dir);
843 :    
844 :     my $update_file = "$dir/last_update";
845 :     open(F, ">$update_file");
846 :     print F "$time\n";
847 :     close(F);
848 :     }
849 :    
850 : efrank 1.1 sub cgi_url {
851 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
852 : efrank 1.1 return &plug_url($FIG_Config::cgi_url);
853 :     }
854 :    
855 :     sub temp_url {
856 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
857 : efrank 1.1 return &plug_url($FIG_Config::temp_url);
858 :     }
859 :    
860 :     sub plug_url {
861 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
862 : efrank 1.1 my($url) = @_;
863 :    
864 : golsen 1.44 my $name;
865 :    
866 :     # Revised by GJO
867 :     # First try to get url from the current http request
868 :    
869 :     if ( defined( $ENV{ 'HTTP_HOST' } ) # This is where $cgi->url gets its value
870 :     && ( $name = $ENV{ 'HTTP_HOST' } )
871 :     && ( $url =~ s~^http://[^/]*~http://$name~ ) # ~ is delimiter
872 :     ) {}
873 :    
874 :     # Otherwise resort to alternative sources
875 :    
876 :     elsif ( ( $name = &get_local_hostname )
877 :     && ( $url =~ s~^http://[^/]*~http://$name~ ) # ~ is delimiter
878 :     ) {}
879 :    
880 : efrank 1.1 return $url;
881 :     }
882 :    
883 : olson 1.90 sub file_read
884 :     {
885 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
886 : olson 1.90 my($file) = @_;
887 :    
888 :     if (open(my $fh, "<$file"))
889 :     {
890 :     if (wantarray)
891 :     {
892 :     my @ret = <$fh>;
893 :     return @ret;
894 :     }
895 :     else
896 :     {
897 :     local $/;
898 :     my $text = <$fh>;
899 :     close($fh);
900 :     return $text;
901 :     }
902 :     }
903 :     }
904 :    
905 :    
906 :     sub file_head
907 :     {
908 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
909 : olson 1.90 my($file, $n) = @_;
910 :    
911 :     if (!$n)
912 :     {
913 :     $n = 1;
914 :     }
915 :    
916 :     if (open(my $fh, "<$file"))
917 :     {
918 :     my(@ret, $i);
919 :    
920 :     $i = 0;
921 :     while (<$fh>)
922 :     {
923 :     push(@ret, $_);
924 :     $i++;
925 :     last if $i >= $n;
926 :     }
927 : olson 1.93 close($fh);
928 : olson 1.155
929 :     if (wantarray)
930 :     {
931 :     return @ret;
932 :     }
933 :     else
934 :     {
935 :     return join("", @ret);
936 :     }
937 : olson 1.90 }
938 :     }
939 :    
940 :    
941 : efrank 1.1 =pod
942 :    
943 :     =head1 hiding/caching in a FIG object
944 :    
945 :     We save the DB handle, cache taxonomies, and put a few other odds and ends in the
946 :     FIG object. We expect users to invoke these services using the object $fig constructed
947 :     using:
948 :    
949 :     use FIG;
950 :     my $fig = new FIG;
951 :    
952 :     $fig is then used as the basic mechanism for accessing FIG services. It is, of course,
953 :     just a hash that is used to retain/cache data. The most commonly accessed item is the
954 :     DB filehandle, which is accessed via $self->db_handle.
955 :    
956 :     We cache genus/species expansions, taxonomies, distances (very crudely estimated) estimated
957 :     between genomes, and a variety of other things. I am not sure that using cached/2 was a
958 :     good idea, but I did it.
959 :    
960 :     =cut
961 :    
962 :     sub db_handle {
963 :     my($self) = @_;
964 :    
965 :     return $self->{_dbf};
966 :     }
967 :    
968 :     sub cached {
969 :     my($self,$what) = @_;
970 :    
971 :     my $x = $self->{$what};
972 :     if (! $x)
973 :     {
974 :     $x = $self->{$what} = {};
975 :     }
976 :     return $x;
977 :     }
978 :    
979 :     ################ Basic Routines [ existed since WIT ] ##########################
980 :    
981 :    
982 :     =pod
983 :    
984 :     =head1 min
985 :    
986 :     usage: $n = &FIG::min(@x)
987 :    
988 :     Assumes @x contains numeric values. Returns the minimum of the values.
989 :    
990 :     =cut
991 :    
992 :     sub min {
993 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
994 : efrank 1.1 my(@x) = @_;
995 :     my($min,$i);
996 :    
997 :     (@x > 0) || return undef;
998 :     $min = $x[0];
999 :     for ($i=1; ($i < @x); $i++)
1000 :     {
1001 :     $min = ($min > $x[$i]) ? $x[$i] : $min;
1002 :     }
1003 :     return $min;
1004 :     }
1005 :    
1006 :     =pod
1007 :    
1008 :     =head1 max
1009 :    
1010 :     usage: $n = &FIG::max(@x)
1011 :    
1012 :     Assumes @x contains numeric values. Returns the maximum of the values.
1013 :    
1014 :     =cut
1015 :    
1016 :     sub max {
1017 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1018 : efrank 1.1 my(@x) = @_;
1019 :     my($max,$i);
1020 :    
1021 :     (@x > 0) || return undef;
1022 :     $max = $x[0];
1023 :     for ($i=1; ($i < @x); $i++)
1024 :     {
1025 :     $max = ($max < $x[$i]) ? $x[$i] : $max;
1026 :     }
1027 :     return $max;
1028 :     }
1029 :    
1030 :     =pod
1031 :    
1032 :     =head1 between
1033 :    
1034 :     usage: &FIG::between($x,$y,$z)
1035 :    
1036 :     Returns true iff $y is between $x and $z.
1037 :    
1038 :     =cut
1039 :    
1040 :     sub between {
1041 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1042 : efrank 1.1 my($x,$y,$z) = @_;
1043 :    
1044 :     if ($x < $z)
1045 :     {
1046 :     return (($x <= $y) && ($y <= $z));
1047 :     }
1048 :     else
1049 :     {
1050 :     return (($x >= $y) && ($y >= $z));
1051 :     }
1052 :     }
1053 :    
1054 :     =pod
1055 :    
1056 :     =head1 standard_genetic_code
1057 :    
1058 :     usage: $code = &FIG::standard_genetic_code()
1059 :    
1060 :     Routines like "translate" can take a "genetic code" as an argument. I implemented such
1061 :     codes using hashes that assumed uppercase DNA triplets as keys.
1062 :    
1063 :     =cut
1064 :    
1065 :     sub standard_genetic_code {
1066 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1067 : efrank 1.1
1068 :     my $code = {};
1069 :    
1070 :     $code->{"AAA"} = "K";
1071 :     $code->{"AAC"} = "N";
1072 :     $code->{"AAG"} = "K";
1073 :     $code->{"AAT"} = "N";
1074 :     $code->{"ACA"} = "T";
1075 :     $code->{"ACC"} = "T";
1076 :     $code->{"ACG"} = "T";
1077 :     $code->{"ACT"} = "T";
1078 :     $code->{"AGA"} = "R";
1079 :     $code->{"AGC"} = "S";
1080 :     $code->{"AGG"} = "R";
1081 :     $code->{"AGT"} = "S";
1082 :     $code->{"ATA"} = "I";
1083 :     $code->{"ATC"} = "I";
1084 :     $code->{"ATG"} = "M";
1085 :     $code->{"ATT"} = "I";
1086 :     $code->{"CAA"} = "Q";
1087 :     $code->{"CAC"} = "H";
1088 :     $code->{"CAG"} = "Q";
1089 :     $code->{"CAT"} = "H";
1090 :     $code->{"CCA"} = "P";
1091 :     $code->{"CCC"} = "P";
1092 :     $code->{"CCG"} = "P";
1093 :     $code->{"CCT"} = "P";
1094 :     $code->{"CGA"} = "R";
1095 :     $code->{"CGC"} = "R";
1096 :     $code->{"CGG"} = "R";
1097 :     $code->{"CGT"} = "R";
1098 :     $code->{"CTA"} = "L";
1099 :     $code->{"CTC"} = "L";
1100 :     $code->{"CTG"} = "L";
1101 :     $code->{"CTT"} = "L";
1102 :     $code->{"GAA"} = "E";
1103 :     $code->{"GAC"} = "D";
1104 :     $code->{"GAG"} = "E";
1105 :     $code->{"GAT"} = "D";
1106 :     $code->{"GCA"} = "A";
1107 :     $code->{"GCC"} = "A";
1108 :     $code->{"GCG"} = "A";
1109 :     $code->{"GCT"} = "A";
1110 :     $code->{"GGA"} = "G";
1111 :     $code->{"GGC"} = "G";
1112 :     $code->{"GGG"} = "G";
1113 :     $code->{"GGT"} = "G";
1114 :     $code->{"GTA"} = "V";
1115 :     $code->{"GTC"} = "V";
1116 :     $code->{"GTG"} = "V";
1117 :     $code->{"GTT"} = "V";
1118 :     $code->{"TAA"} = "*";
1119 :     $code->{"TAC"} = "Y";
1120 :     $code->{"TAG"} = "*";
1121 :     $code->{"TAT"} = "Y";
1122 :     $code->{"TCA"} = "S";
1123 :     $code->{"TCC"} = "S";
1124 :     $code->{"TCG"} = "S";
1125 :     $code->{"TCT"} = "S";
1126 :     $code->{"TGA"} = "*";
1127 :     $code->{"TGC"} = "C";
1128 :     $code->{"TGG"} = "W";
1129 :     $code->{"TGT"} = "C";
1130 :     $code->{"TTA"} = "L";
1131 :     $code->{"TTC"} = "F";
1132 :     $code->{"TTG"} = "L";
1133 :     $code->{"TTT"} = "F";
1134 :    
1135 :     return $code;
1136 :     }
1137 :    
1138 :     =pod
1139 :    
1140 :     =head1 translate
1141 :    
1142 :     usage: $aa_seq = &FIG::translate($dna_seq,$code,$fix_start);
1143 :    
1144 :     If $code is undefined, I use the standard genetic code. If $fix_start is true, I
1145 :     will translate initial TTG or GTG to 'M'.
1146 :    
1147 :     =cut
1148 :    
1149 :     sub translate {
1150 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1151 : efrank 1.1 my( $dna,$code,$start) = @_;
1152 :     my( $i,$j,$ln );
1153 :     my( $x,$y );
1154 :     my( $prot );
1155 :    
1156 :     if (! defined($code))
1157 :     {
1158 :     $code = &FIG::standard_genetic_code;
1159 :     }
1160 :     $ln = length($dna);
1161 :     $prot = "X" x ($ln/3);
1162 :     $dna =~ tr/a-z/A-Z/;
1163 :    
1164 :     for ($i=0,$j=0; ($i < ($ln-2)); $i += 3,$j++)
1165 :     {
1166 :     $x = substr($dna,$i,3);
1167 :     if ($y = $code->{$x})
1168 :     {
1169 :     substr($prot,$j,1) = $y;
1170 :     }
1171 :     }
1172 :    
1173 :     if (($start) && ($ln >= 3) && (substr($dna,0,3) =~ /^[GT]TG$/))
1174 :     {
1175 :     substr($prot,0,1) = 'M';
1176 :     }
1177 :     return $prot;
1178 :     }
1179 :    
1180 :     =pod
1181 :    
1182 :     =head1 reverse_comp and rev_comp
1183 :    
1184 :     usage: $dnaR = &FIG::reverse_comp($dna) or
1185 :     $dnaRP = &FIG::rev_comp($seqP)
1186 :    
1187 :     In WIT, we implemented reverse complement passing a pointer to a sequence and returning
1188 :     a pointer to a sequence. In most cases the pointers are a pain (although in a few they
1189 :     are just what is needed). Hence, I kept both versions of the function to allow you
1190 :     to use whichever you like. Use rev_comp only for long strings where passing pointers is a
1191 :     reasonable effeciency issue.
1192 :    
1193 :     =cut
1194 :    
1195 :     sub reverse_comp {
1196 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1197 : efrank 1.1 my($seq) = @_;
1198 :    
1199 :     return ${&rev_comp(\$seq)};
1200 :     }
1201 :    
1202 :     sub rev_comp {
1203 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1204 : efrank 1.1 my( $seqP ) = @_;
1205 :     my( $rev );
1206 :    
1207 :     $rev = reverse( $$seqP );
1208 :     $rev =~ tr/a-z/A-Z/;
1209 :     $rev =~ tr/ACGTUMRWSYKBDHV/TGCAAKYWSRMVHDB/;
1210 :     return \$rev;
1211 :     }
1212 :    
1213 :     =pod
1214 :    
1215 :     =head1 verify_dir
1216 :    
1217 :     usage: &FIG::verify_dir($dir)
1218 :    
1219 :     Makes sure that $dir exists. If it has to create it, it sets permissions to 0777.
1220 :    
1221 :     =cut
1222 :    
1223 :     sub verify_dir {
1224 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1225 : efrank 1.1 my($dir) = @_;
1226 :    
1227 :     if (-d $dir) { return }
1228 :     if ($dir =~ /^(.*)\/[^\/]+$/)
1229 :     {
1230 :     &verify_dir($1);
1231 :     }
1232 : olson 1.153 mkdir($dir,0777) || die "could not make $dir: $!";
1233 : disz 1.60 chmod 02777,$dir;
1234 : efrank 1.1 }
1235 :    
1236 :     =pod
1237 :    
1238 :     =head1 run
1239 :    
1240 :     usage: &FIG::run($cmd)
1241 :    
1242 :     Runs $cmd and fails (with trace) if the command fails.
1243 :    
1244 :     =cut
1245 :    
1246 : mkubal 1.53
1247 : efrank 1.1 sub run {
1248 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1249 : efrank 1.1 my($cmd) = @_;
1250 :    
1251 : golsen 1.44 # my @tmp = `date`; chomp @tmp; print STDERR "$tmp[0]: running $cmd\n";
1252 : efrank 1.1 (system($cmd) == 0) || confess "FAILED: $cmd";
1253 :     }
1254 :    
1255 : gdpusch 1.45
1256 :    
1257 :     =pod
1258 :    
1259 :     =head1 read_fasta_record(\*FILEHANDLE)
1260 :    
1261 : gdpusch 1.109 Usage: ( $seq_id, $seq_pointer, $comment ) = &read_fasta_record(\*FILEHANDLE);
1262 : gdpusch 1.45
1263 :     Function: Reads a FASTA-formatted sequence file one record at a time.
1264 :     The input filehandle defaults to STDIN if not specified.
1265 :     Returns a sequence ID, a pointer to the sequence, and an optional
1266 :     record comment (NOTE: Record comments are deprecated, as some tools
1267 :     such as BLAST do not handle them gracefully). Returns an empty list
1268 :     if attempting to read a record results in an undefined value
1269 :     (e.g., due to reaching the EOF).
1270 :    
1271 :     Author: Gordon D. Pusch
1272 :    
1273 :     Date: 2004-Feb-18
1274 :    
1275 :     =cut
1276 :    
1277 :     sub read_fasta_record
1278 :     {
1279 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1280 : gdpusch 1.45 my ($file_handle) = @_;
1281 : gdpusch 1.46 my ( $old_end_of_record, $fasta_record, @lines, $head, $sequence, $seq_id, $comment, @parsed_fasta_record );
1282 : gdpusch 1.45
1283 :     if (not defined($file_handle)) { $file_handle = \*STDIN; }
1284 :    
1285 :     $old_end_of_record = $/;
1286 :     $/ = "\n>";
1287 :    
1288 :     if (defined($fasta_record = <$file_handle>))
1289 :     {
1290 :     chomp $fasta_record;
1291 :     @lines = split( /\n/, $fasta_record );
1292 :     $head = shift @lines;
1293 :     $head =~ s/^>?//;
1294 :     $head =~ m/^(\S+)/;
1295 :     $seq_id = $1;
1296 :    
1297 :     if ($head =~ m/^\S+\s+(.*)$/) { $comment = $1; } else { $comment = ""; }
1298 :    
1299 :     $sequence = join( "", @lines );
1300 :    
1301 :     @parsed_fasta_record = ( $seq_id, \$sequence, $comment );
1302 :     }
1303 :     else
1304 :     {
1305 :     @parsed_fasta_record = ();
1306 :     }
1307 :    
1308 :     $/ = $old_end_of_record;
1309 :    
1310 :     return @parsed_fasta_record;
1311 :     }
1312 :    
1313 :    
1314 : efrank 1.1 =pod
1315 :    
1316 :     =head1 display_id_and_seq
1317 :    
1318 :     usage: &FIG::display_id_and_seq($id_and_comment,$seqP,$fh)
1319 :    
1320 :     This command has always been used to put out fasta sequences. Note that it
1321 :     takes a pointer to the sequence. $fh is optional and defalts to STDOUT.
1322 :    
1323 :     =cut
1324 :    
1325 : mkubal 1.53
1326 : efrank 1.1 sub display_id_and_seq {
1327 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1328 : efrank 1.1 my( $id, $seq, $fh ) = @_;
1329 :    
1330 :     if (! defined($fh) ) { $fh = \*STDOUT; }
1331 :    
1332 :     print $fh ">$id\n";
1333 :     &display_seq($seq, $fh);
1334 :     }
1335 :    
1336 :     sub display_seq {
1337 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1338 : efrank 1.1 my ( $seq, $fh ) = @_;
1339 :     my ( $i, $n, $ln );
1340 :    
1341 :     if (! defined($fh) ) { $fh = \*STDOUT; }
1342 :    
1343 :     $n = length($$seq);
1344 :     # confess "zero-length sequence ???" if ( (! defined($n)) || ($n == 0) );
1345 :     for ($i=0; ($i < $n); $i += 60)
1346 :     {
1347 :     if (($i + 60) <= $n)
1348 :     {
1349 :     $ln = substr($$seq,$i,60);
1350 :     }
1351 :     else
1352 :     {
1353 :     $ln = substr($$seq,$i,($n-$i));
1354 :     }
1355 :     print $fh "$ln\n";
1356 :     }
1357 :     }
1358 :    
1359 :     ########## I commented the pods on the following routines out, since they should not
1360 :     ########## be part of the SOAP/WSTL interface
1361 :     #=pod
1362 :     #
1363 :     #=head1 file2N
1364 :     #
1365 :     #usage: $n = $fig->file2N($file)
1366 :     #
1367 :     #In some of the databases I need to store filenames, which can waste a lot of
1368 :     #space. Hence, I maintain a database for converting filenames to/from integers.
1369 :     #
1370 :     #=cut
1371 :     #
1372 : olson 1.111 sub file2N :scalar {
1373 : efrank 1.1 my($self,$file) = @_;
1374 :     my($relational_db_response);
1375 :    
1376 :     my $rdbH = $self->db_handle;
1377 :    
1378 :     if (($relational_db_response = $rdbH->SQL("SELECT fileno FROM file_table WHERE ( file = \'$file\')")) &&
1379 :     (@$relational_db_response == 1))
1380 :     {
1381 :     return $relational_db_response->[0]->[0];
1382 :     }
1383 :     elsif (($relational_db_response = $rdbH->SQL("SELECT MAX(fileno) FROM file_table ")) && (@$relational_db_response == 1) && ($relational_db_response->[0]->[0]))
1384 :     {
1385 :     my $fileno = $relational_db_response->[0]->[0] + 1;
1386 :     if ($rdbH->SQL("INSERT INTO file_table ( file, fileno ) VALUES ( \'$file\', $fileno )"))
1387 :     {
1388 :     return $fileno;
1389 :     }
1390 :     }
1391 :     elsif ($rdbH->SQL("INSERT INTO file_table ( file, fileno ) VALUES ( \'$file\', 1 )"))
1392 :     {
1393 :     return 1;
1394 :     }
1395 :     return undef;
1396 :     }
1397 :    
1398 :     #=pod
1399 :     #
1400 :     #=head1 N2file
1401 :     #
1402 :     #usage: $filename = $fig->N2file($n)
1403 :     #
1404 :     #In some of the databases I need to store filenames, which can waste a lot of
1405 :     #space. Hence, I maintain a database for converting filenames to/from integers.
1406 :     #
1407 :     #=cut
1408 :     #
1409 : olson 1.111 sub N2file :scalar {
1410 : efrank 1.1 my($self,$fileno) = @_;
1411 :     my($relational_db_response);
1412 :    
1413 :     my $rdbH = $self->db_handle;
1414 :    
1415 :     if (($relational_db_response = $rdbH->SQL("SELECT file FROM file_table WHERE ( fileno = $fileno )")) &&
1416 :     (@$relational_db_response == 1))
1417 :     {
1418 :     return $relational_db_response->[0]->[0];
1419 :     }
1420 :     return undef;
1421 :     }
1422 :    
1423 :    
1424 :     #=pod
1425 :     #
1426 :     #=head1 openF
1427 :     #
1428 :     #usage: $fig->openF($filename)
1429 :     #
1430 :     #Parts of the system rely on accessing numerous different files. The most obvious case is
1431 :     #the situation with similarities. It is important that the system be able to run in cases in
1432 :     #which an arbitrary number of files cannot be open simultaneously. This routine (with closeF) is
1433 :     #a hack to handle this. I should probably just pitch them and insist that the OS handle several
1434 :     #hundred open filehandles.
1435 :     #
1436 :     #=cut
1437 :     #
1438 :     sub openF {
1439 :     my($self,$file) = @_;
1440 :     my($fxs,$x,@fxs,$fh);
1441 :    
1442 :     $fxs = $self->cached('_openF');
1443 :     if ($x = $fxs->{$file})
1444 :     {
1445 :     $x->[1] = time();
1446 :     return $x->[0];
1447 :     }
1448 :    
1449 :     @fxs = keys(%$fxs);
1450 :     if (defined($fh = new FileHandle "<$file"))
1451 :     {
1452 : overbeek 1.98 if (@fxs >= 50)
1453 : efrank 1.1 {
1454 :     @fxs = sort { $fxs->{$a}->[1] <=> $fxs->{$b}->[1] } @fxs;
1455 :     $x = $fxs->{$fxs[0]};
1456 :     undef $x->[0];
1457 :     delete $fxs->{$fxs[0]};
1458 :     }
1459 :     $fxs->{$file} = [$fh,time()];
1460 :     return $fh;
1461 :     }
1462 :     return undef;
1463 :     }
1464 :    
1465 :     #=pod
1466 :     #
1467 :     #=head1 closeF
1468 :     #
1469 :     #usage: $fig->closeF($filename)
1470 :     #
1471 :     #Parts of the system rely on accessing numerous different files. The most obvious case is
1472 :     #the situation with similarities. It is important that the system be able to run in cases in
1473 :     #which an arbitrary number of files cannot be open simultaneously. This routine (with openF) is
1474 :     #a hack to handle this. I should probably just pitch them and insist that the OS handle several
1475 :     #hundred open filehandles.
1476 :     #
1477 :     #=cut
1478 :     #
1479 :     sub closeF {
1480 :     my($self,$file) = @_;
1481 :     my($fxs,$x);
1482 :    
1483 :     if (($fxs = $self->{_openF}) &&
1484 :     ($x = $fxs->{$file}))
1485 :     {
1486 :     undef $x->[0];
1487 :     delete $fxs->{$file};
1488 :     }
1489 :     }
1490 :    
1491 :     =pod
1492 :    
1493 :     =head1 ec_name
1494 :    
1495 :     usage: $enzymatic_function = $fig->ec_name($ec)
1496 :    
1497 :     Returns enzymatic name for EC.
1498 :    
1499 :     =cut
1500 :    
1501 :     sub ec_name {
1502 :     my($self,$ec) = @_;
1503 :    
1504 :     ($ec =~ /^\d+\.\d+\.\d+\.\d+$/) || return "";
1505 :     my $rdbH = $self->db_handle;
1506 :     my $relational_db_response = $rdbH->SQL("SELECT name FROM ec_names WHERE ( ec = \'$ec\' )");
1507 :    
1508 :     return (@$relational_db_response == 1) ? $relational_db_response->[0]->[0] : "";
1509 :     return "";
1510 :     }
1511 :    
1512 :     =pod
1513 :    
1514 :     =head1 all_roles
1515 :    
1516 :     usage: @roles = $fig->all_roles
1517 :    
1518 : mkubal 1.54 Supposed to return all known roles. For now, we get all ECs with "names".
1519 : efrank 1.1
1520 :     =cut
1521 :    
1522 :     sub all_roles {
1523 :     my($self) = @_;
1524 :    
1525 :     my $rdbH = $self->db_handle;
1526 :     my $relational_db_response = $rdbH->SQL("SELECT ec,name FROM ec_names");
1527 :    
1528 :     return @$relational_db_response;
1529 :     }
1530 :    
1531 :     =pod
1532 :    
1533 :     =head1 expand_ec
1534 :    
1535 :     usage: $expanded_ec = $fig->expand_ec($ec)
1536 :    
1537 :     Expands "1.1.1.1" to "1.1.1.1 - alcohol dehydrogenase" or something like that.
1538 :    
1539 :     =cut
1540 :    
1541 :     sub expand_ec {
1542 :     my($self,$ec) = @_;
1543 :     my($name);
1544 :    
1545 :     return ($name = $self->ec_name($ec)) ? "$ec - $name" : $ec;
1546 :     }
1547 :    
1548 :    
1549 :     =pod
1550 :    
1551 :     =head1 clean_tmp
1552 :    
1553 :     usage: &FIG::clean_tmp
1554 :    
1555 :     We store temporary files in $FIG_Config::temp. There are specific classes of files
1556 :     that are created and should be saved for at least a few days. This routine can be
1557 :     invoked to clean out those that are over two days old.
1558 :    
1559 :     =cut
1560 :    
1561 :     sub clean_tmp {
1562 :    
1563 :     my($file);
1564 :     if (opendir(TMP,"$FIG_Config::temp"))
1565 :     {
1566 :     # change the pattern to pick up other files that need to be cleaned up
1567 :     my @temp = grep { $_ =~ /^(Geno|tmp)/ } readdir(TMP);
1568 :     foreach $file (@temp)
1569 :     {
1570 :     if (-M "$FIG_Config::temp/$file" > 2)
1571 :     {
1572 :     unlink("$FIG_Config::temp/$file");
1573 :     }
1574 :     }
1575 :     }
1576 :     }
1577 :    
1578 :     ################ Routines to process genomes and genome IDs ##########################
1579 :    
1580 :    
1581 :     =pod
1582 :    
1583 :     =head1 genomes
1584 :    
1585 : golsen 1.150 usage: @genome_ids = $fig->genomes( $complete, $restrictions, $domain );
1586 : efrank 1.1
1587 :     Genomes are assigned ids of the form X.Y where X is the taxonomic id maintained by
1588 :     NCBI for the species (not the specific strain), and Y is a sequence digit assigned to
1589 :     this particular genome (as one of a set with the same genus/species). Genomes also
1590 :     have versions, but that is a separate issue.
1591 :    
1592 :     =cut
1593 :    
1594 : olson 1.111 sub genomes :remote :list {
1595 : golsen 1.150 my( $self, $complete, $restrictions, $domain ) = @_;
1596 : overbeek 1.13
1597 :     my $rdbH = $self->db_handle;
1598 :    
1599 :     my @where = ();
1600 :     if ($complete)
1601 :     {
1602 :     push(@where,"( complete = \'1\' )")
1603 :     }
1604 :    
1605 :     if ($restrictions)
1606 :     {
1607 :     push(@where,"( restrictions = \'1\' )")
1608 :     }
1609 : golsen 1.150
1610 :     if ($domain)
1611 :     {
1612 :     push( @where, "( maindomain = '$domain' )" )
1613 :     }
1614 :    
1615 : overbeek 1.13 my $relational_db_response;
1616 :     if (@where > 0)
1617 :     {
1618 :     my $where = join(" AND ",@where);
1619 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome where $where");
1620 :     }
1621 :     else
1622 :     {
1623 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome");
1624 :     }
1625 :     my @genomes = sort { $a <=> $b } map { $_->[0] } @$relational_db_response;
1626 : efrank 1.1 return @genomes;
1627 :     }
1628 :    
1629 : golsen 1.150
1630 : efrank 1.2 sub genome_counts {
1631 : overbeek 1.13 my($self,$complete) = @_;
1632 :     my($x,$relational_db_response);
1633 : efrank 1.2
1634 : overbeek 1.13 my $rdbH = $self->db_handle;
1635 :    
1636 :     if ($complete)
1637 :     {
1638 : gdpusch 1.107 $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome where complete = '1'");
1639 : overbeek 1.13 }
1640 :     else
1641 :     {
1642 : gdpusch 1.107 $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome");
1643 : overbeek 1.13 }
1644 :    
1645 : gdpusch 1.107 my ($arch, $bact, $euk, $vir, $env, $unk) = (0, 0, 0, 0, 0, 0);
1646 : overbeek 1.13 if (@$relational_db_response > 0)
1647 : efrank 1.2 {
1648 : overbeek 1.13 foreach $x (@$relational_db_response)
1649 : efrank 1.2 {
1650 : gdpusch 1.107 if ($x->[1] =~ /^archaea/i) { ++$arch }
1651 :     elsif ($x->[1] =~ /^bacter/i) { ++$bact }
1652 :     elsif ($x->[1] =~ /^eukar/i) { ++$euk }
1653 :     elsif ($x->[1] =~ /^vir/i) { ++$vir }
1654 :     elsif ($x->[1] =~ /^env/i) { ++$env }
1655 :     else { ++$unk }
1656 : efrank 1.2 }
1657 :     }
1658 : overbeek 1.13
1659 : gdpusch 1.107 return ($arch, $bact, $euk, $vir, $env, $unk);
1660 :     }
1661 :    
1662 :    
1663 :     =pod
1664 :    
1665 :     =head1 genome_domain
1666 :    
1667 :     usage: $domain = $fig->genome_domain($genome_id);
1668 :    
1669 :     Returns the domain of a genome ID, and 'undef' if it is not in the database.
1670 :    
1671 :     =cut
1672 :    
1673 :     sub genome_domain {
1674 :     my($self,$genome) = @_;
1675 :     my $relational_db_response;
1676 :     my $rdbH = $self->db_handle;
1677 :    
1678 :     if ($genome)
1679 :     {
1680 :     if (($relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome WHERE ( genome = \'$genome\' )"))
1681 :     && (@$relational_db_response == 1))
1682 :     {
1683 :     # die Dumper($relational_db_response);
1684 :     return $relational_db_response->[0]->[1];
1685 :     }
1686 :     }
1687 :     return undef;
1688 : efrank 1.2 }
1689 :    
1690 : gdpusch 1.92
1691 :     =pod
1692 :    
1693 :     =head1 genome_pegs
1694 :    
1695 : gdpusch 1.107 usage: $num_pegs = $fig->genome_pegs($genome_id);
1696 : gdpusch 1.92
1697 : gdpusch 1.107 Returns the number of protein-encoding genes (PEGs) in $genome_id if
1698 :     "$genome_id" is indexed in the "genome" database, and 'undef' otherwise.
1699 : gdpusch 1.92
1700 :     =cut
1701 :    
1702 :     sub genome_pegs {
1703 :     my($self,$genome) = @_;
1704 :     my $relational_db_response;
1705 :     my $rdbH = $self->db_handle;
1706 :    
1707 :     if ($genome)
1708 :     {
1709 :     if (($relational_db_response = $rdbH->SQL("SELECT pegs FROM genome WHERE ( genome = \'$genome\' )"))
1710 :     && (@$relational_db_response == 1))
1711 :     {
1712 :     return $relational_db_response->[0]->[0];
1713 :     }
1714 :     }
1715 :     return undef;
1716 :     }
1717 :    
1718 :    
1719 : efrank 1.1 =pod
1720 :    
1721 : gdpusch 1.92 =head1 genome_rnas
1722 :    
1723 : gdpusch 1.107 usage: $num_rnas = $fig->genome_rnas($genome_id);
1724 : gdpusch 1.92
1725 : gdpusch 1.107 Returns the number of RNA-encoding genes (RNAs) in $genome_id if
1726 :     "$genome_id" is indexed in the "genome" database, and 'undef' otherwise.
1727 : gdpusch 1.92
1728 :     =cut
1729 :    
1730 :     sub genome_rnas {
1731 :     my($self,$genome) = @_;
1732 :     my $relational_db_response;
1733 :     my $rdbH = $self->db_handle;
1734 :    
1735 :     if ($genome)
1736 :     {
1737 :     if (($relational_db_response = $rdbH->SQL("SELECT rnas FROM genome WHERE ( genome = \'$genome\' )"))
1738 :     && (@$relational_db_response == 1))
1739 :     {
1740 :     return $relational_db_response->[0]->[0];
1741 :     }
1742 :     }
1743 :     return undef;
1744 :     }
1745 :    
1746 :    
1747 :     =pod
1748 :    
1749 :     =head1 genome_szdna
1750 : efrank 1.1
1751 : gdpusch 1.92 usage: $szdna = $fig->genome_szdna($genome_id);
1752 : gdpusch 1.91
1753 : gdpusch 1.107 Returns the number of DNA base-pairs in the genome contigs file(s) of $genome_id
1754 :     "$genome_id" is indexed in the "genome" database, and 'undef' otherwise.
1755 : gdpusch 1.91
1756 :     =cut
1757 :    
1758 : gdpusch 1.92 sub genome_szdna {
1759 : gdpusch 1.91 my($self,$genome) = @_;
1760 :     my $relational_db_response;
1761 :     my $rdbH = $self->db_handle;
1762 :    
1763 :     if ($genome)
1764 :     {
1765 :     if (($relational_db_response = $rdbH->SQL("SELECT szdna FROM genome WHERE ( genome = \'$genome\' )"))
1766 :     && (@$relational_db_response == 1))
1767 :     {
1768 :     return $relational_db_response->[0]->[0];
1769 :     }
1770 :     }
1771 :     return undef;
1772 :     }
1773 :    
1774 :    
1775 :     =pod
1776 :    
1777 :     =head1 genome_version
1778 :    
1779 : efrank 1.1 usage: $version = $fig->genome_version($genome_id);
1780 :    
1781 :     Versions are incremented for major updates. They are put in as major
1782 :     updates of the form 1.0, 2.0, ...
1783 :    
1784 :     Users may do local "editing" of the DNA for a genome, but when they do,
1785 :     they increment the digits to the right of the decimal. Two genomes remain
1786 :     comparable only if the versions match identically. Hence, minor updating should be
1787 :     committed only by the person/group responsible for updating that genome.
1788 :    
1789 :     We can, of course, identify which genes are identical between any two genomes (by matching
1790 :     the DNA or amino acid sequences). However, the basic intent of the system is to
1791 :     support editing by the main group issuing periodic major updates.
1792 :    
1793 :     =cut
1794 :    
1795 : olson 1.113 sub genome_version :scalar {
1796 : efrank 1.1 my($self,$genome) = @_;
1797 :    
1798 :     my(@tmp);
1799 :     if ((-s "$FIG_Config::organisms/$genome/VERSION") &&
1800 :     (@tmp = `cat $FIG_Config::organisms/$genome/VERSION`) &&
1801 : overbeek 1.84 ($tmp[0] =~ /^(\S+)$/))
1802 : efrank 1.1 {
1803 :     return $1;
1804 :     }
1805 :     return undef;
1806 :     }
1807 :    
1808 :     =pod
1809 :    
1810 :     =head1 genus_species
1811 :    
1812 :     usage: $gs = $fig->genus_species($genome_id)
1813 :    
1814 :     Returns the genus and species (and strain if that has been properly recorded)
1815 :     in a printable form.
1816 :    
1817 :     =cut
1818 :    
1819 : olson 1.111 sub genus_species :scalar {
1820 : efrank 1.1 my ($self,$genome) = @_;
1821 : overbeek 1.13 my $ans;
1822 : efrank 1.1
1823 :     my $genus_species = $self->cached('_genus_species');
1824 :     if (! ($ans = $genus_species->{$genome}))
1825 :     {
1826 : overbeek 1.13 my $rdbH = $self->db_handle;
1827 :     my $relational_db_response = $rdbH->SQL("SELECT genome,gname FROM genome");
1828 :     my $pair;
1829 :     foreach $pair (@$relational_db_response)
1830 : efrank 1.1 {
1831 : overbeek 1.13 $genus_species->{$pair->[0]} = $pair->[1];
1832 : efrank 1.1 }
1833 : overbeek 1.13 $ans = $genus_species->{$genome};
1834 : efrank 1.1 }
1835 :     return $ans;
1836 :     }
1837 :    
1838 :     =pod
1839 :    
1840 :     =head1 org_of
1841 :    
1842 :     usage: $org = $fig->org_of($prot_id)
1843 :    
1844 :     In the case of external proteins, we can usually determine an organism, but not
1845 :     anything more precise than genus/species (and often not that). This routine takes
1846 : efrank 1.2 a protein ID (which may be a feature ID) and returns "the organism".
1847 : efrank 1.1
1848 :     =cut
1849 :    
1850 :     sub org_of {
1851 :     my($self,$prot_id) = @_;
1852 :     my $relational_db_response;
1853 :     my $rdbH = $self->db_handle;
1854 :    
1855 :     if ($prot_id =~ /^fig\|/)
1856 :     {
1857 : golsen 1.138 #
1858 :     # Trying to guess what Ross wanted (there was a servere bug):
1859 :     #
1860 :     # deleted -> undefined
1861 :     # failed lookup -> ""
1862 :     #
1863 :     return $self->is_deleted_fid( $prot_id) ? undef
1864 :     : $self->genus_species( $self->genome_of( $prot_id ) ) || "";
1865 : efrank 1.1 }
1866 :    
1867 :     if (($relational_db_response = $rdbH->SQL("SELECT org FROM external_orgs WHERE ( prot = \'$prot_id\' )")) &&
1868 :     (@$relational_db_response >= 1))
1869 :     {
1870 :     return $relational_db_response->[0]->[0];
1871 :     }
1872 :     return "";
1873 :     }
1874 :    
1875 : golsen 1.130 #
1876 :     # Support for colorizing organisms by domain
1877 :     # -- GJO
1878 :     #
1879 :     =pod
1880 :    
1881 :     =head1 genus_species_domain
1882 :    
1883 :     usage: ($gs, $domain) = $fig->genus_species_domain($genome_id)
1884 :    
1885 :     Returns the genus and species (and strain if that has been properly recorded)
1886 :     in a printable form, and domain.
1887 :    
1888 :     =cut
1889 :    
1890 :     sub genus_species_domain {
1891 :     my ($self, $genome) = @_;
1892 :    
1893 :     my $genus_species_domain = $self->cached('_genus_species_domain');
1894 :     if ( ! $genus_species_domain->{ $genome } )
1895 :     {
1896 :     my $rdbH = $self->db_handle;
1897 :     my $relational_db_response = $rdbH->SQL("SELECT genome,gname,maindomain FROM genome");
1898 :     my $triple;
1899 :     foreach $triple ( @$relational_db_response )
1900 :     {
1901 :     $genus_species_domain->{ $triple->[0] } = [ $triple->[1], $triple->[2] ];
1902 :     }
1903 :     }
1904 :     my $gsdref = $genus_species_domain->{ $genome };
1905 :     return $gsdref ? @$gsdref : ( "", "" );
1906 :     }
1907 :    
1908 :    
1909 :     my %domain_color = ( AR => "#DDFFFF", BA => "#FFDDFF", EU => "#FFFFDD",
1910 :     VI => "#DDDDDD", EN => "#BBBBBB" );
1911 :    
1912 :     sub domain_color {
1913 :     my ($domain) = @_;
1914 :     defined $domain || return "#FFFFFF";
1915 :     return $domain_color{ uc substr($domain, 0, 2) } || "#FFFFFF";
1916 :     }
1917 :    
1918 :    
1919 :     =pod
1920 :    
1921 :     =head1 org_and_color_of
1922 :    
1923 :     usage: ($org, $color) = $fig->org_and_domain_of($prot_id)
1924 :    
1925 :     Return the best guess organism and domain html color string of an organism.
1926 :     In the case of external proteins, we can usually determine an organism, but not
1927 :     anything more precise than genus/species (and often not that). This routine takes
1928 :     a protein ID (which may be a feature ID) and returns "the organism".
1929 :    
1930 :     =cut
1931 :    
1932 :     sub org_and_color_of {
1933 :     my($self,$prot_id) = @_;
1934 :     my $relational_db_response;
1935 :     my $rdbH = $self->db_handle;
1936 :    
1937 :     if ($prot_id =~ /^fig\|/)
1938 :     {
1939 :     my( $gs, $domain ) = $self->genus_species_domain($self->genome_of($prot_id));
1940 :     return ( $gs, domain_color( $domain ) );
1941 :     }
1942 :    
1943 :     if (($relational_db_response = $rdbH->SQL("SELECT org FROM external_orgs WHERE ( prot = \'$prot_id\' )")) &&
1944 :     (@$relational_db_response >= 1))
1945 :     {
1946 :     return ($relational_db_response->[0]->[0], "#FFFFFF");
1947 :     }
1948 :     return ("", "#FFFFFF");
1949 :     }
1950 :    
1951 :     #
1952 :     # End of support for colorizing organisms by domain
1953 :     # -- GJO
1954 :     #
1955 :    
1956 : efrank 1.1 =pod
1957 :    
1958 :     =head1 abbrev
1959 :    
1960 :     usage: $abbreviated_name = $fig->abbrev($genome_name)
1961 :    
1962 :     For alignments and such, it is very useful to be able to produce an abbreviation of genus/species.
1963 :     That's what this does. Note that multiple genus/species might reduce to the same abbreviation, so
1964 :     be careful (disambiguate them, if you must).
1965 :    
1966 :     =cut
1967 :    
1968 : olson 1.111 sub abbrev :scalar {
1969 :     shift if UNIVERSAL::isa($_[0],__PACKAGE__);
1970 : efrank 1.1 my($genome_name) = @_;
1971 :    
1972 :     $genome_name =~ s/^(\S{3})\S+/$1./;
1973 :     $genome_name =~ s/^(\S+\s+\S{4})\S+/$1./;
1974 :     if (length($genome_name) > 13)
1975 :     {
1976 :     $genome_name = substr($genome_name,0,13);
1977 :     }
1978 :     return $genome_name;
1979 :     }
1980 :    
1981 :     ################ Routines to process Features and Feature IDs ##########################
1982 :    
1983 :     =pod
1984 :    
1985 :     =head1 ftype
1986 :    
1987 :     usage: $type = &FIG::ftype($fid)
1988 :    
1989 :     Returns the type of a feature, given the feature ID. This just amounts
1990 :     to lifting it out of the feature ID, since features have IDs of tghe form
1991 :    
1992 :     fig|x.y.f.n
1993 :    
1994 :     where
1995 :     x.y is the genome ID
1996 :     f is the type pf feature
1997 :     n is an integer that is unique within the genome/type
1998 :    
1999 :     =cut
2000 :    
2001 :     sub ftype {
2002 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
2003 : efrank 1.1 my($feature_id) = @_;
2004 :    
2005 :     if ($feature_id =~ /^fig\|\d+\.\d+\.([^\.]+)/)
2006 :     {
2007 :     return $1;
2008 :     }
2009 :     return undef;
2010 :     }
2011 :    
2012 :     =pod
2013 :    
2014 :     =head1 genome_of
2015 :    
2016 :     usage: $genome_id = $fig->genome_of($fid)
2017 :    
2018 :     This just extracts the genome ID from a feature ID.
2019 :    
2020 :     =cut
2021 :    
2022 :    
2023 : olson 1.113 sub genome_of :scalar {
2024 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
2025 : efrank 1.1 my $prot_id = (@_ == 1) ? $_[0] : $_[1];
2026 :    
2027 :     if ($prot_id =~ /^fig\|(\d+\.\d+)/) { return $1; }
2028 :     return undef;
2029 :     }
2030 :    
2031 : olson 1.96 =head1 genome_and_peg_of
2032 :    
2033 :     usage: ($genome_id, $peg_number = $fig->genome_and_peg_of($fid)
2034 :    
2035 :     This just extracts the genome ID and peg number from a feature ID.
2036 :    
2037 :     =cut
2038 :    
2039 :    
2040 :     sub genome_and_peg_of {
2041 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
2042 : olson 1.96 my $prot_id = (@_ == 1) ? $_[0] : $_[1];
2043 :    
2044 :     if ($prot_id =~ /^fig\|(\d+\.\d+)\.peg\.(\d+)/)
2045 :     {
2046 :     return ($1, $2);
2047 :     }
2048 :     return undef;
2049 :     }
2050 :    
2051 : efrank 1.1 =pod
2052 :    
2053 :     =head1 by_fig_id
2054 :    
2055 :     usage: @sorted_by_fig_id = sort { &FIG::by_fig_id($a,$b) } @fig_ids
2056 :    
2057 :     This is a bit of a clutzy way to sort a list of FIG feature IDs, but it works.
2058 :    
2059 :     =cut
2060 :    
2061 :     sub by_fig_id {
2062 :     my($a,$b) = @_;
2063 :     my($g1,$g2,$t1,$t2,$n1,$n2);
2064 :     if (($a =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g1,$t1,$n1) = ($1,$2,$3)) &&
2065 :     ($b =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g2,$t2,$n2) = ($1,$2,$3)))
2066 :     {
2067 :     ($g1 <=> $g2) or ($t1 cmp $t2) or ($n1 <=> $n2);
2068 :     }
2069 :     else
2070 :     {
2071 :     $a cmp $b;
2072 :     }
2073 :     }
2074 :    
2075 :     =pod
2076 :    
2077 :     =head1 genes_in_region
2078 :    
2079 :     usage: ($features_in_region,$beg1,$end1) = $fig->genes_in_region($genome,$contig,$beg,$end)
2080 :    
2081 :     It is often important to be able to find the genes that occur in a specific region on
2082 :     a chromosome. This routine is designed to provide this information. It returns all genes
2083 :     that overlap the region ($genome,$contig,$beg,$end). $beg1 is set to the minimum coordinate of
2084 :     the returned genes (which may be before the given region), and $end1 the maximum coordinate.
2085 :    
2086 :     The routine assumes that genes are not more than 10000 bases long, which is certainly not true
2087 :     in eukaryotes. Hence, in euks you may well miss genes that overlap the boundaries of the specified
2088 :     region (sorry).
2089 :    
2090 :     =cut
2091 :    
2092 :    
2093 :     sub genes_in_region {
2094 :     my($self,$genome,$contig,$beg,$end) = @_;
2095 :     my($x,$relational_db_response,$feature_id,$b1,$e1,@feat,@tmp,$l,$u);
2096 :    
2097 :     my $pad = 10000;
2098 :     my $rdbH = $self->db_handle;
2099 :    
2100 :     my $minV = $beg - $pad;
2101 :     my $maxV = $end + $pad;
2102 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM features
2103 : golsen 1.141 WHERE ( minloc > $minV ) AND ( minloc < $maxV ) AND ( maxloc < $maxV) AND
2104 : efrank 1.1 ( genome = \'$genome\' ) AND ( contig = \'$contig\' );")) &&
2105 :     (@$relational_db_response >= 1))
2106 :     {
2107 :     @tmp = sort { ($a->[1] cmp $b->[1]) or
2108 : overbeek 1.129 (($a->[2]+$a->[3]) <=> ($b->[2]+$b->[3]))
2109 : efrank 1.1 }
2110 :     map { $feature_id = $_->[0];
2111 :     $x = $self->feature_location($feature_id);
2112 :     $x ? [$feature_id,&boundaries_of($x)] : ()
2113 :     } @$relational_db_response;
2114 :    
2115 :    
2116 :     ($l,$u) = (10000000000,0);
2117 :     foreach $x (@tmp)
2118 :     {
2119 :     ($feature_id,undef,$b1,$e1) = @$x;
2120 :     if (&between($beg,&min($b1,$e1),$end) || &between(&min($b1,$e1),$beg,&max($b1,$e1)))
2121 :     {
2122 : overbeek 1.136 if (! $self->is_deleted_fid($feature_id))
2123 :     {
2124 :     push(@feat,$feature_id);
2125 :     $l = &min($l,&min($b1,$e1));
2126 :     $u = &max($u,&max($b1,$e1));
2127 :     }
2128 : efrank 1.1 }
2129 :     }
2130 :     (@feat <= 0) || return ([@feat],$l,$u);
2131 :     }
2132 :     return ([],$l,$u);
2133 :     }
2134 :    
2135 : golsen 1.141
2136 :     #=============================================================================
2137 :     # Using the following version is better, but it brings out a very annoying
2138 :     # issue with some genomes. It already exists in the current code (above)
2139 :     # for some genes in some genomes. For example, visit fig|70601.1.peg.1.
2140 :     # This is true for any genome that has a feature that crosses the origin.
2141 :     # The root of the problem lies in boundaries_of. I am working on a fix that
2142 :     # replaces boundaries_of with a more sophisticated function. When it is
2143 :     # all done, genes_in_retion should behave as desired. -- GJO, Aug. 22, 2004
2144 :     #=============================================================================
2145 :     #
2146 :     # =pod
2147 :     #
2148 :     # =head1 genes_in_region
2149 :     #
2150 :     # usage: ( $features_in_region, $min_coord, $max_coord )
2151 :     # = $fig->genes_in_region( $genome, $contig, $beg, $end )
2152 :     #
2153 :     # It is often important to be able to find the genes that occur in a specific
2154 :     # region on a chromosome. This routine is designed to provide this information.
2155 :     # It returns all genes that overlap the region ( $genome, $contig, $beg, $end ).
2156 :     # $min_coord is set to the minimum coordinate of the returned genes (which may
2157 :     # preceed the given region), and $max_coord the maximum coordinate. Because
2158 :     # the database is indexed by the leftmost and rightmost coordinates of each
2159 :     # feature, the function makes no assumption about the length of the feature, but
2160 :     # it can (and probably will) miss features spanning multiple contigs.
2161 :     #
2162 :     # =cut
2163 :     #
2164 :     #
2165 :     # sub genes_in_region {
2166 :     # my ( $self, $genome, $contig, $beg, $end ) = @_;
2167 :     # my ( $x, $db_response, $feature_id, $b1, $e1, @tmp, @bounds );
2168 :     # my ( $min_coord, $max_coord );
2169 :     #
2170 :     # my @features = ();
2171 :     # my $rdbH = $self->db_handle;
2172 :     #
2173 :     # if ( ( $db_response = $rdbH->SQL( "SELECT id
2174 :     # FROM features
2175 :     # WHERE ( contig = '$contig' )
2176 :     # AND ( genome = '$genome' )
2177 :     # AND ( minloc <= $end )
2178 :     # AND ( maxloc >= $beg );"
2179 :     # )
2180 :     # )
2181 :     # && ( @$db_response > 0 )
2182 :     # )
2183 :     # {
2184 :     # # The sort is unnecessary, but provides a consistent ordering
2185 :     #
2186 :     # @tmp = sort { ( $a->[1] cmp $b->[1] ) # contig
2187 :     # || ( ($a->[2] + $a->[3] ) <=> ( $b->[2] + $b->[3] ) ) # midpoint
2188 :     # }
2189 :     # map { $feature_id = $_->[0];
2190 :     # ( ( ! $self->is_deleted_fid( $feature_id ) ) # not deleted
2191 :     # && ( $x = $self->feature_location( $feature_id ) ) # and has location
2192 :     # && ( ( @bounds = boundaries_of( $x ) ) == 3 ) # and has bounds
2193 :     # ) ? [ $feature_id, @bounds ] : ()
2194 :     # } @$db_response;
2195 :     #
2196 :     # ( $min_coord, $max_coord ) = ( 10000000000, 0 );
2197 :     #
2198 :     # foreach $x ( @tmp )
2199 :     # {
2200 :     # ( $feature_id, undef, $b1, $e1 ) = @$x;
2201 :     # push @features, $feature_id;
2202 :     # my ( $min, $max ) = ( $b1 <= $e1 ) ? ( $b1, $e1 ) : ( $e1, $b1 );
2203 :     # ( $min_coord <= $min ) || ( $min_coord = $min );
2204 :     # ( $max_coord >= $max ) || ( $max_coord = $max );
2205 :     # }
2206 :     # }
2207 :     #
2208 :     # return ( @features ) ? ( [ @features ], $min_coord, $max_coord )
2209 :     # : ( [], undef, undef );
2210 :     # }
2211 :    
2212 :     # These will be part of the fix to genes_in_region. -- GJO
2213 :    
2214 :     =pod
2215 :    
2216 :     =head1 regions_spanned
2217 :    
2218 :     usage: ( [ $contig, $beg, $end ], ... ) = $fig->regions_spanned( $loc )
2219 :    
2220 :     The location of a feature in a scalar context is
2221 :    
2222 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each segment]
2223 :    
2224 :     This routine takes as input a fig location and reduces it to one or more
2225 :     regions spanned by the gene. Unlike boundaries_of, regions_spanned handles
2226 :     wrapping through the orgin, features split over contigs and exons that are
2227 :     not ordered nicely along the chromosome (ugly but true).
2228 :    
2229 :     =cut
2230 :    
2231 :     sub regions_spanned {
2232 :     shift if UNIVERSAL::isa( $_[0], __PACKAGE__ );
2233 :     my( $location ) = ( @_ == 1 ) ? $_[0] : $_[1];
2234 :     defined( $location ) || return undef;
2235 :    
2236 :     my @regions = ();
2237 :    
2238 :     my ( $cur_contig, $cur_beg, $cur_end, $cur_dir );
2239 :     my ( $contig, $beg, $end, $dir );
2240 :     my @segs = split( /\s*,\s*/, $location ); # should not have space, but ...
2241 :     @segs || return undef;
2242 :    
2243 :     # Process the first segment
2244 :    
2245 :     my $seg = shift @segs;
2246 :     ( ( $cur_contig, $cur_beg, $cur_end ) = ( $seg =~ /^(\S+)_(\d+)_\d+$/ ) )
2247 :     || return undef;
2248 :     $cur_dir = ( $cur_end >= $cur_beg ) ? 1 : -1;
2249 :    
2250 :     foreach $seg ( @segs ) {
2251 :     ( ( $contig, $beg, $end ) = ( $seg =~ /^(\S+)_(\d+)_\d+$/ ) ) || next;
2252 :     $dir = ( $end >= $beg ) ? 1 : -1;
2253 :    
2254 :     # Is this a continuation? Update end
2255 :    
2256 :     if ( ( $contig eq $cur_contig )
2257 :     && ( $dir == $cur_dir )
2258 :     && ( ( ( $dir > 0 ) && ( $end > $cur_end ) )
2259 :     || ( ( $dir < 0 ) && ( $end < $cur_end ) ) )
2260 :     )
2261 :     {
2262 :     $cur_end = $end;
2263 :     }
2264 :    
2265 :     # Not a continuation. Report previous and update current.
2266 :    
2267 :     else
2268 :     {
2269 :     push @regions, [ $cur_contig, $cur_beg, $cur_end ];
2270 :     ( $cur_contig, $cur_beg, $cur_end, $cur_dir )
2271 :     = ( $contig, $beg, $end, $dir );
2272 :     }
2273 :     }
2274 :    
2275 :     # There should alwasy be a valid, unreported region.
2276 :    
2277 :     push @regions, [ $cur_contig, $cur_beg, $cur_end ];
2278 :    
2279 :     return wantarray ? @regions : \@regions;
2280 :     }
2281 :    
2282 :    
2283 :     =pod
2284 :    
2285 :     =head1 filter_regions
2286 :    
2287 :     usage: @regions = filter_regions( $contig, $min, $max, @regions )
2288 :     \@regions = filter_regions( $contig, $min, $max, @regions )
2289 :     @regions = filter_regions( $contig, $min, $max, \@regions )
2290 :     \@regions = filter_regions( $contig, $min, $max, \@regions )
2291 :    
2292 :     This function provides a simple filter for extracting a list of genome regions
2293 :     for those that overlap a particular interval. Region definitions correspond
2294 :     to those produced by regions_spanned. That is, [ contig, beg, end ]. In the
2295 :     function call, either $contig or $min and $max can be undefined (permitting
2296 :     anything).
2297 :    
2298 :     =cut
2299 :    
2300 :     sub filter_regions {
2301 :     my ( $contig, $min, $max, @regions ) = @_;
2302 :    
2303 :     @regions || return ();
2304 :     ( ref( $regions[0] ) eq "ARRAY" ) || return undef;
2305 :    
2306 :     # Is it a region list, or a reference to a region list?
2307 :    
2308 :     if ( ref( $regions[0]->[0] ) eq "ARRAY" ) { @regions = @{ $regions[0] } }
2309 :    
2310 :     if ( ! defined( $contig ) )
2311 :     {
2312 :     ( defined( $min ) && defined( $max ) ) || return undef;
2313 :     }
2314 :     else # with a defined contig name, allow undefined range
2315 :     {
2316 :     defined( $min ) || ( $min = 1 );
2317 :     defined( $max ) || ( $max = 1000000000 );
2318 :     }
2319 :     ( $min <= $max ) || return ();
2320 :    
2321 :     my ( $c, $b, $e );
2322 :     my @filtered = grep { ( @$_ >= 3 ) # Allow extra fields?
2323 :     && ( ( $c, $b, $e ) = @$_ )
2324 :     && ( ( ! defined( $contig ) ) || ( $c eq $contig ) )
2325 :     && ( ( $e >= $b ) || ( ( $b, $e ) = ( $e, $b ) ) )
2326 :     && ( ( $b <= $max ) && ( $e >= $min ) )
2327 :     } @regions;
2328 :    
2329 :     return wantarray ? @filtered : \@filtered;
2330 :     }
2331 :    
2332 :    
2333 : efrank 1.1 sub close_genes {
2334 :     my($self,$fid,$dist) = @_;
2335 : mkubal 1.147
2336 :     # warn "In close_genes, self=$self, fid=$fid";
2337 :    
2338 : efrank 1.1 my $loc = $self->feature_location($fid);
2339 :     if ($loc)
2340 :     {
2341 :     my($contig,$beg,$end) = &FIG::boundaries_of($loc);
2342 :     if ($contig && $beg && $end)
2343 :     {
2344 :     my $min = &min($beg,$end) - $dist;
2345 :     my $max = &max($beg,$end) + $dist;
2346 :     my $feat;
2347 :     ($feat,undef,undef) = $self->genes_in_region(&FIG::genome_of($fid),$contig,$min,$max);
2348 :     return @$feat;
2349 :     }
2350 :     }
2351 :     return ();
2352 :     }
2353 :    
2354 : mkubal 1.147 sub adjacent_genes
2355 :     {
2356 :     my ($self, $fid, $dist) = @_;
2357 :     my (@close, $strand, $i);
2358 :    
2359 :     # warn "In adjacent_genes, self=$self, fid=$fid";
2360 :    
2361 :    
2362 :     $strand = $self->strand_of($fid);
2363 :    
2364 :     $dist = $dist || 2000;
2365 :     @close = $self->close_genes($fid, $dist);
2366 :     for ($i=0; $i < @close; ++$i) { last if ($close[$i] eq $fid); }
2367 : redwards 1.157
2368 :     # RAE note that if $self->strand_of($close[$i-1]) ne $strand then left/right neighbors
2369 :     # were never set! oops!
2370 :    
2371 :     # I think the concept of Left and right is confused here. In my mind, left and right
2372 :     # are independent of strand ?? E.g. take a look at PEG fig|196600.1.peg.1806
2373 :     # this is something like
2374 :     #
2375 :     # ---> <--1805--- --1806--> <--1807-- <----
2376 :     #
2377 :     # 1805 is always the left neighbor, no?
2378 :    
2379 :     my ($left_neighbor, $right_neighbor) = ($close[$i-1], $close[$i+1]);
2380 : mkubal 1.147
2381 : redwards 1.157 if (0) # this was if ($i > 0) I just skip this whole section!
2382 : mkubal 1.147 {
2383 :     if ($self->strand_of($close[$i-1]) eq $strand) { $left_neighbor = $close[$i-1]; }
2384 : redwards 1.157 # else {$left_neighbor=$close[$i+1]} # RAE: this is the alternative that is needed if you do it by strand
2385 : mkubal 1.147 }
2386 :    
2387 :     if ($i < $#close)
2388 :     {
2389 :     if ($self->strand_of($close[$i+1]) eq $strand) { $right_neighbor = $close[$i+1]; }
2390 : redwards 1.157 # else {$right_neighbor = $close[$i-1]} # RAE: this is the alternative that is needed if you do it by strand
2391 : mkubal 1.147 }
2392 :    
2393 :     # ...return genes in transcription order...
2394 : redwards 1.164 if ($strand eq '-')
2395 : mkubal 1.147 {
2396 :     ($left_neighbor, $right_neighbor) = ($right_neighbor, $left_neighbor);
2397 :     }
2398 :    
2399 :     return ($left_neighbor, $right_neighbor) ;
2400 :     }
2401 :    
2402 : efrank 1.1
2403 :     =pod
2404 :    
2405 :     =head1 feature_location
2406 :    
2407 :     usage: $loc = $fig->feature_location($fid) OR
2408 :     @loc = $fig->feature_location($fid)
2409 :    
2410 :     The location of a feature in a scalar context is
2411 :    
2412 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
2413 :    
2414 :     In a list context it is
2415 :    
2416 :     (contig_b1_e1,contig_b2_e2,...)
2417 :    
2418 :     =cut
2419 :    
2420 : olson 1.111 sub feature_location :scalar :list {
2421 : efrank 1.1 my($self,$feature_id) = @_;
2422 :     my($relational_db_response,$locations,$location);
2423 : mkubal 1.147
2424 :     # warn "In feature_location, self=$self, fid=$feature_id";
2425 :    
2426 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return undef }
2427 :    
2428 : efrank 1.1 $locations = $self->cached('_location');
2429 :     if (! ($location = $locations->{$feature_id}))
2430 :     {
2431 :     my $rdbH = $self->db_handle;
2432 :     if (($relational_db_response = $rdbH->SQL("SELECT location FROM features WHERE ( id = \'$feature_id\' )")) &&
2433 :     (@$relational_db_response == 1))
2434 :     {
2435 :     $locations->{$feature_id} = $location = $relational_db_response->[0]->[0];
2436 :     }
2437 :     }
2438 :    
2439 :     if ($location)
2440 :     {
2441 :     return wantarray() ? split(/,/,$location) : $location;
2442 :     }
2443 :     return undef;
2444 :     }
2445 :    
2446 : mkubal 1.147 sub contig_of
2447 :     {
2448 :     my ($self, $locus) = @_;
2449 :    
2450 : olson 1.159 $locus =~ m/^([^,]+)_\d+_\d+/;
2451 : mkubal 1.147
2452 :     return $1;
2453 :     }
2454 :    
2455 :     sub beg_of
2456 :     {
2457 :     my ($self, $locus) = @_;
2458 :    
2459 : olson 1.159 $locus =~ m/^[^,]+_(\d+)_\d+/;
2460 : mkubal 1.147
2461 :     return $1;
2462 :     }
2463 :    
2464 :     sub end_of
2465 :     {
2466 :     my ($self, $locus) = @_;
2467 :    
2468 :     $locus =~ m/\S+_\d+_(\d+)$/;
2469 :    
2470 :     return $1;
2471 :     }
2472 :    
2473 :     sub strand_of
2474 :     {
2475 :     my ($self, $fid) = @_;
2476 :     my ($beg, $end);
2477 :    
2478 :     # warn "In strand_of, self=$self, fid=$fid";
2479 :    
2480 :     (undef, $beg, $end) = $self->boundaries_of($self->feature_location($fid));
2481 :    
2482 :     if ($beg < $end) { return '+'; } else { return '-'; }
2483 :     }
2484 :    
2485 : olson 1.158 =pod
2486 :    
2487 :     =head1 find_contig_with_checksum
2488 :    
2489 :     Find a contig in the given genome with the given checksum.
2490 :    
2491 :    
2492 :     =cut
2493 :    
2494 :     sub find_contig_with_checksum
2495 :     {
2496 :     my($self, $genome, $checksum) = @_;
2497 :    
2498 :     #
2499 :     # This implementation scans all the contig files for the organism; when
2500 :     # we have contig checksums in the database this will simplify
2501 :     # significantly.
2502 :     #
2503 :     # For some efficiency, we cache the checksums we compute along the way since
2504 :     # it's probably likely we'll poke at other contigs for this organism.
2505 :     #
2506 :    
2507 :     my $gdir = "$FIG_Config::organisms/$genome";
2508 :    
2509 :     my $cached_cksum = $self->cached('_contig_checksum');
2510 :    
2511 :     if (opendir(my $dh, $gdir))
2512 :     {
2513 :     for my $file (map { "$gdir/$_" } grep { $_ =~ /^contigs\d*$/ } readdir($dh))
2514 :     {
2515 :     local $/ = "\n>";
2516 :    
2517 :     if (open(my $fh, "<$file"))
2518 :     {
2519 :     while (<$fh>)
2520 :     {
2521 :     chomp;
2522 : olson 1.160
2523 :     #
2524 :     # Pull the contig identifier from the first line.
2525 :     # We need the >? to handle the first line in the file;
2526 :     # the others are removed by the chomp above because
2527 :     # $/ is set to "\n>";
2528 :     #
2529 :    
2530 :     if (s/^>?\s*(\S+)([^\n]*)\n//)
2531 : olson 1.158 {
2532 :     my $ident = $1;
2533 :     my $contig_txt = $_;
2534 :    
2535 :     $contig_txt =~ s/\s//sg;
2536 :     $contig_txt = uc($contig_txt);
2537 :    
2538 :     #
2539 :     # See if we have a cached value.
2540 :     #
2541 :    
2542 :     my $this_checksum;
2543 :     $this_checksum = $cached_cksum->{$genome, $ident};
2544 :     if (!$this_checksum)
2545 :     {
2546 :    
2547 :     my($rd, $wr, $pid);
2548 :    
2549 :     if (!($pid = open2($rd, $wr, "cksum")))
2550 :     {
2551 :     die "Cannot run open2 cksum: $!";
2552 :     }
2553 :    
2554 :     $wr->write($contig_txt, length($contig_txt));
2555 :    
2556 :     close($wr);
2557 :    
2558 :     $_ = <$rd>;
2559 :     close($rd);
2560 :     waitpid $pid, 0;
2561 :     chomp;
2562 :    
2563 :     my @vals = split(/\s+/, $_);
2564 :     $this_checksum = $vals[0];
2565 :     $cached_cksum->{$genome, $ident} = $this_checksum;
2566 :     }
2567 :     if ($this_checksum == $checksum)
2568 :     {
2569 :     return $ident;
2570 :     }
2571 :     }
2572 :     }
2573 :     }
2574 :     }
2575 :     }
2576 :     }
2577 :    
2578 :     sub contig_checksum
2579 :     {
2580 :     my($self, $genome, $contig) = @_;
2581 :    
2582 :     my $contig_txt = $self->read_contig($genome, $contig);
2583 :    
2584 :     $contig_txt =~ s/\s//sg;
2585 :     $contig_txt = uc($contig_txt);
2586 :    
2587 : olson 1.159 my($rd, $wr, $pid);
2588 : olson 1.158
2589 : olson 1.159 if (!($pid = open2($rd, $wr, "cksum")))
2590 : olson 1.158 {
2591 :     die "Cannot run open2 cksum: $!";
2592 :     }
2593 :    
2594 :     $wr->write($contig_txt, length($contig_txt));
2595 :    
2596 :     close($wr);
2597 :    
2598 :     $_ = <$rd>;
2599 : olson 1.159 close($rd);
2600 :     waitpid $pid, 0;
2601 :    
2602 : olson 1.158 chomp;
2603 :     my @vals = split(/\s+/, $_);
2604 :     if (wantarray)
2605 :     {
2606 :     return @vals;
2607 :     }
2608 :     else
2609 :     {
2610 :     return $vals[0];
2611 :     }
2612 :     }
2613 :    
2614 :     =pod
2615 :    
2616 :     =head1 read_contig
2617 :    
2618 :     Read a single contig from the contigs file.
2619 :    
2620 :     =cut
2621 :     sub read_contig
2622 :     {
2623 :     my($self, $genome, $contig) = @_;
2624 :    
2625 :     #
2626 :     # Read the contig. The database has it in a set of chunks, but we
2627 :     # just use the seek to the starting point, and read up to the next "\n>".
2628 :     #
2629 :    
2630 :     my $ret = $self->db_handle->SQL(qq!SELECT fileno, seek FROM contig_seeks
2631 :     WHERE genome = '$genome' and contig = '$contig' and
2632 :     startn = 0!);
2633 :     if (!$ret or @$ret != 1)
2634 :     {
2635 :     return undef;
2636 :     }
2637 :    
2638 :     my($fileno, $seek) = @{$ret->[0]};
2639 :     my $file = $self->N2file($fileno);
2640 :    
2641 :     my($fh, $contig_txt);
2642 :    
2643 :     if (!open($fh, "<$file"))
2644 :     {
2645 :     warn "contig_checksum: could not open $file: $!\n";
2646 :     return undef;
2647 :     }
2648 :    
2649 :     seek($fh, $seek, 0);
2650 :    
2651 :     {
2652 :     local $/ = "\n>";
2653 :    
2654 :     $contig_txt = <$fh>;
2655 :     chomp($contig_txt);
2656 :     }
2657 :    
2658 :     return $contig_txt;
2659 :     }
2660 : mkubal 1.147
2661 : efrank 1.1 =pod
2662 :    
2663 :     =head1 boundaries_of
2664 :    
2665 :     usage: ($contig,$beg,$end) = $fig->boundaries_of($loc)
2666 :    
2667 :     The location of a feature in a scalar context is
2668 :    
2669 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
2670 :    
2671 :     This routine takes as input such a location and reduces it to a single
2672 :     description of the entire region containing the gene.
2673 :    
2674 :     =cut
2675 :    
2676 :     sub boundaries_of {
2677 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
2678 : efrank 1.1 my($location) = (@_ == 1) ? $_[0] : $_[1];
2679 :     my($contigQ);
2680 :    
2681 :     if (defined($location))
2682 :     {
2683 :     my @exons = split(/,/,$location);
2684 :     my($contig,$beg,$end);
2685 :     if (($exons[0] =~ /^(\S+)_(\d+)_\d+$/) &&
2686 :     (($contig,$beg) = ($1,$2)) && ($contigQ = quotemeta $contig) &&
2687 :     ($exons[$#exons] =~ /^$contigQ\_\d+_(\d+)$/) &&
2688 :     ($end = $1))
2689 :     {
2690 :     return ($contig,$beg,$end);
2691 :     }
2692 :     }
2693 :     return undef;
2694 :     }
2695 :    
2696 :    
2697 :     =pod
2698 :    
2699 :     =head1 all_features
2700 :    
2701 :     usage: $fig->all_features($genome,$type)
2702 :    
2703 :     Returns a list of all feature IDs of a specified type in the designated genome. You would
2704 :     usually use just
2705 :    
2706 :     $fig->pegs_of($genome) or
2707 :     $fig->rnas_of($genome)
2708 :    
2709 :     which simply invoke this routine.
2710 :    
2711 :     =cut
2712 :    
2713 :     sub all_features {
2714 :     my($self,$genome,$type) = @_;
2715 :    
2716 :     my $rdbH = $self->db_handle;
2717 :     my $relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE (genome = \'$genome\' AND (type = \'$type\'))");
2718 :    
2719 :     if (@$relational_db_response > 0)
2720 :     {
2721 : overbeek 1.136 return grep { ! $self->is_deleted_fid($_) } map { $_->[0] } @$relational_db_response;
2722 : efrank 1.1 }
2723 :     return ();
2724 :     }
2725 :    
2726 :    
2727 :     =pod
2728 :    
2729 : overbeek 1.152 =head1 pegs_of
2730 : efrank 1.1
2731 : overbeek 1.152 usage: $fig->pegs_of($genome)
2732 : efrank 1.1
2733 :     Returns a list of all PEGs in the specified genome. Note that order is not
2734 :     specified.
2735 :    
2736 :     =cut
2737 :    
2738 :     sub pegs_of {
2739 :     my($self,$genome) = @_;
2740 :    
2741 :     return $self->all_features($genome,"peg");
2742 :     }
2743 :    
2744 :    
2745 :     =pod
2746 :    
2747 : overbeek 1.152 =head1 rnas_of
2748 : efrank 1.1
2749 : overbeek 1.152 usage: $fig->rnas_of($genome)
2750 : efrank 1.1
2751 :     Returns a list of all RNAs for the given genome.
2752 :    
2753 :     =cut
2754 :    
2755 :     sub rnas_of {
2756 :     my($self,$genome) = @_;
2757 :    
2758 :     return $self->all_features($genome,"rna");
2759 :     }
2760 :    
2761 :     =pod
2762 :    
2763 :     =head1 feature_aliases
2764 :    
2765 :     usage: @aliases = $fig->feature_aliases($fid) OR
2766 :     $aliases = $fig->feature_aliases($fid)
2767 :    
2768 :     Returns a list of aliases (gene IDs, arbitrary numbers assigned by authors, etc.) for the feature.
2769 :     These must come from the tbl files, so add them there if you want to see them here.
2770 :    
2771 :     In a scalar context, the aliases come back with commas separating them.
2772 :    
2773 :     =cut
2774 :    
2775 :     sub feature_aliases {
2776 :     my($self,$feature_id) = @_;
2777 : overbeek 1.87 my($rdbH,$relational_db_response,@aliases,$aliases,%aliases,$x);
2778 : efrank 1.1
2779 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return undef }
2780 :    
2781 : efrank 1.1 $rdbH = $self->db_handle;
2782 : overbeek 1.87 @aliases = ();
2783 : efrank 1.1 if (($relational_db_response = $rdbH->SQL("SELECT aliases FROM features WHERE ( id = \'$feature_id\' )")) &&
2784 :     (@$relational_db_response == 1))
2785 :     {
2786 :     $aliases = $relational_db_response->[0]->[0];
2787 : overbeek 1.87 %aliases = map { $_ => 1 } split(/,/,$aliases);
2788 :     if (($relational_db_response = $rdbH->SQL("SELECT alias FROM ext_alias WHERE ( id = \'$feature_id\' )")) &&
2789 :     (@$relational_db_response > 0))
2790 :     {
2791 :     foreach $x (@$relational_db_response)
2792 :     {
2793 :     $aliases{$x->[0]} = 1;
2794 :     }
2795 :     }
2796 :     @aliases = sort keys(%aliases);
2797 : efrank 1.1 }
2798 : overbeek 1.87
2799 : overbeek 1.131 return wantarray() ? @aliases : join(",",@aliases);
2800 : efrank 1.1 }
2801 :    
2802 :     =pod
2803 :    
2804 : overbeek 1.34 =head1 by_alias
2805 :    
2806 :     usage: $peg = $fig->by_alias($alias)
2807 :    
2808 :     Returns a FIG id if the alias can be converted. Right now we convert aliases
2809 :     of the form NP_* (RefSeq IDs) or gi|* (GenBank IDs)
2810 :    
2811 :     =cut
2812 :    
2813 :     sub by_alias {
2814 : overbeek 1.148 my($self,$alias,$genome) = @_;
2815 : overbeek 1.34 my($rdbH,$relational_db_response,$peg);
2816 : overbeek 1.148
2817 :     my $genomeQ = $genome ? quotemeta $genome : "";
2818 : overbeek 1.86 if ($alias =~ /^fig\|\d+\.\d+\.peg\.\d+$/) { return $alias }
2819 :    
2820 : overbeek 1.34 $peg = "";
2821 :     $rdbH = $self->db_handle;
2822 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM ext_alias WHERE ( alias = \'$alias\' )")) &&
2823 :     (@$relational_db_response == 1))
2824 :     {
2825 :     $peg = $relational_db_response->[0]->[0];
2826 :     }
2827 : overbeek 1.148 else
2828 :     {
2829 :     my @poss = grep { $_ =~ /^fig\|/ } map { $_->[0] } $self->mapped_prot_ids($alias);
2830 :     if ($genomeQ)
2831 :     {
2832 :    
2833 :     @poss = grep { $_ =~ /^fig\|$genomeQ/ } @poss;
2834 :     }
2835 :    
2836 :     if (@poss == 1)
2837 :     {
2838 :     $peg = $poss[0];
2839 :     }
2840 :     }
2841 : overbeek 1.34 return $peg;
2842 :     }
2843 :    
2844 :     =pod
2845 :    
2846 : efrank 1.1 =head1 possibly_truncated
2847 :    
2848 :     usage: $fig->possibly_truncated($fid)
2849 :    
2850 :     Returns true iff the feature occurs near the end of a contig.
2851 :    
2852 :     =cut
2853 :    
2854 :     sub possibly_truncated {
2855 :     my($self,$feature_id) = @_;
2856 :     my($loc);
2857 :    
2858 :     if ($loc = $self->feature_location($feature_id))
2859 :     {
2860 :     my $genome = &genome_of($feature_id);
2861 :     my ($contig,$beg,$end) = &boundaries_of($loc);
2862 :     if ((! $self->near_end($genome,$contig,$beg)) && (! $self->near_end($genome,$contig,$end)))
2863 :     {
2864 :     return 0;
2865 :     }
2866 :     }
2867 :     return 1;
2868 :     }
2869 :    
2870 :     sub near_end {
2871 :     my($self,$genome,$contig,$x) = @_;
2872 :    
2873 :     return (($x < 300) || ($x > ($self->contig_ln($genome,$contig) - 300)));
2874 :     }
2875 :    
2876 : overbeek 1.27 sub is_real_feature {
2877 :     my($self,$fid) = @_;
2878 :     my($relational_db_response);
2879 :    
2880 : overbeek 1.136 if ($self->is_deleted_fid($fid)) { return 0 }
2881 :    
2882 : overbeek 1.27 my $rdbH = $self->db_handle;
2883 :     return (($relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE ( id = \'$fid\' )")) &&
2884 : mkubal 1.53 (@$relational_db_response == 1)) ? 1 : 0;
2885 : overbeek 1.27 }
2886 :    
2887 : efrank 1.1 ################ Routines to process functional coupling for PEGs ##########################
2888 :    
2889 :     =pod
2890 :    
2891 :     =head1 coupling_and_evidence
2892 :    
2893 :     usage: @coupling_data = $fig->coupling_and_evidence($fid,$bound,$sim_cutoff,$coupling_cutoff,$keep_record)
2894 :    
2895 :     A computation of couplings and evidence starts with a given peg and produces a list of
2896 :     3-tuples. Each 3-tuple is of the form
2897 :    
2898 :     [Score,CoupledToFID,Evidence]
2899 :    
2900 :     Evidence is a list of 2-tuples of FIDs that are close in other genomes (producing
2901 :     a "pair of close homologs" of [$peg,CoupledToFID]). The maximum score for a single
2902 :     PCH is 1, but "Score" is the sum of the scores for the entire set of PCHs.
2903 :    
2904 :     If $keep_record is true, the system records the information, asserting coupling for each
2905 :     of the pairs in the set of evidence, and asserting a pin from the given $fd through all
2906 :     of the PCH entries used in forming the score.
2907 :    
2908 :     =cut
2909 :    
2910 :     sub coupling_and_evidence {
2911 :     my($self,$feature_id,$bound,$sim_cutoff,$coupling_cutoff,$keep_record) = @_;
2912 :     my($neighbors,$neigh,$similar1,$similar2,@hits,$sc,$ev,$genome1);
2913 :    
2914 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return undef }
2915 :    
2916 : efrank 1.1 if ($feature_id =~ /^fig\|(\d+\.\d+)/)
2917 :     {
2918 :     $genome1 = $1;
2919 :     }
2920 : overbeek 1.136 else
2921 :     {
2922 :     return undef;
2923 :     }
2924 : efrank 1.1
2925 :     my($contig,$beg,$end) = &FIG::boundaries_of($self->feature_location($feature_id));
2926 :     if (! $contig) { return () }
2927 :    
2928 :     ($neighbors,undef,undef) = $self->genes_in_region(&genome_of($feature_id),
2929 :     $contig,
2930 :     &min($beg,$end) - $bound,
2931 :     &max($beg,$end) + $bound);
2932 :     if (@$neighbors == 0) { return () }
2933 :     $similar1 = $self->acceptably_close($feature_id,$sim_cutoff);
2934 :     @hits = ();
2935 :    
2936 :     foreach $neigh (grep { $_ =~ /peg/ } @$neighbors)
2937 :     {
2938 :     next if ($neigh eq $feature_id);
2939 :     $similar2 = $self->acceptably_close($neigh,$sim_cutoff);
2940 :     ($sc,$ev) = $self->coupling_ev($genome1,$similar1,$similar2,$bound);
2941 :     if ($sc >= $coupling_cutoff)
2942 :     {
2943 :     push(@hits,[$sc,$neigh,$ev]);
2944 :     }
2945 :     }
2946 :     if ($keep_record)
2947 :     {
2948 :     $self->add_chr_clusters_and_pins($feature_id,\@hits);
2949 :     }
2950 :     return sort { $b->[0] <=> $a->[0] } @hits;
2951 :     }
2952 :    
2953 : overbeek 1.35 sub fast_coupling {
2954 :     my($self,$peg,$bound,$coupling_cutoff) = @_;
2955 :     my($genome,$genome1,$genome2,$peg1,$peg2,$peg3,%maps,$loc,$loc1,$loc2,$loc3);
2956 :     my($pairs,$sc,%ev);
2957 :    
2958 : overbeek 1.136 if ($self->is_deleted_fid($peg)) { return undef }
2959 :    
2960 : overbeek 1.35 my @ans = ();
2961 :    
2962 :     $genome = &genome_of($peg);
2963 :     foreach $peg1 ($self->in_pch_pin_with($peg))
2964 :     {
2965 :     $peg1 =~ s/,.*$//;
2966 :     if ($peg ne $peg1)
2967 :     {
2968 :     $genome1 = &genome_of($peg1);
2969 :     $maps{$peg}->{$genome1} = $peg1;
2970 :     }
2971 :     }
2972 :    
2973 :     $loc = [&boundaries_of(scalar $self->feature_location($peg))];
2974 :     foreach $peg1 ($self->in_cluster_with($peg))
2975 :     {
2976 :     if ($peg ne $peg1)
2977 :     {
2978 :     # print STDERR "peg1=$peg1\n";
2979 :     $loc1 = [&boundaries_of(scalar $self->feature_location($peg1))];
2980 :     if (&close_enough($loc,$loc1,$bound))
2981 :     {
2982 :     foreach $peg2 ($self->in_pch_pin_with($peg1))
2983 :     {
2984 :     $genome2 = &genome_of($peg2);
2985 :     if (($peg3 = $maps{$peg}->{$genome2}) && ($peg2 ne $peg3))
2986 :     {
2987 :     $loc2 = [&boundaries_of(scalar $self->feature_location($peg2))];
2988 :     $loc3 = [&boundaries_of(scalar $self->feature_location($peg3))];
2989 :     if (&close_enough($loc2,$loc3,$bound))
2990 :     {
2991 :     push(@{$ev{$peg1}},[$peg3,$peg2]);
2992 :     }
2993 :     }
2994 :     }
2995 :     }
2996 :     }
2997 :     }
2998 :     foreach $peg1 (keys(%ev))
2999 :     {
3000 :     $pairs = $ev{$peg1};
3001 : overbeek 1.43 $sc = $self->score([$peg,map { $_->[0] } @$pairs]);
3002 : overbeek 1.35 if ($sc >= $coupling_cutoff)
3003 :     {
3004 :     push(@ans,[$sc,$peg1]);
3005 :     }
3006 :     }
3007 :     return sort { $b->[0] <=> $a->[0] } @ans;
3008 :     }
3009 :    
3010 :    
3011 :     sub score {
3012 : overbeek 1.43 my($self,$pegs) = @_;
3013 : overbeek 1.51 my(@ids);
3014 : overbeek 1.35
3015 : overbeek 1.51 if ($self->{_no9s_scoring})
3016 :     {
3017 :     @ids = map { $self->maps_to_id($_) } grep { $_ !~ /^fig\|999999/ } @$pegs;
3018 :     }
3019 :     else
3020 :     {
3021 :     @ids = map { $self->maps_to_id($_) } @$pegs;
3022 :     }
3023 : overbeek 1.43 return &score1($self,\@ids) - 1;
3024 :     }
3025 :    
3026 :     sub score1 {
3027 :     my($self,$pegs) = @_;
3028 :     my($sim);
3029 :     my($first,@rest) = @$pegs;
3030 :     my $count = 1;
3031 :     my %hits = map { $_ => 1 } @rest;
3032 :     my @ordered = sort { $b->[0] <=> $a->[0] }
3033 :     map { $sim = $_; [$sim->iden,$sim->id2] }
3034 :     grep { $hits{$_->id2} }
3035 :     $self->sims($first,1000,1,"raw");
3036 : overbeek 1.76 my %ordered = map { $_->[1] => 1 } @ordered;
3037 :     foreach $_ (@rest)
3038 :     {
3039 :     if (! $ordered{$_})
3040 :     {
3041 :     push(@ordered,[0,$_]);
3042 :     }
3043 :     }
3044 :    
3045 : overbeek 1.43 while ((@ordered > 0) && ($ordered[0]->[0] >= 97))
3046 : overbeek 1.35 {
3047 : overbeek 1.43 shift @ordered ;
3048 :     }
3049 :     while (@ordered > 0)
3050 :     {
3051 :     my $start = $ordered[0]->[0];
3052 :     $_ = shift @ordered;
3053 :     my @sub = ( $_->[1] );
3054 :     while ((@ordered > 0) && ($ordered[0]->[0] > ($start-3)))
3055 : overbeek 1.35 {
3056 : overbeek 1.43 $_ = shift @ordered;
3057 :     push(@sub, $_->[1]);
3058 : overbeek 1.35 }
3059 :    
3060 : overbeek 1.43 if (@sub == 1)
3061 :     {
3062 :     $count++;
3063 :     }
3064 :     else
3065 :     {
3066 :     $count += &score1($self,\@sub);
3067 :     }
3068 : overbeek 1.35 }
3069 : overbeek 1.43 return $count;
3070 : overbeek 1.35 }
3071 :    
3072 : efrank 1.1 =pod
3073 :    
3074 :     =head1 add_chr_clusters_and_pins
3075 :    
3076 :     usage: $fig->add_chr_clusters_and_pins($peg,$hits)
3077 :    
3078 :     The system supports retaining data relating to functional coupling. If a user
3079 :     computes evidence once and then saves it with this routine, data relating to
3080 :     both "the pin" and the "clusters" (in all of the organisms supporting the
3081 :     functional coupling) will be saved.
3082 :    
3083 :     $hits must be a pointer to a list of 3-tuples of the sort returned by
3084 :     $fig->coupling_and_evidence.
3085 :    
3086 :     =cut
3087 :    
3088 :     sub add_chr_clusters_and_pins {
3089 :     my($self,$peg,$hits) = @_;
3090 :     my(@clusters,@pins,$x,$sc,$neigh,$pairs,$y,@corr,@orgs,%projection);
3091 :     my($genome,$cluster,$pin,$peg2);
3092 :    
3093 :     if (@$hits > 0)
3094 :     {
3095 :     @clusters = ();
3096 :     @pins = ();
3097 :     push(@clusters,[$peg,map { $_->[1] } @$hits]);
3098 :     foreach $x (@$hits)
3099 :     {
3100 :     ($sc,$neigh,$pairs) = @$x;
3101 :     push(@pins,[$neigh,map { $_->[1] } @$pairs]);
3102 :     foreach $y (@$pairs)
3103 :     {
3104 :     $peg2 = $y->[0];
3105 :     if ($peg2 =~ /^fig\|(\d+\.\d+)/)
3106 :     {
3107 :     $projection{$1}->{$peg2} = 1;
3108 :     }
3109 :     }
3110 :     }
3111 :     @corr = ();
3112 :     @orgs = keys(%projection);
3113 :     if (@orgs > 0)
3114 :     {
3115 :     foreach $genome (sort { $a <=> $b } @orgs)
3116 :     {
3117 :     push(@corr,sort { &FIG::by_fig_id($a,$b) } keys(%{$projection{$genome}}));
3118 :     }
3119 :     push(@pins,[$peg,@corr]);
3120 :     }
3121 :    
3122 :     foreach $cluster (@clusters)
3123 :     {
3124 :     $self->add_chromosomal_cluster($cluster);
3125 :     }
3126 :    
3127 :     foreach $pin (@pins)
3128 :     {
3129 :     $self->add_pch_pin($pin);
3130 :     }
3131 :     }
3132 :     }
3133 :    
3134 :     sub coupling_ev {
3135 :     my($self,$genome1,$sim1,$sim2,$bound) = @_;
3136 :     my($ev,$sc,$i,$j);
3137 :    
3138 :     $ev = [];
3139 :     $sc = 0;
3140 :    
3141 :     $i = 0;
3142 :     $j = 0;
3143 :     while (($i < @$sim1) && ($j < @$sim2))
3144 :     {
3145 :     if ($sim1->[$i]->[0] < $sim2->[$j]->[0])
3146 :     {
3147 :     $i++;
3148 :     }
3149 :     elsif ($sim1->[$i]->[0] > $sim2->[$j]->[0])
3150 :     {
3151 :     $j++;
3152 :     }
3153 :     else
3154 :     {
3155 :     $sc += $self->accumulate_ev($genome1,$sim1->[$i]->[1],$sim2->[$j]->[1],$bound,$ev);
3156 :     $i++;
3157 :     $j++;
3158 :     }
3159 :     }
3160 : overbeek 1.43 return ($self->score([map { $_->[0] } @$ev]),$ev);
3161 : efrank 1.1 }
3162 :    
3163 :     sub accumulate_ev {
3164 :     my($self,$genome1,$feature_ids1,$feature_ids2,$bound,$ev) = @_;
3165 : overbeek 1.43 my($genome2,@locs1,@locs2,$i,$j,$x);
3166 : efrank 1.1
3167 :     if ((@$feature_ids1 == 0) || (@$feature_ids2 == 0)) { return 0 }
3168 :    
3169 :     $feature_ids1->[0] =~ /^fig\|(\d+\.\d+)/;
3170 :     $genome2 = $1;
3171 :     @locs1 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids1;
3172 :     @locs2 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids2;
3173 :    
3174 :     for ($i=0; ($i < @$feature_ids1); $i++)
3175 :     {
3176 :     for ($j=0; ($j < @$feature_ids2); $j++)
3177 :     {
3178 :     if (($feature_ids1->[$i] ne $feature_ids2->[$j]) &&
3179 :     &close_enough($locs1[$i],$locs2[$j],$bound))
3180 :     {
3181 :     push(@$ev,[$feature_ids1->[$i],$feature_ids2->[$j]]);
3182 :     }
3183 :     }
3184 :     }
3185 :     }
3186 :    
3187 :     sub close_enough {
3188 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
3189 : efrank 1.1 my($locs1,$locs2,$bound) = @_;
3190 :    
3191 :     # print STDERR &Dumper(["close enough",$locs1,$locs2]);
3192 :     return (($locs1->[0] eq $locs2->[0]) && (abs((($locs1->[1]+$locs1->[2])/2) - (($locs2->[1]+$locs2->[2])/2)) <= $bound));
3193 :     }
3194 :    
3195 :     sub acceptably_close {
3196 :     my($self,$feature_id,$sim_cutoff) = @_;
3197 :     my(%by_org,$id2,$genome,$sim);
3198 :    
3199 :     my($ans) = [];
3200 :    
3201 : overbeek 1.31 foreach $sim ($self->sims($feature_id,1000,$sim_cutoff,"fig"))
3202 : efrank 1.1 {
3203 :     $id2 = $sim->id2;
3204 :     if ($id2 =~ /^fig\|(\d+\.\d+)/)
3205 :     {
3206 :     my $genome = $1;
3207 : overbeek 1.51 if (! $self->is_eukaryotic($genome))
3208 : efrank 1.1 {
3209 :     push(@{$by_org{$genome}},$id2);
3210 :     }
3211 :     }
3212 :     }
3213 :     foreach $genome (sort { $a <=> $b } keys(%by_org))
3214 :     {
3215 :     push(@$ans,[$genome,$by_org{$genome}]);
3216 :     }
3217 :     return $ans;
3218 :     }
3219 :    
3220 :     ################ Translations of PEGsand External Protein Sequences ##########################
3221 :    
3222 :    
3223 :     =pod
3224 :    
3225 :     =head1 translatable
3226 :    
3227 :     usage: $fig->translatable($prot_id)
3228 :    
3229 :     The system takes any number of sources of protein sequences as input (and builds an nr
3230 :     for the purpose of computing similarities). For each of these input fasta files, it saves
3231 :     (in the DB) a filename, seek address and length so that it can go get the translation if
3232 :     needed. This routine simply returns true iff info on the translation exists.
3233 :    
3234 :     =cut
3235 :    
3236 :     sub translatable {
3237 :     my($self,$prot) = @_;
3238 :    
3239 :     return &translation_length($self,$prot) ? 1 : 0;
3240 :     }
3241 :    
3242 :    
3243 :     =pod
3244 :    
3245 :     =head1 translation_length
3246 :    
3247 :     usage: $len = $fig->translation_length($prot_id)
3248 :    
3249 :     The system takes any number of sources of protein sequences as input (and builds an nr
3250 :     for the purpose of computing similarities). For each of these input fasta files, it saves
3251 :     (in the DB) a filename, seek address and length so that it can go get the translation if
3252 :     needed. This routine returns the length of a translation. This does not require actually
3253 :     retrieving the translation.
3254 :    
3255 :     =cut
3256 :    
3257 :     sub translation_length {
3258 :     my($self,$prot) = @_;
3259 :    
3260 : overbeek 1.136 if ($self->is_deleted_fid($prot)) { return undef }
3261 :    
3262 : efrank 1.1 $prot =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
3263 :     my $rdbH = $self->db_handle;
3264 : overbeek 1.145 my $relational_db_response = $rdbH->SQL("SELECT slen,seek FROM protein_sequence_seeks
3265 : efrank 1.1 WHERE id = \'$prot\' ");
3266 :    
3267 : overbeek 1.145 my @vals = sort { $b->[1] <=> $a->[1] } @$relational_db_response;
3268 :     return (@vals > 0) ? $vals[0]->[0] : undef;
3269 : efrank 1.1 }
3270 :    
3271 :    
3272 :     =pod
3273 :    
3274 :     =head1 get_translation
3275 :    
3276 :     usage: $translation = $fig->get_translation($prot_id)
3277 :    
3278 :     The system takes any number of sources of protein sequences as input (and builds an nr
3279 :     for the purpose of computing similarities). For each of these input fasta files, it saves
3280 :     (in the DB) a filename, seek address and length so that it can go get the translation if
3281 :     needed. This routine returns a protein sequence.
3282 :    
3283 :     =cut
3284 :    
3285 :     sub get_translation {
3286 :     my($self,$id) = @_;
3287 :     my($rdbH,$relational_db_response,$fileN,$file,$fh,$seek,$ln,$tran);
3288 :    
3289 : overbeek 1.136 if ($self->is_deleted_fid($id)) { return '' }
3290 :    
3291 : efrank 1.1 $rdbH = $self->db_handle;
3292 :     $id =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
3293 :    
3294 :     $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM protein_sequence_seeks WHERE id = \'$id\' ");
3295 :    
3296 : overbeek 1.145 if ($relational_db_response && @$relational_db_response > 0)
3297 : efrank 1.1 {
3298 : overbeek 1.145 my @vals = sort { $b->[1] <=> $a->[1] } @$relational_db_response;
3299 :     ($fileN,$seek,$ln) = @{$vals[0]};
3300 : efrank 1.1 if (($fh = $self->openF($self->N2file($fileN))) &&
3301 :     ($ln > 10))
3302 :     {
3303 :     seek($fh,$seek,0);
3304 :     read($fh,$tran,$ln-1);
3305 :     $tran =~ s/\s//g;
3306 :     return $tran;
3307 :     }
3308 :     }
3309 :     return '';
3310 :     }
3311 :    
3312 :     =pod
3313 :    
3314 :     =head1 mapped_prot_ids
3315 :    
3316 :     usage: @mapped = $fig->mapped_prot_ids($prot)
3317 :    
3318 :     This routine is at the heart of maintaining synonyms for protein sequences. The system
3319 :     determines which protein sequences are "essentially the same". These may differ in length
3320 :     (presumably due to miscalled starts), but the tails are identical (and the heads are not "too" extended).
3321 :     Anyway, the set of synonyms is returned as a list of 2-tuples [Id,length] sorted
3322 :     by length.
3323 :    
3324 :     =cut
3325 :    
3326 :     sub mapped_prot_ids {
3327 :     my($self,$id) = @_;
3328 :    
3329 : overbeek 1.136 if ($self->is_deleted_fid($id)) { return () }
3330 :    
3331 : efrank 1.1 my $rdbH = $self->db_handle;
3332 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
3333 :     if ($relational_db_response && (@$relational_db_response == 1))
3334 :     {
3335 :     $id = $relational_db_response->[0]->[0];
3336 :     }
3337 :    
3338 :     $relational_db_response = $rdbH->SQL("SELECT syn_id,syn_ln,maps_to_ln FROM peg_synonyms WHERE maps_to = \'$id\' ");
3339 :     if ($relational_db_response && (@$relational_db_response > 0))
3340 :     {
3341 :     return ([$id,$relational_db_response->[0]->[2]],map { [$_->[0],$_->[1]] } @$relational_db_response);
3342 :     }
3343 :     else
3344 :     {
3345 :     return ([$id,$self->translation_length($id)]);
3346 :     }
3347 : overbeek 1.14 }
3348 :    
3349 :     sub maps_to_id {
3350 :     my($self,$id) = @_;
3351 :    
3352 :     my $rdbH = $self->db_handle;
3353 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
3354 :     return ($relational_db_response && (@$relational_db_response == 1)) ? $relational_db_response->[0]->[0] : $id;
3355 : efrank 1.1 }
3356 :    
3357 :     ################ Assignments of Function to PEGs ##########################
3358 :    
3359 : overbeek 1.146 # set to undef to unset user
3360 :     #
3361 :     sub set_user {
3362 :     my($self,$user) = @_;
3363 :    
3364 :     $self->{_user} = $user;
3365 :     }
3366 :    
3367 :     sub get_user {
3368 :     my($self) = @_;
3369 :    
3370 :     return $self->{_user};
3371 :     }
3372 :    
3373 : efrank 1.1 =pod
3374 :    
3375 :     =head1 function_of
3376 :    
3377 :     usage: @functions = $fig->function_of($peg) OR
3378 :     $function = $fig->function_of($peg,$user)
3379 :    
3380 :     In a list context, you get back a list of 2-tuples. Each 2-tuple is of the
3381 :     form [MadeBy,Function].
3382 :    
3383 :     In a scalar context,
3384 :    
3385 :     1. user is "master" if not specified
3386 :     2. function returned is the user's, if one exists; otherwise, master's, if one exists
3387 :    
3388 :     In a scalar context, you get just the function.
3389 :    
3390 :     =cut
3391 :    
3392 :     # Note that we do not return confidence. I propose a separate function to get both
3393 :     # function and confidence
3394 :     #
3395 :     sub function_of {
3396 :     my($self,$id,$user) = @_;
3397 :     my($relational_db_response,@tmp,$entry,$i);
3398 :     my $wantarray = wantarray();
3399 :     my $rdbH = $self->db_handle;
3400 :    
3401 : overbeek 1.136 if ($self->is_deleted_fid($id)) { return $wantarray ? () : "" }
3402 :    
3403 : efrank 1.1 if (($id =~ /^fig\|(\d+\.\d+\.peg\.\d+)/) && ($wantarray || $user))
3404 :     {
3405 :     if (($relational_db_response = $rdbH->SQL("SELECT made_by,assigned_function FROM assigned_functions WHERE ( prot = \'$id\' )")) &&
3406 :     (@$relational_db_response >= 1))
3407 :     {
3408 :     @tmp = sort { $a->[0] cmp $b->[0] } map { [$_->[0],$_->[1]] } @$relational_db_response;
3409 :     for ($i=0; ($i < @tmp) && ($tmp[$i]->[0] ne "master"); $i++) {}
3410 :     if ($i < @tmp)
3411 :     {
3412 :     $entry = splice(@tmp,$i,1);
3413 :     unshift @tmp, ($entry);
3414 :     }
3415 :    
3416 :     my $val;
3417 :     if ($wantarray) { return @tmp }
3418 :     elsif ($user && ($val = &extract_by_who(\@tmp,$user))) { return $val }
3419 :     elsif ($user && ($val = &extract_by_who(\@tmp,"master"))) { return $val }
3420 :     else { return "" }
3421 :     }
3422 :     }
3423 :     else
3424 :     {
3425 :     if (($relational_db_response = $rdbH->SQL("SELECT assigned_function FROM assigned_functions WHERE ( prot = \'$id\' AND made_by = \'master\' )")) &&
3426 :     (@$relational_db_response >= 1))
3427 :     {
3428 :     return $wantarray ? (["master",$relational_db_response->[0]->[0]]) : $relational_db_response->[0]->[0];
3429 :     }
3430 :     }
3431 :    
3432 :     return $wantarray ? () : "";
3433 :     }
3434 :    
3435 :     =pod
3436 :    
3437 :     =head1 translated_function_of
3438 :    
3439 :     usage: $function = $fig->translated_function_of($peg,$user)
3440 :    
3441 :     You get just the translated function.
3442 :    
3443 :     =cut
3444 :    
3445 :     sub translated_function_of {
3446 :     my($self,$id,$user) = @_;
3447 :    
3448 :     my $func = $self->function_of($id,$user);
3449 :     if ($func)
3450 :     {
3451 :     $func = $self->translate_function($func);
3452 :     }
3453 :     return $func;
3454 :     }
3455 :    
3456 :    
3457 :     sub extract_by_who {
3458 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
3459 : efrank 1.1 my($xL,$who) = @_;
3460 :     my($i);
3461 :    
3462 :     for ($i=0; ($i < @$xL) && ($xL->[$i]->[0] ne $who); $i++) {}
3463 :     return ($i < @$xL) ? $xL->[$i]->[1] : "";
3464 :     }
3465 :    
3466 :    
3467 :     =pod
3468 :    
3469 :     =head1 translate_function
3470 :    
3471 :     usage: $translated_func = $fig->translate_function($func)
3472 :    
3473 :     Translates a function based on the function.synonyms table.
3474 :    
3475 :     =cut
3476 :    
3477 :     sub translate_function {
3478 :     my($self,$function) = @_;
3479 :    
3480 :     my ($tran,$from,$to,$line);
3481 :     if (! ($tran = $self->{_function_translation}))
3482 :     {
3483 :     $tran = {};
3484 :     if (open(TMP,"<$FIG_Config::global/function.synonyms"))
3485 :     {
3486 :     while (defined($line = <TMP>))
3487 :     {
3488 : golsen 1.44 chomp $line;
3489 : efrank 1.1 ($from,$to) = split(/\t/,$line);
3490 :     $tran->{$from} = $to;
3491 :     }
3492 :     close(TMP);
3493 :     }
3494 : overbeek 1.22 foreach $from (keys(%$tran))
3495 :     {
3496 :     $to = $tran->{$from};
3497 :     if ($tran->{$to})
3498 :     {
3499 :     delete $tran->{$from};
3500 :     }
3501 :     }
3502 : efrank 1.1 $self->{_function_translation} = $tran;
3503 :     }
3504 : overbeek 1.4
3505 :     while ($to = $tran->{$function})
3506 :     {
3507 :     $function = $to;
3508 :     }
3509 :     return $function;
3510 : efrank 1.1 }
3511 :    
3512 :     =pod
3513 :    
3514 :     =head1 assign_function
3515 :    
3516 :     usage: $fig->assign_function($peg,$user,$function,$confidence)
3517 :    
3518 :     Assigns a function. Note that confidence can (and should be if unusual) included.
3519 :     Note that no annotation is written. This should normally be done in a separate
3520 :     call of the form
3521 :    
3522 :    
3523 :    
3524 :     =cut
3525 :    
3526 :     sub assign_function {
3527 :     my($self,$peg,$user,$function,$confidence) = @_;
3528 :     my($role,$roleQ);
3529 :    
3530 : overbeek 1.136 if ($self->is_deleted_fid($peg)) { return 0 }
3531 :    
3532 : efrank 1.1 my $rdbH = $self->db_handle;
3533 :     $confidence = $confidence ? $confidence : "";
3534 :     my $genome = $self->genome_of($peg);
3535 :    
3536 :     $rdbH->SQL("DELETE FROM assigned_functions WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
3537 :    
3538 :     my $funcQ = quotemeta $function;
3539 :     $rdbH->SQL("INSERT INTO assigned_functions ( prot, made_by, assigned_function, quality, org ) VALUES ( \'$peg\', \'$user\', \'$funcQ\', \'$confidence\', \'$genome\' )");
3540 :     $rdbH->SQL("DELETE FROM roles WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
3541 :    
3542 :     foreach $role (&roles_of_function($function))
3543 :     {
3544 :     $roleQ = quotemeta $role;
3545 :     $rdbH->SQL("INSERT INTO roles ( prot, role, made_by, org ) VALUES ( \'$peg\', '$roleQ\', \'$user\', \'$genome\' )");
3546 :     }
3547 :    
3548 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels");
3549 :     if ($user ne "master")
3550 :     {
3551 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels/$user");
3552 :     }
3553 :    
3554 : overbeek 1.66 my $file;
3555 :     if ((($user eq "master") && ($file = "$FIG_Config::organisms/$genome/assigned_functions") && open(TMP,">>$file")) ||
3556 :     (($user ne "master") && ($file = "$FIG_Config::organisms/$genome/UserModels/$user/assigned_functions") && open(TMP,">>$file")))
3557 : efrank 1.1 {
3558 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
3559 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
3560 :     print TMP "$peg\t$function\t$confidence\n";
3561 :     close(TMP);
3562 : overbeek 1.66 chmod(0777,$file);
3563 : efrank 1.1 return 1;
3564 :     }
3565 : overbeek 1.125 else
3566 :     {
3567 :     print STDERR "FAILED ASSIGNMENT: $peg\t$function\t$confidence\n";
3568 :     }
3569 : efrank 1.1 return 0;
3570 :     }
3571 :    
3572 :     sub hypo {
3573 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
3574 : efrank 1.1 my $x = (@_ == 1) ? $_[0] : $_[1];
3575 :    
3576 : overbeek 1.23 if (! $x) { return 1 }
3577 :     if ($x =~ /hypoth/i) { return 1 }
3578 :     if ($x =~ /conserved protein/i) { return 1 }
3579 : overbeek 1.63 if ($x =~ /gene product/i) { return 1 }
3580 :     if ($x =~ /interpro/i) { return 1 }
3581 :     if ($x =~ /B[sl][lr]\d/i) { return 1 }
3582 :     if ($x =~ /^U\d/) { return 1 }
3583 :     if ($x =~ /^orf/i) { return 1 }
3584 :     if ($x =~ /uncharacterized/i) { return 1 }
3585 :     if ($x =~ /psedogene/i) { return 1 }
3586 :     if ($x =~ /^predicted/i) { return 1 }
3587 :     if ($x =~ /AGR_/) { return 1 }
3588 : overbeek 1.51 if ($x =~ /similar to/i) { return 1 }
3589 : overbeek 1.63 if ($x =~ /similarity/i) { return 1 }
3590 :     if ($x =~ /glimmer/i) { return 1 }
3591 : overbeek 1.23 if ($x =~ /unknown/i) { return 1 }
3592 :     return 0;
3593 : efrank 1.1 }
3594 :    
3595 :     ############################ Similarities ###############################
3596 :    
3597 :     =pod
3598 :    
3599 :     =head1 sims
3600 :    
3601 :     usage: @sims = $fig->sims($peg,$maxN,$maxP,$select)
3602 :    
3603 :     Returns a list of similarities for $peg such that
3604 :    
3605 :     there will be at most $maxN similarities,
3606 :    
3607 :     each similarity will have a P-score <= $maxP, and
3608 :    
3609 :     $select gives processing instructions:
3610 :    
3611 :     "raw" means that the similarities will not be expanded (by far fastest option)
3612 :     "fig" means return only similarities to fig genes
3613 :     "all" means that you want all the expanded similarities.
3614 :    
3615 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
3616 :     protein collection, and converting it to a set of similarities (one for each of the
3617 :     proteins that are essentially identical to the representative in the nr).
3618 :    
3619 :     =cut
3620 :    
3621 :     sub sims {
3622 : overbeek 1.29 my ($self,$id,$maxN,$maxP,$select,$max_expand) = @_;
3623 : efrank 1.1 my($sim);
3624 : overbeek 1.29 $max_expand = defined($max_expand) ? $max_expand : $maxN;
3625 : efrank 1.1
3626 : overbeek 1.136 if ($self->is_deleted_fid($id)) { return () }
3627 :    
3628 : efrank 1.1 my @sims = ();
3629 :     my @maps_to = $self->mapped_prot_ids($id);
3630 :     if (@maps_to > 0)
3631 :     {
3632 :     my $rep_id = $maps_to[0]->[0];
3633 :     my @entry = grep { $_->[0] eq $id } @maps_to;
3634 :     if ((@entry == 1) && defined($entry[0]->[1]))
3635 :     {
3636 :     if ((! defined($maps_to[0]->[1])) ||
3637 :     (! defined($entry[0]->[1])))
3638 :     {
3639 :     print STDERR &Dumper(\@maps_to,\@entry);
3640 :     confess "bad";
3641 :     }
3642 :     my $delta = $maps_to[0]->[1] - $entry[0]->[1];
3643 :     my @raw_sims = &get_raw_sims($self,$rep_id,$maxN,$maxP);
3644 : efrank 1.2 if ($id ne $rep_id)
3645 : efrank 1.1 {
3646 : efrank 1.2 foreach $sim (@raw_sims)
3647 :     {
3648 : efrank 1.1
3649 :     $sim->[0] = $id;
3650 :     $sim->[6] -= $delta;
3651 :     $sim->[7] -= $delta;
3652 :     }
3653 :     }
3654 : overbeek 1.88 if (($max_expand > 0) && ($select ne "raw"))
3655 :     {
3656 : overbeek 1.142 unshift(@raw_sims,bless([$id,
3657 :     $rep_id,
3658 :     100.00,
3659 :     $entry[0]->[1],
3660 :     0,
3661 :     0,
3662 :     1,$entry[0]->[1],
3663 :     $delta+1,$maps_to[0]->[1],
3664 :     0.0,
3665 :     2 * $entry[0]->[1],
3666 :     $entry[0]->[1],
3667 :     $maps_to[0]->[1],
3668 :     "blastp",
3669 :     undef,
3670 :     undef
3671 :     ],'Sim'));
3672 : overbeek 1.88 $max_expand++;
3673 :     }
3674 :     @sims = grep { $_->id1 ne $_->id2 } &expand_raw_sims($self,\@raw_sims,$maxP,$select,0,$max_expand);
3675 : efrank 1.1 }
3676 :     }
3677 : overbeek 1.136 return grep { ! $self->is_deleted_fid($_->id2) } @sims;
3678 : efrank 1.1 }
3679 :    
3680 :     sub expand_raw_sims {
3681 : overbeek 1.29 my($self,$raw_sims,$maxP,$select,$dups,$max_expand) = @_;
3682 : efrank 1.1 my($sim,$id2,%others,$x);
3683 :    
3684 :     my @sims = ();
3685 :     foreach $sim (@$raw_sims)
3686 :     {
3687 :     next if ($sim->psc > $maxP);
3688 :     $id2 = $sim->id2;
3689 :     next if ($others{$id2} && (! $dups));
3690 : overbeek 1.136
3691 : efrank 1.1 $others{$id2} = 1;
3692 : overbeek 1.37 if (($select && ($select eq "raw")) || ($max_expand <= 0))
3693 : efrank 1.1 {
3694 :     push(@sims,$sim);
3695 :     }
3696 :     else
3697 :     {
3698 :     my @relevant;
3699 : overbeek 1.29 $max_expand--;
3700 :    
3701 : efrank 1.1 my @maps_to = $self->mapped_prot_ids($id2);
3702 :     if ((! $select) || ($select eq "fig"))
3703 :     {
3704 :     @relevant = grep { $_->[0] =~ /^fig/ } @maps_to;
3705 :     }
3706 :     elsif ($select && ($select =~ /^ext/i))
3707 :     {
3708 :     @relevant = grep { $_->[0] !~ /^fig/ } @maps_to;
3709 :     }
3710 :     else
3711 :     {
3712 :     @relevant = @maps_to;
3713 :     }
3714 :    
3715 :     foreach $x (@relevant)
3716 :     {
3717 :     my $sim1 = [@$sim];
3718 :     my($x_id,$x_ln) = @$x;
3719 :     defined($x_ln) || confess "x_ln id2=$id2 x_id=$x_id";
3720 :     defined($maps_to[0]->[1]) || confess "maps_to";
3721 :     my $delta2 = $maps_to[0]->[1] - $x_ln;
3722 :     $sim1->[1] = $x_id;
3723 :     $sim1->[8] -= $delta2;
3724 :     $sim1->[9] -= $delta2;
3725 :     bless($sim1,"Sim");
3726 :     push(@sims,$sim1);
3727 :     }
3728 :     }
3729 :     }
3730 :     return @sims;
3731 :     }
3732 :    
3733 :     sub get_raw_sims {
3734 :     my($self,$rep_id,$maxN,$maxP) = @_;
3735 : overbeek 1.84 my(@sims,$seek,$fileN,$ln,$fh,$file,$readC,@lines,$i,$sim);
3736 : efrank 1.1 my($sim_chunk,$psc,$id2);
3737 :    
3738 :     $maxN = $maxN ? $maxN : 500;
3739 :    
3740 :     @sims = ();
3741 :     my $rdbH = $self->db_handle;
3742 :     my $relational_db_response = $rdbH->SQL("SELECT seek, fileN, len FROM sim_seeks WHERE id = \'$rep_id\' ");
3743 :     foreach $sim_chunk (@$relational_db_response)
3744 :     {
3745 :     ($seek,$fileN,$ln) = @$sim_chunk;
3746 :     $file = $self->N2file($fileN);
3747 :     $fh = $self->openF($file);
3748 :     if (! $fh)
3749 :     {
3750 :     confess "could not open sims for $file";
3751 :     }
3752 : overbeek 1.84 $readC = &read_block($fh,$seek,$ln-1);
3753 : efrank 1.1 @lines = grep {
3754 :     (@$_ == 15) &&
3755 :     ($_->[12] =~ /^\d+$/) &&
3756 :     ($_->[13] =~ /^\d+$/) &&
3757 :     ($_->[6] =~ /^\d+$/) &&
3758 :     ($_->[7] =~ /^\d+$/) &&
3759 :     ($_->[8] =~ /^\d+$/) &&
3760 :     ($_->[9] =~ /^\d+$/) &&
3761 :     ($_->[2] =~ /^[0-9.]+$/) &&
3762 :     ($_->[10] =~ /^[0-9.e-]+$/)
3763 :     }
3764 :     map { [split(/\t/,$_),"blastp"] }
3765 : overbeek 1.98 @$readC;
3766 : efrank 1.1
3767 : overbeek 1.144 @lines = sort { $b->[11] <=> $a->[11] } @lines;
3768 : efrank 1.1
3769 :     for ($i=0; ($i < @lines); $i++)
3770 :     {
3771 :     $psc = $lines[$i]->[10];
3772 :     $id2 = $lines[$i]->[1];
3773 :     if ($maxP >= $psc)
3774 :     {
3775 :     $sim = $lines[$i];
3776 :     bless($sim,"Sim");
3777 :     push(@sims,$sim);
3778 :     if (@sims == $maxN) { return @sims }
3779 :     }
3780 :     }
3781 :     }
3782 :     return @sims;
3783 :     }
3784 :    
3785 : overbeek 1.84 sub read_block {
3786 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
3787 : overbeek 1.84 my($fh,$seek,$ln) = @_;
3788 :     my($piece,$readN);
3789 :    
3790 :     seek($fh,$seek,0);
3791 : overbeek 1.98 my @lines = ();
3792 :     my $leftover = "";
3793 : overbeek 1.84 while ($ln > 0)
3794 :     {
3795 :     my $ln1 = ($ln <= 10000) ? $ln : 10000;
3796 :     $readN = read($fh,$piece,$ln1);
3797 :     ($readN == $ln1)
3798 :     || confess "could not read the block of sims at $seek for $ln1 characters; $readN actually read";
3799 : overbeek 1.98 my @tmp = split(/\n/,$piece);
3800 :     if ($leftover)
3801 :     {
3802 :     $tmp[0] = $leftover . $tmp[0];
3803 :     }
3804 :    
3805 :     if (substr($piece,-1) eq "\n")
3806 :     {
3807 :     $leftover = "";
3808 :     }
3809 :     else
3810 :     {
3811 :     $leftover = pop @tmp;
3812 :     }
3813 :     push(@lines,@tmp);
3814 : overbeek 1.84 $ln -= 10000;
3815 :     }
3816 : overbeek 1.98 if ($leftover) { push(@lines,$leftover) }
3817 :     return \@lines;
3818 : overbeek 1.84 }
3819 :    
3820 :    
3821 : overbeek 1.73 sub bbhs {
3822 : overbeek 1.101 my($self,$peg,$cutoff,$frac_match) = @_;
3823 : overbeek 1.74 my($sim,$peg2,$genome2,$i,@sims2,%seen);
3824 : overbeek 1.73
3825 : overbeek 1.136 if ($self->is_deleted_fid($peg)) { return () }
3826 :    
3827 : overbeek 1.101 $frac_match = defined($frac_match) ? $frac_match : 0;
3828 :    
3829 : overbeek 1.73 $cutoff = defined($cutoff) ? $cutoff : 1.0e-10;
3830 :     my @bbhs = ();
3831 : overbeek 1.100 my @precomputed = ();
3832 :     my $rdbH = $self->db_handle;
3833 :     my $relational_db_response = $rdbH->SQL("SELECT seek, others FROM bbhs WHERE peg = \'$peg\' ");
3834 :     if (@$relational_db_response == 1)
3835 :     {
3836 :     my($seek,$others) = @{$relational_db_response->[0]};
3837 :     if (open(CORES,"<$FIG_Config::global/bbh.cores"))
3838 :     {
3839 :     seek(CORES,$seek,0);
3840 :     $_ = <CORES>;
3841 :     close(CORES);
3842 :     chop;
3843 :     push(@precomputed,split(/,/,$_));
3844 :     }
3845 :     push(@precomputed,split(/,/,$others));
3846 :     }
3847 :     my %bbhs = map { $_ => 1 } @precomputed;
3848 : overbeek 1.73
3849 :     foreach $sim ($self->sims($peg,10000,$cutoff,"fig"))
3850 :     {
3851 :     $peg2 = $sim->id2;
3852 : overbeek 1.101 my $frac = &FIG::min(($sim->e1+1 - $sim->b1) / $sim->ln1, ($sim->e2+1 - $sim->b2) / $sim->ln2);
3853 :     if ($bbhs{$peg2} && ($frac >= $frac_match))
3854 : overbeek 1.73 {
3855 :     push(@bbhs,[$peg2,$sim->psc]);
3856 :     }
3857 :     }
3858 :     return @bbhs;
3859 :     }
3860 :    
3861 : olson 1.163 #
3862 : olson 1.165 # Modeled after the Sprout call of the same name.
3863 : olson 1.163 #
3864 :    
3865 :    
3866 : olson 1.165 sub bbh_list
3867 :     {
3868 :     my($self, $genome, $features) = @_;
3869 : olson 1.163
3870 : olson 1.165 my $cutoff = 1.0e-10;
3871 : olson 1.163
3872 : olson 1.165 my $out = {};
3873 :     for my $feature (@$features)
3874 : olson 1.163 {
3875 : olson 1.165 my @bbhs = $self->bbhs($feature, $cutoff);
3876 : olson 1.163
3877 : olson 1.165 $out->{$feature} = [grep { /fig\|$genome\.peg/ } map { $_->[0] } @bbhs];
3878 : olson 1.163 }
3879 : olson 1.165 return $out;
3880 : olson 1.163 }
3881 :    
3882 : efrank 1.1 =pod
3883 :    
3884 :     =head1 dsims
3885 :    
3886 :     usage: @sims = $fig->dsims($peg,$maxN,$maxP,$select)
3887 :    
3888 :     Returns a list of similarities for $peg such that
3889 :    
3890 :     there will be at most $maxN similarities,
3891 :    
3892 :     each similarity will have a P-score <= $maxP, and
3893 :    
3894 :     $select gives processing instructions:
3895 :    
3896 :     "raw" means that the similarities will not be expanded (by far fastest option)
3897 :     "fig" means return only similarities to fig genes
3898 :     "all" means that you want all the expanded similarities.
3899 :    
3900 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
3901 :     protein collection, and converting it to a set of similarities (one for each of the
3902 :     proteins that are essentially identical to the representative in the nr).
3903 :    
3904 :     The "dsims" or "dynamic sims" are not precomputed. They are computed using a heuristic which
3905 :     is much faster than blast, but misses some similarities. Essentially, you have an "index" or
3906 :     representative sequences, a quick blast is done against it, and if there are any hits these are
3907 :     used to indicate which sub-databases to blast against.
3908 :    
3909 :     =cut
3910 :    
3911 :     sub dsims {
3912 :     my($self,$id,$seq,$maxN,$maxP,$select) = @_;
3913 :     my($sim,$sub_dir,$db,$hit,@hits,%in);
3914 :    
3915 :     my @index = &blastit($id,$seq,"$FIG_Config::global/SimGen/exemplar.fasta",1.0e-3);
3916 :     foreach $sim (@index)
3917 :     {
3918 :     if ($sim->id2 =~ /_(\d+)$/)
3919 :     {
3920 :     $in{$1}++;
3921 :     }
3922 :     }
3923 :    
3924 :     @hits = ();
3925 :     foreach $db (keys(%in))
3926 :     {
3927 :     $sub_dir = $db % 1000;
3928 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/AccessSets/$sub_dir/$db",$maxP));
3929 :    
3930 :     }
3931 :    
3932 :     if (@hits == 0)
3933 :     {
3934 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/nohit.fasta",$maxP));
3935 :     }
3936 :    
3937 :     @hits = sort { ($a->psc <=> $b->psc) or ($a->iden cmp $b->iden) } grep { $_->id2 ne $id } @hits;
3938 :     if ($maxN && ($maxN < @hits)) { $#hits = $maxN - 1 }
3939 : overbeek 1.69 return &expand_raw_sims($self,\@hits,$maxP,$select);
3940 : efrank 1.1 }
3941 :    
3942 :     sub blastit {
3943 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
3944 : efrank 1.1 my($id,$seq,$db,$maxP) = @_;
3945 :    
3946 :     if (! $maxP) { $maxP = 1.0e-5 }
3947 :     my $tmp = &Blast::blastp([[$id,$seq]],$db,"-e $maxP");
3948 :     my $tmp1 = $tmp->{$id};
3949 :     if ($tmp1)
3950 :     {
3951 :     return @$tmp1;
3952 :     }
3953 :     return ();
3954 :     }
3955 :    
3956 : overbeek 1.33 sub related_by_func_sim {
3957 :     my($self,$peg,$user) = @_;
3958 :     my($func,$sim,$id2,%related);
3959 :    
3960 : overbeek 1.136 if ($self->is_deleted_fid($peg)) { return () }
3961 :    
3962 : overbeek 1.33 if (($func = $self->function_of($peg,$user)) && (! &FIG::hypo($func)))
3963 :     {
3964 :     foreach $sim ($self->sims($peg,500,1,"fig",500))
3965 :     {
3966 :     $id2 = $sim->id2;
3967 :     if ($func eq $self->function_of($id2,$user))
3968 :     {
3969 :     $related{$id2} = 1;
3970 :     }
3971 :     }
3972 :     }
3973 :     return keys(%related);
3974 :     }
3975 :    
3976 : efrank 1.1 ################################# chromosomal clusters ####################################
3977 :    
3978 :     =pod
3979 :    
3980 :     =head1 in_cluster_with
3981 :    
3982 :     usage: @pegs = $fig->in_cluster_with($peg)
3983 :    
3984 :     Returns the set of pegs that are thought to be clustered with $peg (on the
3985 :     chromosome).
3986 :    
3987 :     =cut
3988 :    
3989 :     sub in_cluster_with {
3990 :     my($self,$peg) = @_;
3991 :     my($set,$id,%in);
3992 :    
3993 :     return $self->in_set_with($peg,"chromosomal_clusters","cluster_id");
3994 :     }
3995 :    
3996 :     =pod
3997 :    
3998 :     =head1 add_chromosomal_clusters
3999 :    
4000 :     usage: $fig->add_chromosomal_clusters($file)
4001 :    
4002 :     The given file is supposed to contain one predicted chromosomal cluster per line (either
4003 :     comma or tab separated pegs). These will be added (to the extent they are new) to those
4004 :     already in $FIG_Config::global/chromosomal_clusters.
4005 :    
4006 :     =cut
4007 :    
4008 :    
4009 :     sub add_chromosomal_clusters {
4010 :     my($self,$file) = @_;
4011 :     my($set,$added);
4012 :    
4013 :     open(TMPCLUST,"<$file")
4014 :     || die "aborted";
4015 :     while (defined($set = <TMPCLUST>))
4016 :     {
4017 :     print STDERR ".";
4018 : golsen 1.44 chomp $set;
4019 : efrank 1.1 $added += $self->add_chromosomal_cluster([split(/[\t,]+/,$set)]);
4020 :     }
4021 :     close(TMPCLUST);
4022 :    
4023 :     if ($added)
4024 :     {
4025 :     my $rdbH = $self->db_handle;
4026 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
4027 :     return 1;
4028 :     }
4029 :     return 0;
4030 :     }
4031 :    
4032 :     #=pod
4033 :     #
4034 :     #=head1 export_chromosomal_clusters
4035 :     #
4036 :     #usage: $fig->export_chromosomal_clusters
4037 :     #
4038 :     #Invoking this routine writes the set of chromosomal clusters as known in the
4039 :     #relational DB back to $FIG_Config::global/chromosomal_clusters.
4040 :     #
4041 :     #=cut
4042 :     #
4043 :     sub export_chromosomal_clusters {
4044 :     my($self) = @_;
4045 :    
4046 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
4047 :     }
4048 :    
4049 :     sub add_chromosomal_cluster {
4050 :     my($self,$ids) = @_;
4051 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
4052 :    
4053 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
4054 :     foreach $id (@$ids)
4055 :     {
4056 :     foreach $set ($self->in_sets($id,"chromosomal_clusters","cluster_id"))
4057 :     {
4058 :     $existing{$set} = 1;
4059 :     foreach $id ($self->ids_in_set($set,"chromosomal_clusters","cluster_id"))
4060 :     {
4061 :     $in{$id} = 1;
4062 :     }
4063 :     }
4064 :     }
4065 :     # print &Dumper(\%existing,\%in);
4066 :    
4067 :     $new = 0;
4068 :     foreach $id (@$ids)
4069 :     {
4070 :     if (! $in{$id})
4071 :     {
4072 :     $in{$id} = 1;
4073 :     $new++;
4074 :     }
4075 :     }
4076 :     # print STDERR "$new new ids\n";
4077 :     if ($new)
4078 :     {
4079 :     foreach $existing (keys(%existing))
4080 :     {
4081 :     $self->delete_set($existing,"chromosomal_clusters","cluster_id");
4082 :     }
4083 :     $new_id = $self->next_set("chromosomal_clusters","cluster_id");
4084 :     # print STDERR "adding new cluster $new_id\n";
4085 :     $self->insert_set($new_id,[keys(%in)],"chromosomal_clusters","cluster_id");
4086 :     return 1;
4087 :     }
4088 :     return 0;
4089 :     }
4090 :    
4091 :     ################################# PCH pins ####################################
4092 :    
4093 :     =pod
4094 :    
4095 :     =head1 in_pch_pin_with
4096 :    
4097 :     usage: $fig->in_pch_pin_with($peg)
4098 :    
4099 :     Returns the set of pegs that are believed to be "pinned" to $peg (in the
4100 :     sense that PCHs occur containing these pegs over significant phylogenetic
4101 :     distances).
4102 :    
4103 :     =cut
4104 :    
4105 :     sub in_pch_pin_with {
4106 :     my($self,$peg) = @_;
4107 :     my($set,$id,%in);
4108 :    
4109 :     return $self->in_set_with($peg,"pch_pins","pin");
4110 :     }
4111 :    
4112 :     =pod
4113 :    
4114 :     =head1 add_pch_pins
4115 :    
4116 :     usage: $fig->add_pch_pins($file)
4117 :    
4118 :     The given file is supposed to contain one set of pinned pegs per line (either
4119 :     comma or tab seprated pegs). These will be added (to the extent they are new) to those
4120 :     already in $FIG_Config::global/pch_pins.
4121 :    
4122 :     =cut
4123 :    
4124 :     sub add_pch_pins {
4125 :     my($self,$file) = @_;
4126 :     my($set,$added);
4127 :    
4128 :     open(TMPCLUST,"<$file")
4129 :     || die "aborted";
4130 :     while (defined($set = <TMPCLUST>))
4131 :     {
4132 :     print STDERR ".";
4133 : golsen 1.44 chomp $set;
4134 : efrank 1.1 my @tmp = split(/[\t,]+/,$set);
4135 :     if (@tmp < 200)
4136 :     {
4137 :     $added += $self->add_pch_pin([@tmp]);
4138 :     }
4139 :     }
4140 :     close(TMPCLUST);
4141 :    
4142 :     if ($added)
4143 :     {
4144 :     my $rdbH = $self->db_handle;
4145 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
4146 :     return 1;
4147 :     }
4148 :     return 0;
4149 :     }
4150 :    
4151 :     sub export_pch_pins {
4152 :     my($self) = @_;
4153 :    
4154 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
4155 :     }
4156 :    
4157 :     sub add_pch_pin {
4158 :     my($self,$ids) = @_;
4159 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
4160 :    
4161 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
4162 :     foreach $id (@$ids)
4163 :     {
4164 :     foreach $set ($self->in_sets($id,"pch_pins","pin"))
4165 :     {
4166 :     $existing{$set} = 1;
4167 :     foreach $id ($self->ids_in_set($set,"pch_pins","pin"))
4168 :     {
4169 :     $in{$id} = 1;
4170 :     }
4171 :     }
4172 :     }
4173 :     # print &Dumper(\%existing,\%in);
4174 :    
4175 :     $new = 0;
4176 :     foreach $id (@$ids)
4177 :     {
4178 :     if (! $in{$id})
4179 :     {
4180 :     $in{$id} = 1;
4181 :     $new++;
4182 :     }
4183 :     }
4184 :    
4185 :     if ($new)
4186 :     {
4187 : overbeek 1.9 if (keys(%in) < 300)
4188 : efrank 1.1 {
4189 : overbeek 1.9 foreach $existing (keys(%existing))
4190 :     {
4191 :     $self->delete_set($existing,"pch_pins","pin");
4192 :     }
4193 :     $new_id = $self->next_set("pch_pins","pin");
4194 :     # print STDERR "adding new pin $new_id\n";
4195 :     $self->insert_set($new_id,[keys(%in)],"pch_pins","pin");
4196 :     }
4197 :     else
4198 :     {
4199 :     $new_id = $self->next_set("pch_pins","pin");
4200 :     # print STDERR "adding new pin $new_id\n";
4201 :     $self->insert_set($new_id,$ids,"pch_pins","pin");
4202 : efrank 1.1 }
4203 :     return 1;
4204 :     }
4205 :     return 0;
4206 :     }
4207 :    
4208 :     ################################# Annotations ####################################
4209 :    
4210 :     =pod
4211 :    
4212 :     =head1 add_annotation
4213 :    
4214 :     usage: $fig->add_annotation($fid,$user,$annotation)
4215 :    
4216 :     $annotation is added as a time-stamped annotation to $peg showing $user as the
4217 :     individual who added the annotation.
4218 :    
4219 :     =cut
4220 :    
4221 :     sub add_annotation {
4222 :     my($self,$feature_id,$user,$annotation) = @_;
4223 :     my($genome);
4224 :    
4225 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return 0 }
4226 :    
4227 : efrank 1.1 # print STDERR "add: fid=$feature_id user=$user annotation=$annotation\n";
4228 :     if ($genome = $self->genome_of($feature_id))
4229 :     {
4230 :     my $file = "$FIG_Config::organisms/$genome/annotations";
4231 :     my $fileno = $self->file2N($file);
4232 :     my $time_made = time;
4233 : overbeek 1.17 my $ma = ($annotation =~ /^Set master function to/);
4234 :    
4235 : efrank 1.1
4236 :     if (open(TMP,">>$file"))
4237 :     {
4238 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
4239 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
4240 :    
4241 :     my $seek1 = tell TMP;
4242 :     print TMP "$feature_id\n$time_made\n$user\n$annotation", (substr($annotation,-1) eq "\n") ? "" : "\n","//\n";
4243 :     my $seek2 = tell TMP;
4244 :     close(TMP);
4245 : olson 1.153 chmod 0777, $file;
4246 : overbeek 1.133 my $ln = ($seek2 - $seek1) - 3;
4247 : efrank 1.1 my $rdbH = $self->db_handle;
4248 : overbeek 1.17 if ($rdbH->SQL("INSERT INTO annotation_seeks ( fid, dateof, who, ma, fileno, seek, len ) VALUES ( \'$feature_id\', $time_made, \'$user\', \'$ma\', $fileno, $seek1, $ln )"))
4249 : efrank 1.1 {
4250 :     return 1;
4251 :     }
4252 :     }
4253 :     }
4254 :     return 0;
4255 :     }
4256 :    
4257 :     =pod
4258 :    
4259 : overbeek 1.33 =head1 merged_related_annotations
4260 :    
4261 :     usage: @annotations = $fig->merged_related_annotations($fids)
4262 :    
4263 :     The set of annotations of a set of PEGs ($fids) is returned as a list of 4-tuples.
4264 :     Each entry in the list is of the form [$fid,$timestamp,$user,$annotation].
4265 :    
4266 :     =cut
4267 :    
4268 :     sub merged_related_annotations {
4269 :     my($self,$fids) = @_;
4270 :     my($fid);
4271 :     my(@ann) = ();
4272 :    
4273 :     foreach $fid (@$fids)
4274 :     {
4275 :     push(@ann,$self->feature_annotations1($fid));
4276 :     }
4277 :     return map { $_->[1] = localtime($_->[1]); $_ } sort { $a->[1] <=> $b->[1] } @ann;
4278 :     }
4279 :    
4280 :     =pod
4281 :    
4282 : efrank 1.1 =head1 feature_annotations
4283 :    
4284 :     usage: @annotations = $fig->feature_annotations($fid)
4285 :    
4286 :     The set of annotations of $fid is returned as a list of 4-tuples. Each entry in the list
4287 :     is of the form [$fid,$timestamp,$user,$annotation].
4288 :    
4289 :     =cut
4290 :    
4291 :    
4292 :     sub feature_annotations {
4293 :     my($self,$feature_id) = @_;
4294 : overbeek 1.33
4295 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return () }
4296 :    
4297 : overbeek 1.33 return map { $_->[1] = localtime($_->[1]); $_ } $self->feature_annotations1($feature_id);
4298 :     }
4299 :    
4300 :     sub feature_annotations1 {
4301 :     my($self,$feature_id) = @_;
4302 : overbeek 1.16 my($tuple,$fileN,$seek,$ln,$annotation,$feature_idQ);
4303 : efrank 1.1 my($file,$fh);
4304 :    
4305 : overbeek 1.136 if ($self->is_deleted_fid($feature_id)) { return () }
4306 :    
4307 : efrank 1.1 my $rdbH = $self->db_handle;
4308 :     my $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM annotation_seeks WHERE fid = \'$feature_id\' ");
4309 :     my @annotations = ();
4310 :    
4311 :     foreach $tuple (@$relational_db_response)
4312 :     {
4313 :     ($fileN,$seek,$ln) = @$tuple;
4314 : overbeek 1.16 $annotation = $self->read_annotation($fileN,$seek,$ln);
4315 :     $feature_idQ = quotemeta $feature_id;
4316 :     if ($annotation =~ /^$feature_idQ\n(\d+)\n([^\n]+)\n(.*)/s)
4317 : efrank 1.1 {
4318 : overbeek 1.16 push(@annotations,[$feature_id,$1,$2,$3]);
4319 : efrank 1.1 }
4320 : overbeek 1.16 else
4321 : efrank 1.1 {
4322 : overbeek 1.16 print STDERR "malformed annotation\n$annotation\n";
4323 : efrank 1.1 }
4324 :     }
4325 : overbeek 1.33 return sort { $a->[1] <=> $b->[1] } @annotations;
4326 : overbeek 1.16 }
4327 :    
4328 :     sub read_annotation {
4329 :     my($self,$fileN,$seek,$ln) = @_;
4330 :     my($readN,$readC);
4331 :    
4332 :     my $file = $self->N2file($fileN);
4333 :     my $fh = $self->openF($file);
4334 :     if (! $fh)
4335 :     {
4336 :     confess "could not open annotations for $file";
4337 :     }
4338 :     seek($fh,$seek,0);
4339 : overbeek 1.132 $readN = read($fh,$readC,$ln);
4340 :     ($readN == $ln)
4341 : overbeek 1.16 || confess "could not read the block of annotations at $seek for $ln characters; $readN actually read from $file\n$readC";
4342 :     return $readC;
4343 : overbeek 1.17 }
4344 :    
4345 : overbeek 1.21 sub epoch_to_readable {
4346 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
4347 : overbeek 1.21 my($epoch) = @_;
4348 :    
4349 :     my($sec,$min,$hr,$dd,$mm,$yr) = localtime($epoch);
4350 :     $mm++;
4351 :     $yr += 1900;
4352 :     return "$mm-$dd-$yr:$hr:$min:$sec";
4353 :     }
4354 :    
4355 : olson 1.120 #
4356 :     # This now calls assignments_made_full and remaps the output.
4357 :     #
4358 :     sub assignments_made
4359 :     {
4360 :     my($self,$genomes,$who,$date) = @_;
4361 :    
4362 :     my @a = $self->assignments_made_full($genomes, $who, $date);
4363 :    
4364 :     return map { [ @{$_}[0,1]] } @a;
4365 :     }
4366 :    
4367 :     #
4368 :     # Looks up and returns assignments made; return is a list of
4369 : olson 1.122 # tuples [peg, assignment, date, who]
4370 : olson 1.120 #
4371 :    
4372 :     sub assignments_made_full {
4373 : overbeek 1.17 my($self,$genomes,$who,$date) = @_;
4374 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
4375 : overbeek 1.30 my($epoch_date,$when,%sofar,$x);
4376 : overbeek 1.17
4377 : overbeek 1.56 if (! defined($genomes)) { $genomes = [$self->genomes] }
4378 :    
4379 : overbeek 1.17 my %genomes = map { $_ => 1 } @$genomes;
4380 : overbeek 1.19 if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
4381 :     {
4382 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
4383 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
4384 :     }
4385 : overbeek 1.62 elsif ($date =~ /^\d+$/)
4386 :     {
4387 :     $epoch_date = $date;
4388 :     }
4389 : overbeek 1.19 else
4390 :     {
4391 :     $epoch_date = 0;
4392 :     }
4393 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
4394 : overbeek 1.17 my @assignments = ();
4395 :     my $rdbH = $self->db_handle;
4396 :     if ($who eq "master")
4397 :     {
4398 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
4399 : overbeek 1.17 }
4400 :     else
4401 :     {
4402 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
4403 : overbeek 1.17 }
4404 :    
4405 :     if ($relational_db_response && (@$relational_db_response > 0))
4406 :     {
4407 :     foreach $entry (@$relational_db_response)
4408 :     {
4409 : overbeek 1.30 ($fid,$when,$fileno,$seek,$len) = @$entry;
4410 : overbeek 1.136 if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1} && (! $self->is_deleted_fid($fid)))
4411 : overbeek 1.17 {
4412 : overbeek 1.67 if ($len < 4)
4413 :     {
4414 :     print STDERR "BAD: fid=$fid when=$when fileno=$fileno seek=$seek len=$len\n";
4415 :     next;
4416 :     }
4417 : overbeek 1.17 $ann = $self->read_annotation($fileno,$seek,$len);
4418 :    
4419 : olson 1.120 if (($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\nSet ([^\n]*)function[^\n]*\n(\S[^\n]+\S)/s) &&
4420 :     (($who eq $3) || (($4 eq "master ") && ($who eq "master"))) &&
4421 :     ($2 >= $epoch_date))
4422 :     {
4423 :     if ((! $sofar{$1}) || (($x = $sofar{$1}) && ($when > $x->[0])))
4424 :     {
4425 :     $sofar{$1} = [$when, $5, $3];
4426 :     }
4427 : overbeek 1.17 }
4428 :     }
4429 :     }
4430 :     }
4431 : olson 1.120 @assignments = map { $x = $sofar{$_}; [$_,$x->[1], $x->[0], $x->[2]] } keys(%sofar);
4432 : overbeek 1.17 return @assignments;
4433 : efrank 1.1 }
4434 :    
4435 : olson 1.122 sub assignments_made_for_protein {
4436 :     my($self, $fid) = @_;
4437 :     my($relational_db_response,$entry,$fileno,$seek,$len,$ann);
4438 :     my($epoch_date,$when,%sofar,$x);
4439 :    
4440 : overbeek 1.136 if ($self->is_deleted_fid($fid)) { return () }
4441 :    
4442 : olson 1.122 my @assignments = ();
4443 :     my $rdbH = $self->db_handle;
4444 :    
4445 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (fid = '$fid')");
4446 :    
4447 :     if ($relational_db_response && (@$relational_db_response > 0))
4448 :     {
4449 :     foreach $entry (@$relational_db_response)
4450 :     {
4451 :     ($fid,$when,$fileno,$seek,$len) = @$entry;
4452 :     if ($len < 4)
4453 :     {
4454 :     print STDERR "BAD: fid=$fid when=$when fileno=$fileno seek=$seek len=$len\n";
4455 :     next;
4456 :     }
4457 :     $ann = $self->read_annotation($fileno,$seek,$len);
4458 :    
4459 :     if (my ($peg, $when, $who, $what, $func) =
4460 :     $ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\nSet ([^\n]*)function[^\n]*\n(\S[^\n]+\S)/s)
4461 :     {
4462 :     push(@assignments, [$peg, $when, $who, $what, $func]);
4463 :     }
4464 :     }
4465 :     }
4466 :     return @assignments;
4467 :     }
4468 :    
4469 : olson 1.120 =pod
4470 :    
4471 :     =head1 annotations_made
4472 :    
4473 :     usage: @annotations = $fig->annotations_made($genomes, $who, $date)
4474 :    
4475 :     Return the list of annotations on the genomes in @$genomes made by $who
4476 :     after $date.
4477 :    
4478 :     Each returned annotation is of the form [$fid,$timestamp,$user,$annotation].
4479 :    
4480 :     =cut
4481 :    
4482 : overbeek 1.56 sub annotations_made {
4483 :     my($self,$genomes,$who,$date) = @_;
4484 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
4485 :     my($epoch_date,$when,@annotations);
4486 :    
4487 :     if (! defined($genomes)) { $genomes = [$self->genomes] }
4488 :    
4489 :     my %genomes = map { $_ => 1 } @$genomes;
4490 :     if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
4491 :     {
4492 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
4493 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
4494 :     }
4495 : overbeek 1.62 elsif ($date =~ /^\d+$/)
4496 :     {
4497 :     $epoch_date = $date;
4498 :     }
4499 : overbeek 1.56 else
4500 :     {
4501 :     $epoch_date = 0;
4502 :     }
4503 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
4504 : gdpusch 1.108 @annotations = ();
4505 : overbeek 1.56 my $rdbH = $self->db_handle;
4506 :     if ($who eq "master")
4507 :     {
4508 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
4509 :     }
4510 :     else
4511 :     {
4512 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
4513 :     }
4514 :    
4515 :     if ($relational_db_response && (@$relational_db_response > 0))
4516 :     {
4517 :     foreach $entry (@$relational_db_response)
4518 :     {
4519 :     ($fid,$when,$fileno,$seek,$len) = @$entry;
4520 : golsen 1.141 if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1} && (! $self->is_deleted_fid($fid)))
4521 : overbeek 1.56 {
4522 :     $ann = $self->read_annotation($fileno,$seek,$len);
4523 :    
4524 : overbeek 1.57 if ($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\n(.*\S)/s)
4525 : overbeek 1.56 {
4526 :     push(@annotations,[$1,$2,$3,$4]);
4527 :     }
4528 :     }
4529 :     }
4530 :     }
4531 :     return @annotations;
4532 :     }
4533 :    
4534 : overbeek 1.151 sub feature_attributes {
4535 :     my($self,$fid) = @_;
4536 :     my($rdbH,$relational_db_response);
4537 :    
4538 :     $rdbH = $self->db_handle;
4539 :     if (($relational_db_response = $rdbH->SQL("SELECT tag,val,url FROM attribute WHERE ( fid = \'$fid\' )")) &&
4540 :     (@$relational_db_response > 0))
4541 :     {
4542 :     return @$relational_db_response;
4543 :     }
4544 :     else
4545 :     {
4546 :     return ();
4547 :     }
4548 :     }
4549 :    
4550 :    
4551 :    
4552 : efrank 1.1 ################################# Indexing Features and Functional Roles ####################################
4553 :    
4554 :     =pod
4555 :    
4556 :     =head1 search_index
4557 :    
4558 :     usage: ($pegs,$roles) = $fig->search_pattern($pattern)
4559 :    
4560 :     All pegs that "match" $pattern are put into a list, and $pegs will be a
4561 :     pointer to that list.
4562 :    
4563 :     All roles that "match" $pattern are put into a list, and $roles will be a
4564 :     pointer to that list.
4565 :    
4566 :     The notion of "match $pattern" is intentionally left undefined. For now, you
4567 :     will probably get only entries in which each word id $pattern occurs exactly,
4568 :     but that is not a long term commitment.
4569 :    
4570 :     =cut
4571 :    
4572 :     sub search_index {
4573 :     my($self,$pattern) = @_;
4574 :     my($patternQ,@raw,@pegs,@roles);
4575 :    
4576 :     &clean_tmp;
4577 :     $patternQ = $pattern;
4578 :     $patternQ =~ s/\s+/;/g;
4579 :     $patternQ =~ s/\./\\./g;
4580 :    
4581 :     # print STDERR "pattern=$pattern patternQ=$patternQ\n";
4582 :     @raw = `$FIG_Config::ext_bin/glimpse -y -H $FIG_Config::data/Indexes -i -w \'$patternQ\'`;
4583 : overbeek 1.136 @pegs = grep { ! $self->is_deleted_fid($_->[0]) }
4584 :     sort { &FIG::by_fig_id($a->[0],$b->[0]) }
4585 : efrank 1.1 map { $_ =~ s/^\S+:\s+//; [split(/\t/,$_)] }
4586 :     grep { $_ =~ /^\S+peg.index/ } @raw;
4587 :     my %roles = map { $_ =~ s/^\S+:\s+//; $_ => 1} grep { $_ =~ /^\S+role.index/ } @raw;
4588 :     @roles = sort keys(%roles);
4589 :    
4590 :     return ([@pegs],[@roles]);
4591 :     }
4592 :    
4593 :     ################################# Loading Databases ####################################
4594 :    
4595 :    
4596 :     #=pod
4597 :     #
4598 :     #=head1 load_all
4599 :     #
4600 :     #usage: load_all
4601 :     #
4602 :     #This function is supposed to reload all entries into the database and do
4603 :     #whatever is required to properly support indexing of pegs and roles.
4604 :     #
4605 :     #=cut
4606 :    
4607 :     sub load_all {
4608 : olson 1.111 shift if UNIVERSAL::isa($_[0],__PACKAGE__);
4609 : olson 1.123
4610 :     print STDERR "\nLoading SEED data\n\n";
4611 :    
4612 :     my @packages = qw(load_peg_mapping
4613 :     index_contigs
4614 :     compute_genome_counts
4615 :     load_features
4616 :     index_sims
4617 :     index_translations
4618 :     add_assertions_of_function
4619 :     load_protein_families
4620 :     load_external_orgs
4621