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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3