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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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