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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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