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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3