Bio/DB/Registry.pm

filter: Statementstmt 78.7% 89 / 113 Branchbran 51.7% 30 / 58 Conditioncond 36.3% 4 / 11 MC/DCmcdc 0.0% 0 / 7 Subroutinesub 91.6% 11 / 12 Podpod 100% 3 / 3 totaltotal 67.1% 137 / 204 CC 37 SCAR 28.1
CC
37
Cov
68%
_make_private_registry
42.0
_load_registry
23.4
_get_ini_files
8.1
CRAP 16.6
« Bio/AlignIO/meme.pm ↑ Summary Bio/Seq/LargePrimarySeq.pm »
1 #
2 # POD documentation - main docs before the code
3  
4 =head1 NAME
5  
6 Bio::DB::Registry - Access to the Open Bio Database Access registry scheme
7  
8 =head1 SYNOPSIS
9  
10 use Bio::DB::Registry();
11  
12 $registry = Bio::DB::Registry->new();
13  
14 @available_services = $registry->services;
15  
16 $db = $registry->get_database('embl');
17 # $db is a Bio::DB::SeqI implementing class
18  
19 $seq = $db->get_Seq_by_acc("J02231");
20  
21 =head1 DESCRIPTION
22  
23 This module provides access to the Open Bio Database Access (OBDA)
24 scheme, which provides a single cross-language and cross-platform
25 specification of how to get to databases. These databases may be
26 accessible through the Web, they may be BioSQL databases, or
27 they may be local, indexed flatfile databases.
28  
29 If the user or system administrator has not installed the default init
30 file, seqdatabase.ini, in /etc/bioinformatics or ${HOME}/.bioinformatics
31 then creating the first Registry object copies the default settings from
32 the www.open-bio.org. The Registry object will attempt to store these
33 settings in a new file, ${HOME}/.bioinformatics/seqdatabase.ini.
34  
35 Users can specify one or more custom locations for the init file by
36 setting $OBDA_SEARCH_PATH to those directories, where multiple
37 directories should be separated by ';'.
38  
39 Please see the OBDA Access HOWTO for more information
40 (L<http://bioperl.org/howtos/OBDA_HOWTO.html>).
41  
42 =head2 Support
43  
44 Please direct usage questions or support issues to the mailing list:
45  
46 I<bioperl-l@bioperl.org>
47  
48 rather than to the module maintainer directly. Many experienced and
49 reponsive experts will be able look at the problem and quickly
50 address it. Please include a thorough description of the problem
51 with code and data examples if at all possible.
52  
53 =head2 Reporting Bugs
54  
55 Report bugs to the Bioperl bug tracking system to help us keep track
56 the bugs and their resolution. Bug reports can be submitted via the
57 web:
58  
59 https://github.com/bioperl/bioperl-live/issues
60  
61 =head1 APPENDIX
62  
63 The rest of the documentation details each of the object
64 methods. Internal methods are usually preceded with a _
65  
66 =cut
67  
68 # Let the code begin...
69  
70 package Bio::DB::Registry;
71 2 $Bio::DB::Registry::VERSION = '1.7.8';
72 2 ▶use vars qw($OBDA_SPEC_VERSION $OBDA_SEARCH_PATH
Subroutine BEGIN: called CC=1 SCAR=0.0
73 $HOME $PRIVATE_DIR $PUBLIC_DIR $REGISTRY
74 2 $FALLBACK_REGISTRY);
75 2 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
76  
77 2 ▶use Bio::DB::Failover;
Subroutine BEGIN: called CC=1 SCAR=0.0
78 2 ▶use Bio::Root::HTTPget;
Subroutine BEGIN: called CC=1 SCAR=0.0
79 2 ▶use base qw(Bio::Root::Root);
Subroutine BEGIN: called CC=1 SCAR=0.0
80  
81 2 ▶BEGIN {
Subroutine BEGIN: called CC=4 SCAR=14.2
82 2 $OBDA_SPEC_VERSION = 1.0;
83 2 ▶ $HOME = $ENV{HOME} if (defined $ENV{HOME});
Branch: 1 branch
BranchTrueFalseTotal
if defined $ENV{"HOME"} 2 0 2
84 2 ▶ if (defined $ENV{OBDA_SEARCH_PATH}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $ENV{"OBDA_SEARCH_PATH"}) 1 1 2
85 1 ▶ $OBDA_SEARCH_PATH = $ENV{OBDA_SEARCH_PATH} || '';
Condition50%1/2
$ENV{'OBDA_SEARCH_PATH'} || ''
l!l
10
MC/DC0%0/1
$ENV{'OBDA_SEARCH_PATH'} || ''
$ENV{'OBDA_SEARCH_PATH'}
Truth table50%1/2
A
A= $ENV{'OBDA_SEARCH_PATH'}
Aresult
11
00
86 }
87 }
88  
89 2 my %implement = ('flat' => 'Bio::DB::Flat',
90 'biosql' => 'Bio::DB::BioSQL::OBDA',
91 'biofetch' => 'Bio::DB::BioFetch'
92 # 'biocorba' => 'Bio::CorbaClient::SeqDB',
93 );
94  
95 2 $FALLBACK_REGISTRY = 'http://www.open-bio.org/registry/seqdatabase.ini';
96 2 $PRIVATE_DIR = '.bioinformatics';
97 2 $PUBLIC_DIR = '/etc/bioinformatics';
98 2 $REGISTRY = 'seqdatabase.ini';
99  
100 1 ▶sub new {
Subroutine new: called CC=1 SCAR=0.0
Pod documented
101 1 my ($class,@args) = shift;
102 1 my $self = $class->SUPER::new(@args);
103 # open files in order
104 1 $self->{'_dbs'} = {};
105 1 $self->_load_registry();
106 1 return $self;
107 }
108  
109 =head2 _load_registry
110  
111 Title : _load_registry
112 Usage :
113 Function: Looks for seqdatabase.ini files in the expected locations and
114 in the directories specified by $OBDA_SEARCH_PATH. If no files
115 are found download a default file from www.open-bio.org
116 Returns : nothing
117 Args : none
118  
119 =cut
120  
121 1 ▶sub _load_registry {
Subroutine _load_registry: called CC=19 SCAR=31.5
122 1 my $self = shift;
123 0 ▶ eval { $HOME = (getpwuid($>))[7]; } unless $HOME;
Branch: 1 branch
BranchTrueFalseTotal
unless $Bio::DB::Registry::HOME 0 1 1
124 1 ▶ if ($@) {
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 1 1
125 # Windows can have Win32::LoginName to get the Username, so check if it works before giving up
126 0 ▶ ( defined &Win32::LoginName ) ? ( $HOME = Win32::LoginName() )
Branch: 1 branch
BranchTrueFalseTotal
defined &Win32::LoginName ? : 0 0 0
127 : $self->warn("This Perl doesn't implement function getpwuid(), no \$HOME");
128 }
129 1 my @ini_files = $self->_get_ini_files();
130  
131 1 ▶ @ini_files = $self->_make_private_registry() unless (@ini_files);
Branch: 1 branch
BranchTrueFalseTotal
unless @ini_files 0 1 1
132  
133 1 my ($db,$hash) = ();
134 1 for my $file (@ini_files) {
135 2 ▶ open my $FH, '<', $file or $self->throw("Could not read file '$file': $!");
Branch: 1 branch
BranchTrueFalseTotal
open my $FH, "<", $file or $self->throw("Could not read file '${file}': $!") 2 0 2
136 2 ▶ while( <$FH> ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined($_ = readline $FH)) 34 2 36
137 34 ▶ if (/^VERSION=([\d\.]+)/) {
Branch: 1 branch
BranchTrueFalseTotal
if (/^VERSION=([\d\.]+)/) 2 32 34
138 2 ▶ if ($1 > $OBDA_SPEC_VERSION or !$1) {
Branch: 1 branch
BranchTrueFalseTotal
if ($1 > $Bio::DB::Registry::OBDA_SPEC_VERSION or not $1) 0 2 2
Condition33%1/3
$1 > $Bio::DB::Registry::OBDA_SPEC_VERSION or not $1
l!l&&r!l&&!r
002
MC/DC0%0/2
$1 > $Bio::DB::Registry::OBDA_SPEC_VERSION or not $1
$1 > $Bio::DB::Registry::OBDA_SPEC_VERSION not $1
Truth table33%1/3
A or not(B)
A= $1 > $Bio::DB::Registry::OBDA_SPEC_VERSIONB= not $1
ABresult
1X1
011
000
139 0 $self->throw("Do not know about this version [$1] > $OBDA_SPEC_VERSION");
140 0 last;
141 }
142 2 next;
143 }
144 32 ▶ next if( /^#/ );
Branch: 1 branch
BranchTrueFalseTotal
if /^#/ 0 32 32
145 32 ▶ next if( /^\s/ );
Branch: 1 branch
BranchTrueFalseTotal
if /^\s/ 8 24 32
146 24 ▶ if ( /^\[(\S+)\]/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if (/^\[(\S+)\]/) 6 18 24
147 6 $db = $1;
148 6 next;
149 }
150 18 my ($tag,$value) = split('=',$_);
151 18 $value =~ s/\s//g;
152 18 $tag =~ s/\s//g;
153 18 $hash->{$db}->{"\L$tag"} = $value;
154 }
155 }
156  
157 1 for my $db ( keys %{$hash} ) {
158 4 ▶ if ( !exists $self->{'_dbs'}->{$db} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (exists $self->{"_dbs"}{$db}) 4 0 4
159 4 my $failover = Bio::DB::Failover->new();
160 4 $self->{'_dbs'}->{$db} = $failover;
161 }
162 4 my $class;
163 4 ▶ if (defined $implement{$hash->{$db}->{'protocol'}}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $implement{$hash->{$db}{'protocol'}}) { } 4 0 4
164 4 $class = $implement{$hash->{$db}->{'protocol'}};
165 } else {
166 $self->warn("Registry does not support protocol " .
167 0 $hash->{$db}->{'protocol'});
168 0 next;
169 }
170 4 eval "require $class";
171 4 ▶ if ($@) {
Branch: 1 branch
BranchTrueFalseTotal
if ($@) { } 2 2 4
172 2 $self->warn("Couldn't load $class");
173 2 next;
174 } else {
175 2 eval {
176 2 my $randi = $class->new_from_registry( %{$hash->{$db}} );
177 1 $self->{'_dbs'}->{$db}->add_database($randi);
178 };
179 2 ▶ if ($@) {
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 1 1 2
180 1 $self->warn("Couldn't call new_from_registry() on [$class]\n$@");
181 }
182 }
183 }
184 }
185  
186  
187 =head2 get_database
188  
189 Title : get_database
190 Usage : my $db = $registry->get_database($dbname);
191 Function: Retrieve a Database object which implements Bio::DB::SeqI interface
192 Returns : Bio::DB::SeqI object
193 Args : string describing the name of the database
194  
195 =cut
196  
197 1 ▶sub get_database {
Subroutine get_database: called CC=3 SCAR=13.6
Pod documented
198 1 my ($self,$dbname) = @_;
199  
200 1 $dbname = lc $dbname;
201 1 ▶ if( !defined $dbname ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $dbname) 0 1 1
202 0 $self->warn("must get_database with a database name");
203 0 return;
204 }
205 1 ▶ if( !exists $self->{'_dbs'}->{$dbname} ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (exists $self->{"_dbs"}{$dbname}) 0 1 1
206 0 $self->warn("No database with name $dbname in Registry");
207 0 return;
208 }
209 1 return $self->{'_dbs'}->{$dbname};
210 }
211  
212 =head2 services
213  
214 Title : services
215 Usage : my @available = $registry->services();
216 Function: returns list of possible services
217 Returns : list of strings
218 Args : none
219  
220 =cut
221  
222 1 ▶sub services {
Subroutine services: called CC=3 SCAR=12.0
Pod documented
223 1 my ($self) = @_;
224 return () unless ( defined $self->{'_dbs'} &&
225 1 ▶ ref( $self->{'_dbs'} ) =~ /HASH/i);
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"_dbs"} and ref($self->{"_dbs"}) =~ /HASH/i 0 1 1
Condition33%1/3
defined $self->{"_dbs"} and ref($self->{"_dbs"}) =~ /HASH/i
!ll&&!rl&&r
001
MC/DC0%0/2
defined $self->{"_dbs"} and ref($self->{"_dbs"}) =~ /HASH/i
defined $self->{"_dbs"} ref($self->{"_dbs"}) =~ /HASH/i
Truth table33%1/3
A and B
A= defined $self->{"_dbs"}B= ref($self->{"_dbs"}) =~ /HASH/i
ABresult
0X0
100
111
226 1 return keys %{$self->{'_dbs'}};
227 }
228  
229 =head2 _get_ini_files
230  
231 Title : _get_ini_files
232 Usage : my @files = $self->_get_ini_files
233 Function: To find all the seqdatabase.ini files
234 Returns : list of seqdatabase.ini paths
235 Args : None
236  
237 =cut
238  
239 1 ▶sub _get_ini_files {
Subroutine _get_ini_files: called CC=7 SCAR=21.0
240 1 my $self = shift;
241 1 my @ini_files = ();
242 1 ▶ if ( $OBDA_SEARCH_PATH ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($Bio::DB::Registry::OBDA_SEARCH_PATH) 1 0 1
243 1 foreach my $dir ( split /;/, $OBDA_SEARCH_PATH ) {
244 2 my $file = $dir . "/" . $REGISTRY;
245 2 ▶ next unless -e $file;
Branch: 1 branch
BranchTrueFalseTotal
unless -e $file 0 2 2
246 2 push @ini_files,$file;
247 }
248 }
249 1 ▶ push @ini_files,"$HOME/$PRIVATE_DIR/$REGISTRY"
Branch: 1 branch
BranchTrueFalseTotal
if $Bio::DB::Registry::HOME and -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY" 0 1 1
Condition33%1/3
$Bio::DB::Registry::HOME and -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY"
!ll&&!rl&&r
010
MC/DC0%0/2
$Bio::DB::Registry::HOME and -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY"
$Bio::DB::Registry::HOME -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY"
Truth table33%1/3
A and B
A= $Bio::DB::Registry::HOMEB= -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY"
ABresult
0X0
100
111
250 if ( $HOME && -e "$HOME/$PRIVATE_DIR/$REGISTRY" );
251 1 ▶ push @ini_files, "$PUBLIC_DIR/$REGISTRY"
Branch: 1 branch
BranchTrueFalseTotal
if -e "$Bio::DB::Registry::PUBLIC_DIR/$Bio::DB::Registry::REGISTRY" 0 1 1
252 if ( -e "$PUBLIC_DIR/$REGISTRY" );
253 1 @ini_files;
254 }
255  
256 =head2 _make_private_registry
257  
258 Title : _make_private_registry
259 Usage :
260 Function: Make private registry in file in $HOME
261 Returns : Path to private registry file
262 Args : None
263  
264 =cut
265  
266 0 ▶sub _make_private_registry {
Subroutine _make_private_registry: not called CC=6 SCAR=37.4
267 0 my $self = shift;
268 0 my @ini_file;
269  
270 0 ▶ my $nor_in = $OBDA_SEARCH_PATH ?
Branch: 1 branch
BranchTrueFalseTotal
$Bio::DB::Registry::OBDA_SEARCH_PATH ? : 0 0 0
271 "nor in directory specified by\n$OBDA_SEARCH_PATH" :
272 "and environment variable OBDA_SEARCH_PATH wasn't set";
273  
274 0 $self->warn("No $REGISTRY file found in $HOME/$PRIVATE_DIR/\n" .
275 "nor in $PUBLIC_DIR $nor_in.\n" .
276 "Using web to get registry from\n$FALLBACK_REGISTRY");
277  
278 # Last gasp. Try to use HTTPget module to retrieve the registry from
279 # the web...
280 0 my $f = Bio::Root::HTTPget::getFH($FALLBACK_REGISTRY);
281  
282 # store the default registry file
283 0 eval {
284 0 ▶ mkdir "$HOME/$PRIVATE_DIR" unless -e "$HOME/$PRIVATE_DIR";
Branch: 1 branch
BranchTrueFalseTotal
unless -e "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR" 0 0 0
285 };
286 0 ▶ $self->throw("Could not make directory $HOME/$PRIVATE_DIR, " .
Branch: 1 branch
BranchTrueFalseTotal
if $@ 0 0 0
287 "no $REGISTRY file available") if $@;
288  
289 0 ▶ open my $F, '>', "$HOME/$PRIVATE_DIR/$REGISTRY"
Branch: 1 branch
BranchTrueFalseTotal
open my $F, ">", "$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY" or $self->throw("Could not write file '$Bio::DB::Registry::HOME/$Bio::DB::Registry::PRIVATE_DIR/$Bio::DB::Registry::REGISTRY': $!") 0 0 0
290 or $self->throw("Could not write file '$HOME/$PRIVATE_DIR/$REGISTRY': $!");
291 0 ▶ print $F while (<$F>);
Branch: 1 branch
BranchTrueFalseTotal
defined($_ = readline $F) and do { print $F } 0 0 0
292 0 close $F;
293  
294 0 $self->warn("Stored $REGISTRY file in $HOME/$PRIVATE_DIR");
295  
296 0 push @ini_file,"$HOME/$PRIVATE_DIR/$REGISTRY";
297 0 @ini_file;
298 }
299  
300 2 1;
301  
302 __END__
« Bio/AlignIO/meme.pm ↑ Summary Bio/Seq/LargePrimarySeq.pm »