Registry.pm 40.8 KB
Newer Older
Ian Longden's avatar
Ian Longden committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
#
# Ensembl module for Registry
#
# Copyright EMBL/EBI
##
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

Bio::EnsEMBL::Registry

=head1 SYNOPSIS

16 17
Bio::EnsEMBL::Registry->load_all("configuration_file");

18 19
$gene_adaptor =
  Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "gene" );
Ian Longden's avatar
Ian Longden committed
20 21 22 23


=head1 DESCRIPTION

24 25
All Adaptors are stored/registered using this module. This module should
then be used to get the adaptors needed.
Ian Longden's avatar
Ian Longden committed
26

27 28
The registry can be loaded from a configuration file using the load_all
method.
Ian Longden's avatar
Ian Longden committed
29

30 31 32 33
If a filename is passed to load_all then this is used.  Else if the
enviroment variable ENSEMBL_REGISTRY is set to the name on an existing
configuration file, then this is used.  Else if the file .ensembl_init
in your home directory exist, it is used.
Ian Longden's avatar
Ian Longden committed
34

35 36
For the Web server ENSEMBL_REGISTRY should be set in SiteDefs.pm.  This
will then be passed on to load_all.
37 38


39 40 41 42 43
The registry can also be loaded via the method load_registry_from_db
which given a database host will load the latest versions of the Ensembl
databases from it.

The four types of registries are for db adaptors, dba adaptors, dna adaptors
Ian Longden's avatar
Ian Longden committed
44 45 46 47
and the standard type.

=head2 db

48
These are registries for backwards compatibility and enable the subroutines
49
to add other adaptors to connections. 
Ian Longden's avatar
Ian Longden committed
50 51 52 53 54

e.g. get_all_db_adaptors, get_db_adaptor, add_db_adaptor, remove_db_adaptor
are the old DBAdaptor subroutines which are now redirected to the Registry.

So if before we had
55 56

    my $sfa = $self->adaptor()->db()->get_db_adaptor('blast');
Ian Longden's avatar
Ian Longden committed
57 58

We now want to change this to
59 60 61

    my $sfa =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "blast" );
Ian Longden's avatar
Ian Longden committed
62 63 64 65 66 67 68 69 70


=head2 DBA

These are the stores for the DBAdaptors

The Registry will create all the DBConnections needed now if you set up the
configuration correctly. So instead of the old commands like

71 72
    my $db           = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
    my $exon_adaptor = $db->get_ExonAdaptor;
Ian Longden's avatar
Ian Longden committed
73 74 75

we should now have just

76 77
    my $exon_adaptor =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
78 79 80 81 82


=head2 DNA

This is an internal Registry and allows the configuration of a dnadb. 
Steve Trevanion's avatar
Steve Trevanion committed
83
An example here is to set the est database to get its dna data from the core database.
Ian Longden's avatar
Ian Longden committed
84

85 86 87
    ## set the est db to use the core for getting dna data.
    # Bio::EnsEMBL::Utils::ConfigRegistry->dnadb_add(
    #         "Homo Sapiens", "core", "Homo Sapiens", "est" );
Ian Longden's avatar
Ian Longden committed
88 89 90 91 92 93 94 95 96


=head2 adaptors

This is the registry for all the general types of adaptors like GeneAdaptor, ExonAdaptor, 
Slice Adaptor etc.

These are accessed by the get_adaptor subroutine i.e.

97 98
    my $exon_adaptor =
      Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113

=head1 CONTACT

Post questions to the Ensembl developer list: <ensembl-dev@ebi.ac.uk>


=head1 METHODS

=cut


package Bio::EnsEMBL::Registry;

use strict;

114
use Bio::EnsEMBL::DBSQL::DBAdaptor;
Ian Longden's avatar
Ian Longden committed
115 116
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
117
use Bio::EnsEMBL::Utils::ConfigRegistry;
118
use DBI;
Ian Longden's avatar
Ian Longden committed
119 120 121

use vars qw(%registry_register);

Glenn Proctor's avatar
Glenn Proctor committed
122
my $API_VERSION = 45;
123

Ian Longden's avatar
Ian Longden committed
124 125

=head2 load_all
126

127 128 129 130 131 132 133 134
 Will load the registry with the configuration file which is obtained
 from the first in the following and in that order.

  1) If an argument is passed to this method, this is used as the name
     of the configuration file to read.

  2) If the enviroment variable ENSEMBL_REGISTRY is set, this is used as
     the name of the configuration file to read.
Ian Longden's avatar
Ian Longden committed
135

136 137
  3) If the file .ensembl_init exist in the home directory, it is used
     as the configuration file.
Ian Longden's avatar
Ian Longden committed
138

139 140 141 142 143 144 145 146
  Arg [1]    : (optional) string
               Name of file to load the registry from.
  Arg [2]    : (optional) integer
               If not 0, will print out all information.
  Arg [3]    : (optional) integer
               If not 0, the db connection will not be cleared, if 0 or
               if not set the db connections will be cleared (this is
               the default).
Ian Longden's avatar
Ian Longden committed
147 148 149
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
150
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
151 152 153 154

=cut
 
sub load_all{
155
  my $class = shift;
156
  my $conf_file = shift;
157
  my $verbose = shift;
158
  my $no_clear = shift ; 
159
  
160 161 162 163 164
  if(defined($registry_register{'seen'})){ 
    unless ( $no_clear ) { 
      print STDERR "Clearing previuosly loaded configuration from Registry\n" if ($verbose);
      $class->clear();
    }
165 166
  }
  $registry_register{'seen'}=1;
167
  if(defined($conf_file)){
168 169
    print STDERR  "Loading conf from site defs file ".$conf_file."\n" if ($verbose);
;
170
    if(-e $conf_file){
171 172
      eval{ require($conf_file) }; $@ && die($@);
      
173
      # other wise it gets done again by the web initialisation stuff
174
      delete $INC{$conf_file}; 
175
    }
Ian Longden's avatar
Ian Longden committed
176 177 178
    else{ #error message
      print STDERR "File passed (".$conf_file.") does not exist therefore no configuration loaded\n";
    }
179 180 181
  }
  elsif(defined($ENV{ENSEMBL_REGISTRY}) and -e $ENV{ENSEMBL_REGISTRY}){
    my $file = $ENV{ENSEMBL_REGISTRY};
182 183 184
    print STDERR  "Loading conf from ".$file."\n"  if ($verbose);
;
    eval{ require($file) }; $@ && die($@);
185 186 187 188
  }
  elsif(-e $ENV{HOME}."/.ensembl_init") {
    my $file = $ENV{HOME}."/.ensembl_init";
    
189
    eval{ require($file) }; $@ && die($@)
190 191
  }
  else{
192
    print STDERR "NO default configuration to load\n" if ($verbose);
193 194 195 196 197
  }
}


=head2 clear
198

199 200 201 202 203
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
204
  Status     : Stable
205 206 207 208 209 210 211 212 213 214 215

=cut

sub clear{
  my ($self);
  
  foreach my $dba (@{$registry_register{'_DBA'}}){
    if($dba->dbc->connected){
      $dba->dbc->db_handle->disconnect();
    }
  }
Ian Longden's avatar
Ian Longden committed
216
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
217 218 219
}

#
220
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
221 222 223 224
#

=head2 add_db

225
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
226 227 228 229 230
  Arg [2]    : name of the name to add the adaptor to in the registry.
  Arg [3]    : The adaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_db($db, "lite", $dba);
  Returntype : none
  Exceptions : none
231
  Status     : At Risk.
232
             : This is here for backwards compatibility only and may be removed 
233 234 235
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species and the call is then no longer needed.
             
Ian Longden's avatar
Ian Longden committed
236 237 238 239 240 241
=cut

sub add_db{
  my ($class, $db, $name, $adap) = @_;


242 243
  if(lc($db->species()) ne lc($adap->species)){
    $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = $adap;
244
  }
Ian Longden's avatar
Ian Longden committed
245 246 247 248
}

=head2 remove_db

249
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
250 251 252 253
  Arg [2]    : name to remove the adaptor from in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->remove_db($db, "lite");
  Returntype : adaptor
  Exceptions : none
254
  Status     : At Risk.
255
             : This is here for backwards compatibility only and may be removed 
256 257
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species and the call is then no longer needed.
Ian Longden's avatar
Ian Longden committed
258 259 260 261 262 263

=cut

sub remove_db{
  my ($class, $db, $name) = @_;

264 265
  my $ret = $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
  $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = undef;
Ian Longden's avatar
Ian Longden committed
266 267 268 269 270 271

  return $ret;
}

=head2 get_db

272
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
273 274 275 276
  Arg [2]    : name to get the adaptor for in the registry.
  Example    : my $db = Bio::EnsEMBL::Registry->get_db("Human", "core", "lite");
  Returntype : adaptor
  Exceptions : none
277
  Status     : At Risk.
278
             : This is here for backwards compatibility only and may be removed 
279 280
             : eventually. Solution is to make sure the db and the adaptor have
             : the same species then call get_DBAdaptor instead.
Ian Longden's avatar
Ian Longden committed
281 282 283 284 285 286

=cut

sub get_db{
  my ($class, $db, $name) = @_;

287
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor(lc($db->species),lc($name));
288 289 290 291

  if(defined($ret)){
    return $ret;
  }
292
  return $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
Ian Longden's avatar
Ian Longden committed
293 294 295 296
}

=head2 get_all_db_adaptors

297
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
298 299 300
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
301
  Status     : At Risk.
302
             : This is here for backwards compatibility only and may be removed 
303 304 305
             : eventually. Solution is to make sure the dbs all have
             : the same species then call get_all_DBAdaptors(-species => "human");

Ian Longden's avatar
Ian Longden committed
306 307 308 309 310 311 312

=cut

sub get_all_db_adaptors{
  my ($class,$db) = @_;
  my %ret=();

Ian Longden's avatar
Ian Longden committed
313 314 315 316
# we now also want to add all the DBAdaptors for the same species.
# as add_db_adaptor does not add if it is from the same species.

  foreach my $dba (@{$registry_register{'_DBA'}}){
317
    if(lc($dba->species()) eq lc($db->species())){
Ian Longden's avatar
Ian Longden committed
318 319 320 321
      $ret{$dba->group()} = $dba;
    } 
  }

322
 foreach my $key (keys %{$registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}}){
323
   $ret{$key} = $registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}{$key};
Ian Longden's avatar
Ian Longden committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
 }

  return \%ret;
}


#
# DBAdaptors
#

=head2 add_DBAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : The DBAaptor to be added to the registry.
  Example    : Bio::EnsEMBL::Registry->add_DBAdaptor("Human", "core", $dba);
  Returntype : none
  Exceptions : none
342 343
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
344 345 346 347 348 349

=cut

sub add_DBAdaptor{
  my ($class, $species, $group, $adap) = @_;

350 351 352 353 354
  if(!($class->alias_exists($species))){
    $class->add_alias($species,$species);
  }
  

Ian Longden's avatar
Ian Longden committed
355 356
  $species = $class->get_alias($species);

357
  $registry_register{$species}{lc($group)}{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

  if(!defined($registry_register{'_DBA'})){
    my @list =();
    push(@list,$adap);
    $registry_register{'_DBA'}= \@list;
  }
  else{
    push(@{$registry_register{'_DBA'}},$adap);
  }

}



=head2 get_DBAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dba = Bio::EnsEMBL::Registry->get_DBAdaptor("Human", "core");
  Returntype : DBAdaptor
  Exceptions : none
379
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
380 381 382 383 384 385 386 387

=cut

sub get_DBAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);

388 389
  return  $registry_register{$species}{lc($group)}{'_DB'};

Ian Longden's avatar
Ian Longden committed
390 391 392 393
}

=head2 get_all_DBAdaptors

394 395 396 397 398 399 400 401
  Arg [SPECIES]: (optional) string 
                  species name to get adaptors for
  Arg [GROUP]  : (optional) string 
                  group name to get adaptors for
  Example      : @dba = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors()};
               : @human_dbas = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors(-species => 'human')};
  Returntype   : list of DBAdaptors
  Exceptions   : none
402
  Status       : Stable
Ian Longden's avatar
Ian Longden committed
403 404 405 406

=cut

sub get_all_DBAdaptors{
407 408
  my ($class,@args)=@_;
  my @ret;
Ian Longden's avatar
Ian Longden committed
409

410 411 412 413 414 415
  my ($species, $group) = 
    rearrange([qw(SPECIES GROUP)], @args);
  if(defined($species)){
    $species = $class->get_alias($species);
  }
  foreach my $dba (@{$registry_register{'_DBA'}}){
416
    if(!defined($species) || lc($species) eq lc($dba->species)){
417 418 419 420 421 422 423 424
      if(!defined($group) || lc($group) eq lc($dba->group)){
	push @ret, $dba;
      }
    }
  }


  return \@ret;
Ian Longden's avatar
Ian Longden committed
425 426
}

427 428 429 430 431 432
=head2 get_all_DBAdaptors_by_connection

  Arg [1]    :dbconnection to use to find DBAdaptors
  Returntype : reference to list of DBAdaptors
  Exceptions : none.
  Example    : @dba = @{Bio::EnsEMBL::Registry->get_all_DBAdaptors_by_connection($dbc);
433
  Status     : Stable
434 435 436 437 438 439 440 441 442

=cut

sub get_all_DBAdaptors_by_connection{
  my ($self, $dbc_orig) = @_;
  my @return;

  foreach my $dba ( @{$registry_register{'_DBA'}}){
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
443
    if($dbc && $dbc->can('equals') && $dbc->equals($dbc_orig)){
444 445 446 447 448 449 450
      push @return, $dba;
    }
  }
  return \@return;
}


Ian Longden's avatar
Ian Longden committed
451 452 453 454 455 456 457 458
#
# DNA Adaptors
#

=head2 add_DNAAdaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
459 460 461
  Arg [3]    : name of the species to get the dna from
  Arg [4]    : name of the group to get the dna from
  Example    : Bio::EnsEMBL::Registry->add_DNAAdaptor("Human", "estgene", "Human", "core");
Ian Longden's avatar
Ian Longden committed
462 463
  Returntype : none
  Exceptions : none
464
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
465 466 467 468

=cut

sub add_DNAAdaptor{
Ian Longden's avatar
Ian Longden committed
469
  my ($class, $species, $group, $dnadb_species, $dnadb_group) = @_;
Ian Longden's avatar
Ian Longden committed
470 471

  $species = $class->get_alias($species);
472
  $dnadb_species = $class->get_alias($dnadb_species);
473
  if($dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor')){
Ian Longden's avatar
Ian Longden committed
474
    deprecated("");
475 476
  }
  else{
477 478
    $registry_register{$species}{lc($group)}{'_DNA'} = $dnadb_group;
    $registry_register{$species}{lc($group)}{'_DNA2'} = $dnadb_species;
479
  }
Ian Longden's avatar
Ian Longden committed
480 481 482 483 484 485 486 487 488
}

=head2 get_DNAAdaptor

  Arg [1]    : name of the species to get the adaptor for in the registry.
  Arg [2]    : name of the group to get the adaptor for in the registry.
  Example    : $dnaAdap = Bio::EnsEMBL::Registry->get_DNAAdaptor("Human", "core");
  Returntype : adaptor
  Exceptions : none
489
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
490 491 492 493 494 495 496

=cut

sub get_DNAAdaptor{
  my ($class, $species, $group) = @_;

  $species = $class->get_alias($species);
497 498
  my $new_group = $registry_register{$species}{lc($group)}{'_DNA'};
  my $new_species = $registry_register{$species}{lc($group)}{'_DNA2'};
499
  if( defined $new_group ) {
Ian Longden's avatar
Ian Longden committed
500
    return  $class->get_DBAdaptor($new_species,$new_group);
501 502 503
  } else {
    return undef;
  }
Ian Longden's avatar
Ian Longden committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
}

#
# General Adaptors
#

=head2 add_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Arg [4]    : The DBAaptor to be added to the registry.
  Arg [5]    : (optional) if set okay to overwrite.
  Example    : Bio::EnsEMBL::Registry->add_adaptor("Human", "core", "Gene", $adap);
  Returntype : none
  Exceptions : none
520 521
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538


=cut

sub add_adaptor{
  my ($class,$species,$group,$type,$adap, $reset)= @_;

  $species = $class->get_alias($species);

#
# Becouse the adaptors are not stored initially only there class paths when
# the adaptors are obtained we need to store these instead.
# It is not necessarily an error if the registry is overwritten without
# the reset set but it is an indication that we are overwriting a database
# which should be a warning for now
#

539
  if(defined($reset)){ # JUST REST THE HASH VALUE NO MORE PROCESSING NEEDED
540
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
541 542
    return;
  }
543
  if(defined($registry_register{$species}{lc($group)}{lc($type)})){ 
Glenn Proctor's avatar
Glenn Proctor committed
544
    #print STDERR ("Overwriting Adaptor in Registry for $species $group $type\n");
545
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
546 547
   return;
  }
548
  $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
549 550 551

  if(!defined ($registry_register{$species}{'list'})){
    my @list =();
552
    push(@list,$type);
Ian Longden's avatar
Ian Longden committed
553 554 555
    $registry_register{$species}{'list'}= \@list;
  }
  else{
556
    push(@{$registry_register{$species}{'list'}},$type);
Ian Longden's avatar
Ian Longden committed
557 558
  }

559

Ian Longden's avatar
Ian Longden committed
560

561
  if(!defined ($registry_register{lc($type)}{$species})){
Ian Longden's avatar
Ian Longden committed
562 563
    my @list =();
    push(@list,$adap);
564
    $registry_register{lc($type)}{$species}= \@list;
Ian Longden's avatar
Ian Longden committed
565 566
  }
  else{
567
    push(@{$registry_register{lc($type)}{$species}},$adap);
Ian Longden's avatar
Ian Longden committed
568 569 570 571 572 573 574 575 576 577 578 579 580
  }

}


=head2 get_adaptor

  Arg [1]    : name of the species to add the adaptor to in the registry.
  Arg [2]    : name of the group to add the adaptor to in the registry.
  Arg [3]    : name of the type to add the adaptor to in the registry.
  Example    : $adap = Bio::EnsEMBL::Registry->get_adaptor("Human", "core", "Gene");
  Returntype : adaptor
  Exceptions : none
581
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
582 583 584 585 586 587

=cut

sub get_adaptor{
  my ($class,$species,$group,$type)= @_;
 
588
  $species = $class->get_alias($species);
589
  my %dnadb_adaptors = qw(sequence  1 assemblymapper 1  karyotypeband 1 repeatfeature 1 coordsystem 1  assemblyexceptionfeature 1 );
590

591
  my $dnadb_group =  $registry_register{$species}{lc($group)}{_DNA};
592

593 594
  if( defined($dnadb_group) && defined($dnadb_adaptors{lc($type)}) ) {
      $species = $registry_register{$species}{lc($group)}{'_DNA2'};
595
      $group = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
596 597
  }

598
  my $ret = $registry_register{$species}{lc($group)}{lc($type)};
Ian Longden's avatar
Ian Longden committed
599
  if(!defined($ret)){
600
    return undef;
Ian Longden's avatar
Ian Longden committed
601 602
  }
  if(!ref($ret)){ # not instantiated yet
603
    my $dba = $registry_register{$species}{lc($group)}{'_DB'};
Ian Longden's avatar
Ian Longden committed
604 605 606 607 608 609 610
    my $module = $ret;
    eval "require $module";

    if($@) {
      warning("$module cannot be found.\nException $@\n");
      return undef;
    }
611 612 613 614
    if(!defined($registry_register{$species}{lc($group)}{'CHECKED'})){
      $registry_register{$species}{lc($group)}{'CHECKED'} = 1;
      $class->version_check($dba);
    }
Ian Longden's avatar
Ian Longden committed
615 616 617 618 619 620 621 622 623 624
    my $adap = "$module"->new($dba);
    Bio::EnsEMBL::Registry->add_adaptor($species, $group, $type, $adap, "reset");
    $ret = $adap;
  }

  return $ret;
}

=head2 get_all_adaptors

625 626 627 628 629 630
  Arg [SPECIES] : (optional) string 
                  species name to get adaptors for
  Arg [GROUP] : (optional) string 
                  group name to get adaptors for
  Arg [TYPE] : (optional) string 
                  type to get adaptors for
Ian Longden's avatar
Ian Longden committed
631
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
632
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
633
  Exceptions : none
634
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
635 636 637 638

=cut

sub get_all_adaptors{
639 640 641 642
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
643

644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

  if(@args == 1){ #old species only one parameter
    warn("-SPECIES argument should now be used to get species adaptors");
    $species = $args[0];
  }
  else{
    # new style -SPECIES, -GROUP, -TYPE
    ($species, $group, $type) =
      rearrange([qw(SPECIES GROUP TYPE)], @args);
  }

  if(defined($species)){
    $species_hash{$species} = 1;
  }
  else{
    # get list of species
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $species_hash{lc($dba->species())} = 1;
    }
  }
  if(defined($group)){
    $group_hash{$group} = 1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){
      $group_hash{lc($dba->group())} = 1;
    }
  }
  if(defined($type)){
    $type_hash{$type} =1;
  }
  else{
    foreach my $dba (@{$registry_register{'_DBA'}}){ 
677
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
	  $type_hash{lc($ty)} = 1;
	}
      }
  }
  
  ### NOW NEED TO INSTANTIATE BY CALLING get_adaptor
  foreach my $sp (keys %species_hash){
    foreach my $gr (keys %group_hash){
      foreach my $ty (keys %type_hash){
	my $temp = $class->get_adaptor($sp,$gr,$ty);
	if(defined($temp)){
	  push @ret, $temp;
	}
      }
    }
  }
  return (\@ret);
Ian Longden's avatar
Ian Longden committed
695 696 697 698 699 700 701 702 703 704 705
}


=head2 add_alias

  Arg [1]    : name of the species to add alias for
  Arg [2]    : name of the alias
  Example    : Bio::EnsEMBL::Registry->add_alias("Homo Sapiens","Human");
  Description: add alternative name for the species.
  Returntype : none
  Exceptions : none
706
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
707 708 709 710 711 712

=cut

sub add_alias{
  my ($class, $species,$key) = @_;

713
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
714 715 716 717 718 719 720 721
}

=head2 get_alias

  Arg [1]    : name of the possible alias to get species for
  Example    : Bio::EnsEMBL::Registry->get_alias("Human");
  Description: get proper species name.
  Returntype : species name
722
  Exceptions : none
723
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
724 725 726 727

=cut

sub get_alias{
728
  my ($class, $key) = @_;
Ian Longden's avatar
Ian Longden committed
729

730
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
731
    return $key;
Ian Longden's avatar
Ian Longden committed
732
  }
733
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
734
}
735 736 737 738

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
Ian Longden's avatar
Ian Longden committed
739
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
740 741 742
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
743
  Status     : Stable
744 745 746 747 748 749

=cut

sub alias_exists{
  my ($class, $key) = @_;

750
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
751 752 753 754
    return 1;
  }
  return 0;
}
755

756 757 758 759 760 761 762
=head2 set_disconnect_when_inactive

  Example    : Bio::EnsEMBL::Registry->set_disconnect_when_inactive();
  Description: Set the flag to make sure that the database connection is dropped if
               not being used on each database.
  Returntype : none
  Exceptions : none
763
  Status     : Stable
764 765 766

=cut

767
sub set_disconnect_when_inactive{
768
  foreach my $dba ( @{get_all_DBAdaptors()}){
769 770
    my $dbc = $dba->dbc;
    #disconnect if connected
771
    $dbc->disconnect_if_idle() if $dbc->connected();
772 773 774
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
775

776 777 778 779 780 781 782

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
783
  Status     : Stable
784 785 786

=cut

787
sub disconnect_all {
Web Admin's avatar
fixed  
Web Admin committed
788
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
789
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
790
    next unless $dbc;
791 792 793 794
    #disconnect if connected
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
795

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
=head2 change_access

  Will change the username and password for a set of databases.
  if host,user or database names are missing then these are not checked.
  So for example if you do not specify a database then ALL databases on
  the specified  host and port will be changed.

  Arg [1]    : name of the host to change access on
  Arg [2]    : port number to change access on
  Arg [3]    : name of the user to change access on
  Arg [4]    : name of the database to change access on
  Arg [5]    : name of the new user
  Arg [6]    : new password

  Example    : Bio::EnsEMBL::Registry->get_alias("Human");
  Description: change username and password on one or more databases
  Returntype : none
  Exceptions : none
814
  Status     : Stable
815 816 817 818

=cut

sub change_access{
Steve Trevanion's avatar
Steve Trevanion committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
my $self = shift;
    my ($host,$port,$user,$dbname,$new_user,$new_pass) = @_;
    foreach my $dba ( @{$registry_register{'_DBA'}}){
	my $dbc = $dba->dbc;
	if((!defined($host) or $host eq $dbc->host) and
	   (!defined($port) or $port eq $dbc->port) and
	   (!defined($user) or $user eq $dbc->username) and
	   (!defined($dbname) or $dbname eq $dbc->dbname)){
	    if($dbc->connected()){
		$dbc->db_handle->disconnect();
		$dbc->connected(undef);
	    }
	    # over write the username and password
	    $dbc->username($new_user);
	    $dbc->password($new_pass);
	}
835 836 837
    }
}

838 839


840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
=head2 load_registry_from_url

  Arg [1]    : string $url
  Example : load_registry_from_url("mysql://anonymous@ensembldb.ensembl.org:3306");
  Description: Will load the correct versions of the ensembl databases for the
               software release it can find on a database instance into the 
               registry. Also adds a set of standard aliases. The url format is:
               mysql://[[username][:password]@]hostname[:port].
               You can also request a specific version for the databases by adding
               a slash and the version number but your script may crash as the API
               version won't match the DB version.
  Exceptions : None.
  Status     : Stable
 
=cut

sub load_registry_from_url {
  my ($self, $url, $verbose) = @_;

  if ($url =~ /mysql\:\/\/([^\@]+\@)?([^\:\/]+)(\:\d+)?(\/\d+)?/) {
    my $user_pass = $1;
    my $host = $2;
    my $port = $3;
    my $version = $4;

    $user_pass =~ s/\@$//;
    my ($user, $pass) = $user_pass =~ m/([^\:]+)(\:.+)?/;
    $pass =~ s/^\:// if ($pass);
    $port =~ s/^\:// if ($port);
    $version =~ s/^\/// if ($version);

    $self->load_registry_from_db(
        -host=> $host,
        -user => $user,
        -pass => $pass,
        -port => $port,
        -db_version => $version,
        -verbose => $verbose);
  } else {
    throw("Only MySQL URLs are accepted at the moment");
  }
}


884
=head2 load_registry_from_db
885

886 887 888 889 890 891 892 893 894
  Arg [HOST] : The domain name of the database host to connect to.
               
  Arg [USER] : string
               The name of the database user to connect with
  Arg [PASS] : (optional) string
               The password to be used to connect to the database
  Arg [PORT] : int
               The port to use when connecting to the database
  Arg [VERBOSE]: (optional) Wether to print database messages 
895 896 897 898 899 900
  Arg [DB_VERSION]: (optional) By default, only databases corresponding
               to this API version are loaded. This allows the script to
               use databases from another version although it might not
               work properly. This option should only be used for
               production or testing purposes and if you really know what
               you are doing.
901 902 903 904 905

  Example : load_registry_from_db( -host => 'ensembldb.ensembl.org',
				   -user => 'anonymous',
				   -verbose => "1" );

906
  Description: Will load the correct versions of the ensembl databases for the
907
               software release it can find on a database instance into the 
908
               registry. Also adds a set of standard aliases.
909 910

  Exceptions : None.
911
  Status     : Stable
912 913
 
=cut
914

915
sub load_registry_from_db {
916
  my($self, @args) = @_;
917 918
  my ($host, $port, $user, $pass, $verbose, $db_version) =
    rearrange([qw(HOST PORT USER PASS VERBOSE DB_VERSION)], @args);
919 920 921 922 923 924 925



  my $go_version = 0;
  my $compara_version =0;

  $user ||= "ensro";
926
  $port ||= 3306;
927 928 929 930 931 932
  my $db = DBI->connect( "DBI:mysql:host=$host;port=$port" , $user, $pass );

  my $res = $db->selectall_arrayref( "show databases" );
  my @dbnames = map {$_->[0] } @$res;
  
  my %temp;
933
  my $software_version = $self->software_version();
934 935 936
  if (defined($db_version)) {
    $software_version = $db_version;
  }
937
  print "Will only load $software_version databases\n" if ($verbose);
938 939
  for my $db (@dbnames){
    if($db =~ /^([a-z]+_[a-z]+_[a-z]+)_(\d+)_(\d+[a-z]*)/){
940
      if($2 eq $software_version){
941 942 943 944
	$temp{$1} = $2."_".$3;
      }
    }
    elsif($db =~ /^ensembl_compara_(\d+)/){
945
      if($1 eq $software_version){
946 947 948 949
	$compara_version = $1;
      }
    }
    elsif($db =~ /^ensembl_go_(\d+)/){
950
      if($1 eq $software_version){
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
	$go_version = $1;
      }
    }
  }
  
  @dbnames =();
  
  foreach my $key ( keys %temp){
    push @dbnames, $key."_".$temp{$key};
  }	 
  # register core databases
  
  my @core_dbs = grep { /^[a-z]+_[a-z]+_core_\d+_/ } @dbnames;
  
  for my $coredb ( @core_dbs ) {
    my ($species, $num ) = ( $coredb =~ /(^[a-z]+_[a-z]+)_core_(\d+)/ );
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new
      ( -group => "core",
	-species => $species,
	-host => $host,
	-user => $user,
	-pass => $pass,
	-port => $port,
	-dbname => $coredb
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $coredb." loaded\n" if ($verbose);
  }
980

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
  # register cdna databases
  
  my @cdna_dbs = grep { /^[a-z]+_[a-z]+_cdna_\d+_/ } @dbnames;
  
  for my $cdnadb ( @cdna_dbs ) {
    my ($species, $num ) = ( $cdnadb =~ /(^[a-z]+_[a-z]+)_cdna_(\d+)/ );
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new
      ( -group => "cdna",
	-species => $species,
	-host => $host,
	-user => $user,
	-pass => $pass,
	-port => $port,
	-dbname => $cdnadb
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $cdnadb." loaded\n" if ($verbose);
  }

1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  my @vega_dbs = grep { /^[a-z]+_[a-z]+_vega_\d+_/ } @dbnames;
  
  for my $vegadb ( @vega_dbs ) {
    my ($species, $num ) = ( $vegadb =~ /(^[a-z]+_[a-z]+)_vega_(\d+)/ );
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new
      ( -group => "vega",
	-species => $species,
	-host => $host,
	-user => $user,
	-pass => $pass,
	-port => $port,
	-dbname => $vegadb
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $vegadb." loaded\n" if ($verbose);
  }
1018
  
Ian Longden's avatar
Ian Longden committed
1019
  my @other_dbs = grep { /^[a-z]+_[a-z]+_otherfeatures_\d+_/ } @dbnames;
1020
  
Ian Longden's avatar
Ian Longden committed
1021 1022
  for my $other_db ( @other_dbs ) {
    my ($species, $num) = ( $other_db =~ /(^[a-z]+_[a-z]+)_otherfeatures_(\d+)/ );
1023
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new
Ian Longden's avatar
Ian Longden committed
1024
      ( -group => "otherfeatures",
1025 1026 1027 1028 1029
	-species => $species,
	-host => $host,
	-user => $user,
	-pass => $pass,
	-port => $port,
Ian Longden's avatar
Ian Longden committed
1030
	-dbname => $other_db
1031
      );
1032 1033
      (my $sp = $species ) =~ s/_/ /g;
      $self->add_alias( $species, $sp );
1034
      print $other_db." loaded\n" if ($verbose);       
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
  }
  
  
  eval "require Bio::EnsEMBL::Variation::DBSQL::DBAdaptor";
  if($@) {
    #ignore variations as code required not there for this
    print "Bio::EnsEMBL::Variation::DBSQL::DBAdaptor module not found so variation databases will be ignored if found\n" if ($verbose);
  }
  else{
    my @variation_dbs = grep { /^[a-z]+_[a-z]+_variation_\d+_/ } @dbnames;
    
    for my $variation_db ( @variation_dbs ) {
      my ($species, $num ) = ( $variation_db =~ /(^[a-z]+_[a-z]+)_variation_(\d+)/ );
      my $dba = Bio::EnsEMBL::Variation::DBSQL::DBAdaptor->new
	( -group => "variation",
	  -species => $species,
	  -host => $host,
	  -user => $user,
	  -pass => $pass,
	  -port => $port,
	  -dbname => $variation_db
	);
      print $variation_db." loaded\n" if ($verbose);
    }
  }
Nathan Johnson's avatar
Nathan Johnson committed
1060 1061 1062 1063 1064 1065 1066

  eval "require Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor";
  if($@) {
    #ignore funcgen DBs as code required not there for this
	  print "Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor module not found so functional genomics databases will be ignored if found\n" if ($verbose);
  }
  else{
Steve Trevanion's avatar
Steve Trevanion committed
1067
    my @funcgen_dbs = grep { /^[a-z]+_[a-z]+_funcgen_\d+_/ } @dbnames;
Nathan Johnson's avatar
Nathan Johnson committed
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
    
    for my $funcgen_db ( @funcgen_dbs ) {
		my ($species, $num ) = ( $funcgen_db =~ /(^[a-z]+_[a-z]+)_funcgen_(\d+)/ );
		my $dba = Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor->new
		  ( -group => "funcgen",
			-species => $species,
			-host => $host,
			-user => $user,
			-pass => $pass,
			-port => $port,
			-dbname => $funcgen_db
		  );
		print $funcgen_db." loaded\n" if ($verbose);
    }
  }

1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
  
  #Compara
  if($compara_version){
    eval "require Bio::EnsEMBL::Compara::DBSQL::DBAdaptor";
    if($@) {
      #ignore compara as code required not there for this
      print "Bio::EnsEMBL::Compara::DBSQL::DBAdaptor not found so compara database ensembl_compara_$compara_version will be ignored\n" if ($verbose);
    }
    else{
      my $compara_db = "ensembl_compara_".$compara_version;

      my $dba = Bio::EnsEMBL::Compara::DBSQL::DBAdaptor->new
	( -group => "compara",
	  -species => "multi",
	  -host => $host,
	  -user => $user,
	  -pass => $pass,
	  -port => $port,
	  -dbname => $compara_db
	);
      print $compara_db." loaded\n" if ($verbose);       
    }
  }
  else{
    print "No Compara database found" if ($verbose);
  }


  #GO
  if($go_version){
1114
    eval "require Bio::EnsEMBL::ExternalData::GO::GOAdaptor";
1115 1116
    if($@) {
      #ignore go as code required not there for this
1117 1118
#      print $@;
      print "GO software not installed so go database ensemb_go_$go_version will be ignored\n" if ($verbose);
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
    }
    else{
      my $go_db = "ensembl_go_".$go_version;
      my $dba = Bio::EnsEMBL::ExternalData::GO::GOAdaptor->new
	( -group => "go",
	  -species => "multi",
	  -host => $host,
	  -user => $user,
	  -pass => $pass,
	  -port => $port,
	  -dbname => $go_db
	);
      print $go_db." loaded\n" if ($verbose);              
    }