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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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