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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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