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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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