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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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