Registry.pm 28.5 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 18
Bio::EnsEMBL::Registry->load_all("configuration_file");

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


=head1 DESCRIPTION

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 29 30 31 32
The registry can be loaded from a configuration file using the method load_all.
If a file is passed to load_all then this is used.
Else if the enviroment variable ENSEMBL_REGISTRY is set then this is used
Else if the file .ensembl_init in your home directory exist it is used.

For the Web server ENSEMBL_REGISTRY should be set in SiteDefs.pm, which will
pass this on to load_all.
Ian Longden's avatar
Ian Longden committed
33

34 35 36 37

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

Ian Longden's avatar
Ian Longden committed
38 39 40 41 42 43
The four types of registrys are for db adaptors, dba adaptors, dna adaptors
and the standard type.

=head2 db

These are registrys for backwards compatibillity and enable the subroutines
44
to add other adaptors to connections. 
Ian Longden's avatar
Ian Longden committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

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
   my $sfa = $self->adaptor()->db()->get_db_adaptor('blast');

We now want to change this to
   my $sfa = Bio::EnsEMBL::Registry->get_adaptor("Human","core","blast");


=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

my $db = Bio::EnsEMBL::DBSQL::DBAdaptor->new(....)
my $exon_adaptor = $db->get_ExonAdaptor;

we should now have just

my  $exon_adaptor = Bio::EnsEMBL::Registry->get_adaptor("Human","core","Exon");


=head2 DNA

This is an internal Registry and allows the configuration of a dnadb. 
Steve Trevanion's avatar
Steve Trevanion committed
74
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
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

## set the est db to use the core for getting dna data.
#Bio::EnsEMBL::Utils::ConfigRegistry->
#                         dnadb_add("Homo Sapiens","core","Homo Sapiens","est");


=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.

my  $exon_adaptor = Bio::EnsEMBL::Registry->get_adaptor("Human","core","Exon");

=head1 CONTACT

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


=head1 METHODS

=cut


package Bio::EnsEMBL::Registry;

use strict;

104
use Bio::EnsEMBL::DBSQL::DBAdaptor;
Ian Longden's avatar
Ian Longden committed
105 106
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
107
use DBI;
Ian Longden's avatar
Ian Longden committed
108 109 110 111 112

use vars qw(%registry_register);


=head2 load_all
113

Ian Longden's avatar
Ian Longden committed
114 115 116 117 118 119 120 121
 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 conf file.
  2) If the enviroment variable ENSEMBL_REGISTRY is set this is used.
  3) If the file .ensembl_init exist in the home directory it is used

  Arg [1]    : (optional) string $arg file to load the registry from
122
  Arg [2]    : (optional) string if set prints out messages about conf file used.
Ian Longden's avatar
Ian Longden committed
123 124 125
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
126
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
127 128 129 130

=cut
 
sub load_all{
131
  my $class = shift;
132
  my $conf_file = shift;
133
  my $verbose = shift;
134 135
  
  if(defined($registry_register{'seen'})){
136
    print STDERR "Clearing previuosly loaded configuration from Registry\n" if ($verbose);
137 138 139
    $class->clear();
  }
  $registry_register{'seen'}=1;
140
  if(defined($conf_file)){
141 142
    print STDERR  "Loading conf from site defs file ".$conf_file."\n" if ($verbose);
;
143
    if(-e $conf_file){
144 145
      eval{ require($conf_file) }; $@ && die($@);
      
146
      # other wise it gets done again by the web initialisation stuff
147
      delete $INC{$conf_file}; 
148
    }
149 150 151
  }
  elsif(defined($ENV{ENSEMBL_REGISTRY}) and -e $ENV{ENSEMBL_REGISTRY}){
    my $file = $ENV{ENSEMBL_REGISTRY};
152 153 154
    print STDERR  "Loading conf from ".$file."\n"  if ($verbose);
;
    eval{ require($file) }; $@ && die($@);
155 156 157 158
  }
  elsif(-e $ENV{HOME}."/.ensembl_init") {
    my $file = $ENV{HOME}."/.ensembl_init";
    
159
    eval{ require($file) }; $@ && die($@)
160 161
  }
  else{
162
    print STDERR "NO default configuration to load\n" if ($verbose);
163 164 165 166 167
  }
}


=head2 clear
168

169 170 171 172 173
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
174
  Status     : Stable
175 176 177 178 179 180 181 182 183 184 185 186

=cut

sub clear{
  my ($self);
  
  foreach my $dba (@{$registry_register{'_DBA'}}){
    if($dba->dbc->connected){
      $dba->dbc->db_handle->disconnect();
    }
  }
  %registry_register = undef;
Ian Longden's avatar
Ian Longden committed
187 188 189
}

#
190
# db adaptors. (for backwards compatibillity)
Ian Longden's avatar
Ian Longden committed
191 192 193 194
#

=head2 add_db

195
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
196 197 198 199 200
  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
201 202 203 204 205
  Status     : At Risk.
             : This is here for backwards compatibillity only and may be removed 
             : 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
206 207 208 209 210 211
=cut

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


212 213
  if(lc($db->species()) ne lc($adap->species)){
    $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = $adap;
214
  }
Ian Longden's avatar
Ian Longden committed
215 216 217 218
}

=head2 remove_db

219
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
220 221 222 223
  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
224 225 226 227
  Status     : At Risk.
             : This is here for backwards compatibillity only and may be removed 
             : 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
228 229 230 231 232 233

=cut

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

234 235
  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
236 237 238 239 240 241

  return $ret;
}

=head2 get_db

242
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
243 244 245 246
  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
247 248 249 250
  Status     : At Risk.
             : This is here for backwards compatibillity only and may be removed 
             : 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
251 252 253 254 255 256

=cut

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

257
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor(lc($db->species),lc($name));
258 259 260 261

  if(defined($ret)){
    return $ret;
  }
262
  return $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
Ian Longden's avatar
Ian Longden committed
263 264 265 266
}

=head2 get_all_db_adaptors

267
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
268 269 270
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
271 272 273 274 275
  Status     : At Risk.
             : This is here for backwards compatibillity only and may be removed 
             : 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
276 277 278 279 280 281 282

=cut

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

Ian Longden's avatar
Ian Longden committed
283 284 285 286
# 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'}}){
287
    if(lc($dba->species()) eq lc($db->species())){
Ian Longden's avatar
Ian Longden committed
288 289 290 291
      $ret{$dba->group()} = $dba;
    } 
  }

292
 foreach my $key (keys %{$registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}}){
293
   $ret{$key} = $registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}{$key};
Ian Longden's avatar
Ian Longden committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
 }

  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
312 313
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
314 315 316 317 318 319

=cut

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

320 321 322 323 324
  if(!($class->alias_exists($species))){
    $class->add_alias($species,$species);
  }
  

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

327
  $registry_register{$species}{lc($group)}{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348

  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
349
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
350 351 352 353 354 355 356 357

=cut

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

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

358 359
  return  $registry_register{$species}{lc($group)}{'_DB'};

Ian Longden's avatar
Ian Longden committed
360 361 362 363
}

=head2 get_all_DBAdaptors

364 365 366 367 368 369 370 371
  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
372
  Status       : Stable
Ian Longden's avatar
Ian Longden committed
373 374 375 376

=cut

sub get_all_DBAdaptors{
377 378
  my ($class,@args)=@_;
  my @ret;
Ian Longden's avatar
Ian Longden committed
379

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
  my ($species, $group) = 
    rearrange([qw(SPECIES GROUP)], @args);
  if(defined($species)){
    $species = $class->get_alias($species);
  }
  foreach my $dba (@{$registry_register{'_DBA'}}){
    if(!defined($species) || $species eq $dba->species){
      if(!defined($group) || lc($group) eq lc($dba->group)){
	push @ret, $dba;
      }
    }
  }


  return \@ret;
Ian Longden's avatar
Ian Longden committed
395 396
}

397 398 399 400 401 402
=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);
403
  Status     : Stable
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

=cut

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

  foreach my $dba ( @{$registry_register{'_DBA'}}){
    my $dbc = $dba->dbc;
    if($dbc->equals($dbc_orig)){
      push @return, $dba;
    }
  }
  return \@return;
}


Ian Longden's avatar
Ian Longden committed
421 422 423 424 425 426 427 428 429 430 431 432
#
# 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.
  Arg [3]    : The adaptor to be added to the registry as a DNA adaptor.
  Example    : Bio::EnsEMBL::Registry->add_DNAAdaptor("Human", "core", $dnaAdap);
  Returntype : none
  Exceptions : none
433
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
434 435 436 437

=cut

sub add_DNAAdaptor{
Ian Longden's avatar
Ian Longden committed
438
  my ($class, $species, $group, $dnadb_species, $dnadb_group) = @_;
Ian Longden's avatar
Ian Longden committed
439 440

  $species = $class->get_alias($species);
441
  $dnadb_species = $class->get_alias($dnadb_species);
442
  if($dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor')){
Ian Longden's avatar
Ian Longden committed
443
    deprecated("");
444 445
  }
  else{
446 447
    $registry_register{$species}{lc($group)}{'_DNA'} = $dnadb_group;
    $registry_register{$species}{lc($group)}{'_DNA2'} = $dnadb_species;
448
  }
Ian Longden's avatar
Ian Longden committed
449 450 451 452 453 454 455 456 457
}

=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
458
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
459 460 461 462 463 464 465

=cut

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

  $species = $class->get_alias($species);
466 467
  my $new_group = $registry_register{$species}{lc($group)}{'_DNA'};
  my $new_species = $registry_register{$species}{lc($group)}{'_DNA2'};
468
  if( defined $new_group ) {
Ian Longden's avatar
Ian Longden committed
469
    return  $class->get_DBAdaptor($new_species,$new_group);
470 471 472
  } else {
    return undef;
  }
Ian Longden's avatar
Ian Longden committed
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
}

#
# 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
489 490
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508


=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
#

  if(defined($reset)){ # JUST REST THE HASH VLAUE NO MORE PROCESSING NEEDED
509
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
510 511
    return;
  }
512
  if(defined($registry_register{$species}{lc($group)}{lc($type)})){ 
Ian Longden's avatar
Ian Longden committed
513
    print STDERR ("Overwriting Adaptor in Registry for $species $group $type\n");
514
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
515 516
   return;
  }
517
  $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
518 519 520

  if(!defined ($registry_register{$species}{'list'})){
    my @list =();
521
    push(@list,$type);
Ian Longden's avatar
Ian Longden committed
522 523 524
    $registry_register{$species}{'list'}= \@list;
  }
  else{
525
    push(@{$registry_register{$species}{'list'}},$type);
Ian Longden's avatar
Ian Longden committed
526 527
  }

528

Ian Longden's avatar
Ian Longden committed
529

530
  if(!defined ($registry_register{lc($type)}{$species})){
Ian Longden's avatar
Ian Longden committed
531 532
    my @list =();
    push(@list,$adap);
533
    $registry_register{lc($type)}{$species}= \@list;
Ian Longden's avatar
Ian Longden committed
534 535
  }
  else{
536
    push(@{$registry_register{lc($type)}{$species}},$adap);
Ian Longden's avatar
Ian Longden committed
537 538 539 540 541 542 543 544 545 546 547 548 549
  }

}


=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
550
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
551 552 553 554 555 556

=cut

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

560
  my $dnadb_group =  $registry_register{$species}{lc($group)}{_DNA};
561

562 563
  if( defined($dnadb_group) && defined($dnadb_adaptors{lc($type)}) ) {
      $species = $registry_register{$species}{lc($group)}{'_DNA2'};
564
      $group = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
565 566
  }

567
  my $ret = $registry_register{$species}{lc($group)}{lc($type)};
Ian Longden's avatar
Ian Longden committed
568
  if(!defined($ret)){
569
    return undef;
Ian Longden's avatar
Ian Longden committed
570 571
  }
  if(!ref($ret)){ # not instantiated yet
572
    my $dba = $registry_register{$species}{lc($group)}{'_DB'};
Ian Longden's avatar
Ian Longden committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    my $module = $ret;
    eval "require $module";

    if($@) {
      warning("$module cannot be found.\nException $@\n");
      return undef;
    }
    my $adap = "$module"->new($dba);
    Bio::EnsEMBL::Registry->add_adaptor($species, $group, $type, $adap, "reset");
    $ret = $adap;
  }

  return $ret;
}

=head2 get_all_adaptors

590 591 592 593 594 595
  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
596
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
597
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
598
  Exceptions : none
599
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
600 601 602 603

=cut

sub get_all_adaptors{
604 605 606 607
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
608

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641

  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'}}){ 
642
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
	  $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
660 661 662 663 664 665 666 667 668 669 670
}


=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
671
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
672 673 674 675 676 677

=cut

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

678
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
679 680 681 682 683 684 685 686
}

=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
687
  Exceptions : none
688
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
689 690 691 692

=cut

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

695
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
696
    return $key;
Ian Longden's avatar
Ian Longden committed
697
  }
698
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
699
}
700 701 702 703 704

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
  Arg [2]    : if set will not throw if not found.
Ian Longden's avatar
Ian Longden committed
705
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
706 707 708
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
709
  Status     : Stable
710 711 712 713 714 715

=cut

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

716
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
717 718 719 720
    return 1;
  }
  return 0;
}
721

722 723 724 725 726 727 728
=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
729
  Status     : Stable
730 731 732

=cut

733
sub set_disconnect_when_inactive{
734
  foreach my $dba ( @{get_all_DBAdaptors()}){
735 736
    my $dbc = $dba->dbc;
    #disconnect if connected
737
    $dbc->disconnect_if_idle() if $dbc->connected();
738 739 740
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
741

742 743 744 745 746 747 748

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
749
  Status     : Stable
750 751 752

=cut

753
sub disconnect_all {
Web Admin's avatar
fixed  
Web Admin committed
754
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
755
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
756
    next unless $dbc;
757 758 759 760
    #disconnect if connected
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
761

762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
=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
780
  Status     : Stable
781 782 783 784

=cut

sub change_access{
Steve Trevanion's avatar
Steve Trevanion committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800
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);
	}
801 802 803
    }
}

804 805


806
=head2 load_registry_from_db
807

808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
  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 

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

  Description: Will load the latest versions of the ensembl databases it
               can find on a database instance into the registry.

  Exceptions : None.
826
  Status     : Stable
827 828
 
=cut
829

830 831 832 833 834 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 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 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 980 981 982 983 984 985 986 987 988
sub load_registry_from_db{
  my($self, @args) = @_;
  my ($host, $port, $user, $pass, $verbose) =
    rearrange([qw(HOST PORT USER PASS VERBOSE)], @args);



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

  $user ||= "ensro";
  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;
  for my $db (@dbnames){
    if($db =~ /^([a-z]+_[a-z]+_[a-z]+)_(\d+)_(\d+[a-z]*)/){
      if(defined($temp{$1})){
	my ($r1,$r2) = split($temp{$1},"_");
	if($r1 < $2){
	  $temp{$1} = $2."_".$3;
	}
      }
      else{
	$temp{$1} = $2."_".$3;
      }
    }
    elsif($db =~ /^ensembl_compara_(\d+)/){
      if($compara_version < $1){
	$compara_version = $1;
      }
    }
    elsif($db =~ /^ensembl_go_(\d+)/){
      if($go_version < $1){
	$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);
  }
  
  my @estgene_dbs = grep { /^[a-z]+_[a-z]+_estgene_\d+_/ } @dbnames;
  
  for my $estgene_db ( @estgene_dbs ) {
    my ($species, $num) = ( $estgene_db =~ /(^[a-z]+_[a-z]+)_estgene_(\d+)/ );
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new
      ( -group => "estgene",
	-species => $species,
	-host => $host,
	-user => $user,
	-pass => $pass,
	-port => $port,
	-dbname => $estgene_db
      );
    print $estgene_db." loaded\n" if ($verbose);
  }
  
  
  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);
    }
  }
  
  #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){
    eval "use Bio::EnsEMBL::ExternalData::GO::GOAdaptor";
    if($@) {
      #ignore go as code required not there for this
      print "Bio::EnsEMBL::ExternalData::GO::GOAdaptor::DBAdaptor not found so go database ensemb_go_$go_version will be ignored\n" if ($verbose);
    }
    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);              
    }
  }
  else{
    print "No go database found" if ($verbose);
  }
  
}
989 990


Ian Longden's avatar
Ian Longden committed
991 992 993 994 995
#
# Web specific routines
#


996

997
=head2 DEPRECATED load_registry_with_web_adaptors
Ian Longden's avatar
Ian Longden committed
998

999
  DEPRECATED: Use load_registry_from_db instead.
Ian Longden's avatar
Ian Longden committed
1000 1001 1002

=cut

1003
sub load_registry_with_web_adaptors{
Ian Longden's avatar
Ian Longden committed
1004 1005
  my $class = shift;

1006
  deprecate('Use the load_registry_from_db instead'); 
Ian Longden's avatar
Ian Longden committed
1007 1008 1009 1010 1011 1012 1013
  eval{ require SiteDefs };
  if ($@){ die "Can't use SiteDefs.pm - $@\n"; }
    SiteDefs->import(qw(:ALL));

  eval{ require SpeciesDefs };
  if ($@){ die "Can't use SpeciesDefs.pm - $@\n"; }
  my $conf = new SpeciesDefs();
1014 1015 1016 1017 1018 1019
  
  my %species_alias = %{$SiteDefs::ENSEMBL_SPECIES_ALIASES};

  foreach my $spec (keys %species_alias){
    Bio::EnsEMBL::Registry->add_alias($species_alias{$spec},$spec);
  }
Ian Longden's avatar
Ian Longden committed
1020 1021 1022 1023

}

=head2 set_default_track
1024

Ian Longden's avatar
Ian Longden committed
1025 1026 1027 1028 1029 1030 1031 1032
  Sets a flag to say that that this species/group are a default track and do not
  need to be added as another web track.

  Arg [1]    : name of the species to get the adaptors for in the registry.
  Arg [2]    : name of the type to get the adaptors for in the registry.
  Example    : $merged = Bio::EnsEMBL::Registry->set_default_track("Human","core");
  Returntype : none
  Exceptions : none
1033
  Status     : At Risk.
Ian Longden's avatar
Ian Longden committed
1034 1035 1036 1037 1038 1039

=cut

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

1040 1041
  $species = get_alias($species);
  $registry_register{'def_track'}{$species}{lc($group)} = 1;
Ian Longden's avatar
Ian Longden committed
1042 1043 1044
}

=head2 default_track
1045

Ian Longden's avatar
Ian Longden committed
1046 1047 1048 1049 1050 1051 1052
  Check flag to see if this is a default track

  Arg [1]    : name of the species to get the adaptors for in the registry.
  Arg [2]    : name of the type to get the adaptors for in the registry.
  Example    : $merged = Bio::EnsEMBL::Registry->set_default_track("Human","core");
  Returntype : int 
  Exceptions : none
1053
  Status     : At Risk.
Ian Longden's avatar
Ian Longden committed
1054 1055 1056 1057 1058 1059

=cut

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

1060 1061
  $species = get_alias($species);
  if(defined($registry_register{'def_track'}{$species}{lc($group)})){
Ian Longden's avatar
Ian Longden committed
1062 1063 1064 1065 1066 1067 1068 1069
    return 1;
  }
  
  return 0;
}


=head2 add_new_tracks
1070

Ian Longden's avatar
Ian Longden committed
1071 1072 1073 1074 1075 1076 1077
  Will add new gene tracks to the configuration of the WEB server if they are
  not of the type default and the configuration already has genes in the display.

  Arg [1]    : hash of the default configuration of the web page
  Returntype : none
  Exceptions : none
  Called by  : UserConfig.pm
1078
  Status     : At Risk.
Ian Longden's avatar
Ian Longden committed
1079 1080 1081 1082
  
=cut

sub add_new_tracks{
Ian Longden's avatar
Ian Longden committed
1083
  my($class, $conf, $pos) = @_;
Ian Longden's avatar
Ian Longden committed
1084 1085 1086 1087

  my $start = 0;
  my $reg = $class;
  my $species_reg = $reg->get_alias($conf->{'species'},"nothrow");
Ian Longden's avatar
Ian Longden committed
1088
  my %pars;
Ian Longden's avatar
Ian Longden committed
1089
#  print STDERR "Species $species_reg check for default tracks\n";
Ian Longden's avatar
Ian Longden committed
1090
  if(defined($species_reg)){
1091
    foreach my $dba (@{$reg->get_all_DBAdaptors()}){
Ian Longden's avatar
Ian Longden committed
1092
      if(!$reg->default_track($dba->species,$dba->group)){
Ian Longden's avatar
Ian Longden committed
1093 1094 1095
	$pars{'available'} = "species ".$reg->get_alias($dba->species());
	$pars{'db_alias'} = $dba->group();
#	print STDERR "Adding new track for ".$dba->species."\t".$dba->group."\n";
Ian Longden's avatar
Ian Longden committed
1096
	$conf->add_new_track_generictranscript('',$dba->group(), "black",$pos,%pars);
Ian Longden's avatar
Ian Longden committed
1097
	$pos++;
Ian Longden's avatar
Ian Longden committed
1098 1099 1100
      }
    }
  }
Ian Longden's avatar
Ian Longden committed
1101 1102
  return $pos;

Ian Longden's avatar
Ian Longden committed
1103 1104 1105 1106
}


1;