Registry.pm 69.7 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);

122
my $API_VERSION = 52;
Ian Longden's avatar
Ian Longden committed
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
# This is a map from group names to Ensembl DB adaptors.
#Used by load_all and reset_DBAdaptor
my %group2adaptor = 
  (
   'blast'         => 'Bio::EnsEMBL::External::BlastAdaptor',
   'compara'       => 'Bio::EnsEMBL::Compara::DBSQL::DBAdaptor',
   'core'          => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'estgene'       => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'funcgen'       => 'Bio::EnsEMBL::Funcgen::DBSQL::DBAdaptor',
   'haplotype'     => 'Bio::EnsEMBL::ExternalData::Haplotype::DBAdaptor',
   'hive'          => 'Bio::EnsEMBL::Hive::DBSQL::DBAdaptor',
   'lite'          => 'Bio::EnsEMBL::Lite::DBAdaptor',
   'otherfeatures' => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
   'pipeline'      => 'Bio::EnsEMBL::Pipeline::DBSQL::DBAdaptor',
   'snp'           => 'Bio::EnsEMBL::ExternalData::SNPSQL::DBAdaptor',
   'variation'     => 'Bio::EnsEMBL::Variation::DBSQL::DBAdaptor',
   'vega'          => 'Bio::EnsEMBL::DBSQL::DBAdaptor',
  );



Ian Longden's avatar
Ian Longden committed
145
=head2 load_all
146

147 148 149 150 151 152 153 154
 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
155

156 157
  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
158

159 160 161 162 163 164 165 166
  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).
167 168 169 170 171 172 173
  Arg [4]:     (optional) int 1
               This option will turn off caching for slice features, so, 
               every time a set of features is retrieved, they will come from
               the database instead of the cache. This option is only recommended
               for advanced users, specially if you need to store and retrieve
               features. It might reduce performance when querying the database if 
               not used properly. If in doubt, do not use it or ask in ensembl-dev            
Ian Longden's avatar
Ian Longden committed
174 175 176
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
177
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
178 179

=cut
180

181 182
sub load_all {
    my $class = shift;
183
    my ( $config_file, $verbose, $no_clear, $no_cache ) = @_;
184 185 186 187 188 189

    $config_file ||= $ENV{ENSEMBL_REGISTRY}
      || $ENV{HOME} . "/.ensembl_init";

    $verbose  ||= 0;
    $no_clear ||= 0;
190
    $no_cache ||= 0;
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220

    if ( !defined($config_file) ) {
        if ($verbose) {
            print( STDERR
                   "No default registry configuration to load.\n" );
        }
    } elsif ( !-e $config_file ) {
        if ($verbose) {
            printf( STDERR "Configuration file '%s' does not exist. "
                      . "Registry configuration not loaded.\n",
                    $config_file );
        }
    } else {
        if ( defined( $registry_register{'seen'} ) ) {
            if ( !$no_clear ) {
                if ($verbose) {
                    print( STDERR "Clearing previously loaded "
                           . "registry configuration\n" );
                }
                $class->clear();
            }
        }
        $registry_register{'seen'} = 1;

        if ($verbose) {
            printf( STDERR
                      "Loading registry configuration from '%s'.\n",
                    $config_file );
        }

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
        my $cfg;

        eval { require Config::IniFiles };
        if ($@) {
          # The user does not have the 'Config::IniFiles' module.
          if ($verbose) {
            print( STDERR "No Config::IniFiles module found, "
                   . "assuming this is not an ini-file\n" );
          }
          # If the configuration file *is* an ini-file, we can expect a
          # load of compilation errors from the next eval...
        } else {
          # The user has the 'Config::IniFiles' module installed.  See
          # if this is an ini-file or not...
          $cfg = Config::IniFiles->new( -file => $config_file );
        }
237

238
        if ( defined $cfg ) {
239
		  my %default_adaptor_args = ();
240 241 242 243

            if ( $cfg->SectionExists('default') ) {
                # The 'default' section is special.  It contain default
                # values that should be implicit to all other section in
244 245 246 247 248 249 250 251 252 253 254 255 256
                # this configuration file.  Aliases are added if there
                # is also a 'species' setting.

                my $alias = $cfg->val( 'default', 'alias' );
                $cfg->delval( 'default', 'alias' );

                my $species = $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
257
                }
258

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
                %default_adaptor_args =
                  map { '-' . $_ => $cfg->val( 'default', $_ ) }
                  $cfg->Parameters('default');
            }

            foreach my $section ( $cfg->Sections() ) {
                if ( $section eq 'default' )
                {    # We have already done the 'default' section.
                    next;
                }

                my $group = $cfg->val( $section, 'group' )
                  || $cfg->val( 'default', 'group' );

                if ( !defined($group) ) {
                    printf( STDERR "Key 'group' is undefined "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $section );
                    next;
                }

                my $adaptor = $group2adaptor{ lc($group) };
                if ( !defined($adaptor) ) {
                    printf( STDERR "Unknown group '%s' "
                              . "for configuration section '%s', "
                              . "skipping this section.\n",
                            $group, $section );
                    next;
                }

290 291 292 293 294
                # Handle aliases.  A section must have both an 'alias'
                # setting and a 'species' setting for aliases to be
                # added.  The 'species' setting might be inherited from
                # the 'default' section.

295 296 297
                my $alias = $cfg->val( $section, 'alias' );
                $cfg->delval( $section, 'alias' );

298 299 300 301 302 303 304 305 306 307 308
                my $species = $cfg->val( $section, 'species' )
                  || $cfg->val( 'default', 'species' );

                if ( defined($alias) && defined($species) ) {
                    Bio::EnsEMBL::Utils::ConfigRegistry->add_alias(
                                     -species => $species,
                                     -alias => [ split( /\n/, $alias ) ]
                    );
                }

                # Fill in the adaptor initialization arguments.
309 310 311 312 313
                # We trust the user to provide sensible key-value pairs.
                my %adaptor_args = %default_adaptor_args;
                foreach my $parameter ( $cfg->Parameters($section) ) {
                    $adaptor_args{ '-' . $parameter } =
                      $cfg->val( $section, $parameter );
314 315 316 317
		    #when set, do not use the feature cache in the different adaptors
		    if ($no_cache){
			$adaptor_args{'-no_cache'} = 1;
		    }
318 319 320 321 322 323 324 325
                }

                if ($verbose) {
                    printf( "Configuring adaptor '%s' "
                              . "for configuration section '%s'...\n",
                            $adaptor, $section );
                }

326 327 328
                eval "require $adaptor";
                if ($@) { die($@) }

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
                $adaptor->new(%adaptor_args);

            } ## end foreach my $section ( $cfg->Sections...
        } else {
            # This is probably no ini-file but an old style piece
            # of configuration written in Perl.  We need to try to
            # require() it.

            eval { require($config_file) };
            if ($@) { die($@) }

            # To make the web code avoid doing this again:
            delete $INC{$config_file};
        }
    } ## end else [ if ( !defined($config_file...
344
} ## end sub load_all
345 346

=head2 clear
347

348 349 350 351 352
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
353
  Status     : Stable
354 355 356 357 358 359 360 361 362 363 364

=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
365
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
366 367 368
}

#
369
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
370 371 372 373
#

=head2 add_db

374
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
375 376 377 378 379
  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
380
  Status     : At Risk.
381
             : This is here for backwards compatibility only and may be removed 
382 383 384
             : 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
385 386 387 388 389 390
=cut

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


391 392
  if(lc($db->species()) ne lc($adap->species)){
    $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = $adap;
393
  }
Ian Longden's avatar
Ian Longden committed
394 395 396 397
}

=head2 remove_db

398
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
399 400 401 402
  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
403
  Status     : At Risk.
404
             : This is here for backwards compatibility only and may be removed 
405 406
             : 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
407 408 409 410 411 412

=cut

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

413 414
  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
415 416 417 418 419 420

  return $ret;
}

=head2 get_db

421
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
422 423 424 425
  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
426
  Status     : At Risk.
427
             : This is here for backwards compatibility only and may be removed 
428 429
             : 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
430 431 432 433 434 435

=cut

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

436
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor(lc($db->species),lc($name));
437 438 439 440

  if(defined($ret)){
    return $ret;
  }
441
  return $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
Ian Longden's avatar
Ian Longden committed
442 443 444 445
}

=head2 get_all_db_adaptors

446
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
447 448 449
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
450
  Status     : At Risk.
451
             : This is here for backwards compatibility only and may be removed 
452 453 454
             : 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
455 456 457

=cut

458 459 460
sub get_all_db_adaptors {
  my ( $class, $db ) = @_;
  my %ret = ();
Ian Longden's avatar
Ian Longden committed
461

462 463
  # 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.
Ian Longden's avatar
Ian Longden committed
464

465 466 467 468
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    if ( lc( $dba->species() ) eq lc( $db->species() ) ) {
      $ret{ $dba->group() } = $dba;
    }
Ian Longden's avatar
Ian Longden committed
469 470
  }

471 472 473 474 475 476 477 478 479
  foreach my $key (
             keys %{
               $registry_register{ $class->get_alias( $db->species() ) }
                 { lc( $db->group() ) }{'_special'} } )
  {
    $ret{$key} =
      $registry_register{ $class->get_alias( $db->species() ) }
      { lc( $db->group() ) }{'_special'}{$key};
  }
Ian Longden's avatar
Ian Longden committed
480 481

  return \%ret;
482
} ## end sub get_all_db_adaptors
Ian Longden's avatar
Ian Longden committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496


#
# 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
497 498
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
499 500 501 502 503 504

=cut

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

505 506 507 508 509
  if(!($class->alias_exists($species))){
    $class->add_alias($species,$species);
  }
  

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

512
  $registry_register{$species}{lc($group)}{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

  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
534
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
535 536 537 538 539 540 541 542

=cut

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

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

543 544
  return  $registry_register{$species}{lc($group)}{'_DB'};

Ian Longden's avatar
Ian Longden committed
545 546 547 548
}

=head2 get_all_DBAdaptors

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

=cut

561 562 563
sub get_all_DBAdaptors {
  my ( $class, @args ) = @_;

564
  my @ret;
565
  my ( $species, $group ) = rearrange( [qw(SPECIES GROUP)], @args );
Ian Longden's avatar
Ian Longden committed
566

567
  if ( defined($species) ) {
568 569
    $species = $class->get_alias($species);
  }
570 571 572 573 574

  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    if ( !defined($species) || lc($species) eq lc( $dba->species ) ) {
      if ( !defined($group) || lc($group) eq lc( $dba->group ) ) {
        push( @ret, $dba );
575 576 577 578 579
      }
    }
  }

  return \@ret;
Ian Longden's avatar
Ian Longden committed
580 581
}

582 583
=head2 get_all_DBAdaptors_by_connection

584
  Arg [1]    : DBConnection used to find DBAdaptors
585
  Returntype : reference to list of DBAdaptors
586 587 588
  Exceptions : none
  Example    : @dba = @{ Bio::EnsEMBL::Registry
                  ->get_all_DBAdaptors_by_connection($dbc) };
589
  Status     : Stable
590 591 592

=cut

593 594 595
sub get_all_DBAdaptors_by_connection {
  my ( $self, $dbc_orig ) = @_;

596 597
  my @return;

598 599 600 601 602 603 604 605 606 607 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
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    my $dbc = $dba->dbc();

    if (    defined($dbc)
         && $dbc->can('equals')
         && $dbc->equals($dbc_orig) )
    {
      push( @return, $dba );
    }
  }

  return \@return;
}

=head2 get_all_DBAdaptors_by_dbname

  Arg [1]    : string, name of database
  Returntype : reference to list of DBAdaptors
  Exceptions : none
  Example    : @dba = @{ Bio::EnsEMBL::Registry
                  ->get_all_DBAdaptors_by_dbname($dbname) };
  Status     : Stable

=cut

sub get_all_DBAdaptors_by_dbname {
  my ( $self, $dbname ) = @_;

  my @return;

  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
    my $dbc = $dba->dbc();

    if ( defined($dbc) && $dbc->dbname() eq $dbname ) {
      push( @return, $dba );
633 634
    }
  }
635

636 637 638
  return \@return;
}

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
=head2 remove_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->remove_DBAdaptor("Human", "core");
  Returntype : none
  Exceptions : none
  Status     : At risk

=cut

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

  $species = $class->get_alias($species);
Nathan Johnson's avatar
Nathan Johnson committed
654 655
  
 
656
  delete $registry_register{$species}{$group};
657
  # This will remove the DBAdaptor and all the other adaptors
658

659
  # Now remove if from the _DBA array
660 661
  my $index;

Nathan Johnson's avatar
Nathan Johnson committed
662

663 664
  foreach my $i(0..$#{$registry_register{'_DBA'}}){
    my $dba = $registry_register{'_DBA'}->[$i];
Nathan Johnson's avatar
Nathan Johnson committed
665

666 667 668
    if(($dba->species eq $species) &&
       $dba->group eq $group){
      $index = $i;
Nathan Johnson's avatar
Nathan Johnson committed
669

670 671 672 673
      last;
    }
  }
  
674
  
675
  # Now remove from _DBA cache
676
  splice(@{$registry_register{'_DBA'}}, $index, 1) if defined $index;
Nathan Johnson's avatar
Nathan Johnson committed
677

678 679 680
  return;
}

681

Nathan Johnson's avatar
Nathan Johnson committed
682 683 684 685 686 687 688

=head2 reset_DBAdaptor

  Arg [1]:     string - species e.g. homo_sapiens
  Arg [2]:     string - DB group e.g. core
  Arg [3]:     string - new dbname
  Args [4-7]:  string - optional DB parameters, defaults to current db params if omitted
689
  Arg [8]:     hashref - Hash ref of additional parameters e.g. eFG dnadb params for auto selecting dnadb
Nathan Johnson's avatar
Nathan Johnson committed
690 691 692 693 694 695 696 697 698 699
  Usage :      $reg->reset_registry_db('homo_sapiens', 'core', 'homo_sapiens_core_37_35j');
  Description: Resets a DB within the registry.
  Exceptions:  Throws if mandatory params not supplied
               Throws if species name is not already seen by the registry
               Throws if no current DB for species/group available
  Status :     At risk

=cut

sub reset_DBAdaptor{
700
  my ($self, $species, $group, $dbname, $host, $port, $user, $pass, $params) = @_;
Nathan Johnson's avatar
Nathan Johnson committed
701

702
  # Check mandatory params
Nathan Johnson's avatar
Nathan Johnson committed
703 704 705 706
  if(! (defined $species && defined $group && defined $dbname)){
	throw('Must provide at least a species, group and dbname parmeter to redefine a DB in the registry');
  }
  
707
  # Validate species here
Nathan Johnson's avatar
Nathan Johnson committed
708 709 710
  my $alias = $self->get_alias($species);
  throw("Could not find registry alias for species:\t$species") if(! defined $alias);
 
711
  # Get all current defaults if not defined
Nathan Johnson's avatar
Nathan Johnson committed
712

713 714
  my $db = $self->get_DBAdaptor($alias, $group);
  my $class;
Nathan Johnson's avatar
Nathan Johnson committed
715

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
  if($db){
	$class = ref($db);
	$host ||= $db->dbc->host;
	$port ||= $db->dbc->port;
	$user ||= $db->dbc->username;
	$pass ||= $db->dbc->password;
  }
  else{
	#Now we need to test mandatory params
	$class =  $group2adaptor{ lc($group) };

	if(! ($host && $user)){
	  throw("No comparable $alias $group DB present in Registry. You must pass at least a dbhost and dbuser");
	}
  }
Nathan Johnson's avatar
Nathan Johnson committed
731

732
 
Nathan Johnson's avatar
Nathan Johnson committed
733
  $self->remove_DBAdaptor($alias, $group);
Nathan Johnson's avatar
Nathan Johnson committed
734

735 736 737 738 739 740
   
  
  #my @adaptors = @{$self->get_all_adaptors};
  #This is causing a loop as it was constantly trying to reset the db
  #and never getting there.
  #I think this was left over from testing
Nathan Johnson's avatar
Nathan Johnson committed
741

742
  	
743
  # ConfigRegistry should automatically add this to the Registry
744 745 746 747 748 749 750 751 752 753 754 755 756


  $db = $class->new(
					-user => $user,
					-host => $host,
					-port => $port,
					-pass => $pass,
					-dbname => $dbname,
					-species => $alias,
					-group    => $group,
					%{$params}
				   );

Nathan Johnson's avatar
Nathan Johnson committed
757 758 759 760 761

  return $db;
}


Ian Longden's avatar
Ian Longden committed
762 763 764 765 766 767 768 769
#
# 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.
770 771 772
  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
773 774
  Returntype : none
  Exceptions : none
775
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
776 777 778 779

=cut

sub add_DNAAdaptor{
Ian Longden's avatar
Ian Longden committed
780
  my ($class, $species, $group, $dnadb_species, $dnadb_group) = @_;
Ian Longden's avatar
Ian Longden committed
781 782

  $species = $class->get_alias($species);
783
  $dnadb_species = $class->get_alias($dnadb_species);
784
  if($dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor')){
Ian Longden's avatar
Ian Longden committed
785
    deprecated("");
786 787
  }
  else{
788 789
    $registry_register{$species}{lc($group)}{'_DNA'} = $dnadb_group;
    $registry_register{$species}{lc($group)}{'_DNA2'} = $dnadb_species;
790
  }
Ian Longden's avatar
Ian Longden committed
791 792 793 794 795 796 797 798 799
}

=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
800
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
801 802 803 804 805 806 807

=cut

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

  $species = $class->get_alias($species);
808 809
  my $new_group = $registry_register{$species}{lc($group)}{'_DNA'};
  my $new_species = $registry_register{$species}{lc($group)}{'_DNA2'};
810
  if( defined $new_group ) {
Ian Longden's avatar
Ian Longden committed
811
    return  $class->get_DBAdaptor($new_species,$new_group);
812 813 814
  } else {
    return undef;
  }
Ian Longden's avatar
Ian Longden committed
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
}

#
# 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
831 832
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
833 834 835 836


=cut

837 838
sub add_adaptor {
  my ( $class, $species, $group, $type, $adap, $reset ) = @_;
Ian Longden's avatar
Ian Longden committed
839 840 841

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

842 843 844 845 846
  # Since the adaptors are not stored initially, only their 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
Ian Longden's avatar
Ian Longden committed
847

848 849 850
  if ( defined($reset) )
  {    # JUST REST THE HASH VALUE NO MORE PROCESSING NEEDED
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
851 852
    return;
  }
853 854 855 856 857 858 859
  if (
    defined( $registry_register{$species}{ lc($group) }{ lc($type) } ) )
  {
  # print STDERR (
  #      "Overwriting Adaptor in Registry for $species $group $type\n");
    $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
    return;
Ian Longden's avatar
Ian Longden committed
860
  }
861
  $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
862

863 864 865 866
  if ( !defined( $registry_register{$species}{'list'} ) ) {
    $registry_register{$species}{'list'} = [$type];
  } else {
    push( @{ $registry_register{$species}{'list'} }, $type );
Ian Longden's avatar
Ian Longden committed
867 868
  }

869 870 871 872
  if ( !defined( $registry_register{ lc($type) }{$species} ) ) {
    $registry_register{ lc($type) }{$species} = [$type];
  } else {
    push( @{ $registry_register{ lc($type) }{$species} }, $adap );
Ian Longden's avatar
Ian Longden committed
873 874
  }

875
} ## end sub add_adaptor
Ian Longden's avatar
Ian Longden committed
876 877 878 879 880 881 882 883 884 885


=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
886
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
887 888 889 890 891

=cut

sub get_adaptor{
  my ($class,$species,$group,$type)= @_;
Glenn Proctor's avatar
Typos.  
Glenn Proctor committed
892

893
  $species = $class->get_alias($species);
Glenn Proctor's avatar
Typos.  
Glenn Proctor committed
894

895
  my %dnadb_adaptors = qw(sequence  1 assemblymapper 1  karyotypeband 1 repeatfeature 1 coordsystem 1  assemblyexceptionfeature 1 );
896

897 898 899 900 901 902

 
  #warn "$species, $group, $type";

  $type = lc($type);

903
  my $dnadb_group =  $registry_register{$species}{lc($group)}{_DNA};
904

905 906
  if( defined($dnadb_group) && defined($dnadb_adaptors{lc($type)}) ) {
      $species = $registry_register{$species}{lc($group)}{'_DNA2'};
907
      $group = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
908 909
  }

910 911 912
  my $ret = $registry_register{$species}{ lc($group) }{ lc($type) };
  if ( !defined($ret) ) { return undef; }

Ian Longden's avatar
Ian Longden committed
913
  if(!ref($ret)){ # not instantiated yet
914
    my $dba = $registry_register{$species}{lc($group)}{'_DB'};
Ian Longden's avatar
Ian Longden committed
915 916 917 918 919 920 921
    my $module = $ret;
    eval "require $module";

    if($@) {
      warning("$module cannot be found.\nException $@\n");
      return undef;
    }
922 923 924 925
    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
926 927 928 929 930 931 932 933 934 935
    my $adap = "$module"->new($dba);
    Bio::EnsEMBL::Registry->add_adaptor($species, $group, $type, $adap, "reset");
    $ret = $adap;
  }

  return $ret;
}

=head2 get_all_adaptors

936 937 938 939 940 941
  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
942
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
943
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
944
  Exceptions : none
945
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
946 947 948 949

=cut

sub get_all_adaptors{
950 951 952 953
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
954

955

956
  if(@args == 1){ # Old species only one parameter
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
    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'}}){ 
988
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
	  $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
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
}


=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
1017
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
1018 1019 1020 1021 1022 1023

=cut

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

1024
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
1025 1026 1027 1028 1029 1030 1031 1032
}

=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
1033
  Exceptions : none
1034
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
1035 1036 1037 1038

=cut

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

1041
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
1042
    return $key;
Ian Longden's avatar
Ian Longden committed
1043
  }
1044
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
1045
}
1046 1047 1048 1049

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
Ian Longden's avatar
Ian Longden committed
1050
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
1051 1052 1053
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
1054
  Status     : Stable
1055 1056 1057 1058 1059 1060

=cut

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

1061
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
1062 1063 1064 1065
    return 1;
  }
  return 0;
}
1066

1067 1068 1069 1070 1071 1072 1073
=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
1074
  Status     : Stable
1075 1076 1077

=cut

1078
sub set_disconnect_when_inactive{
1079
  foreach my $dba ( @{get_all_DBAdaptors()}){
1080
    my $dbc = $dba->dbc;
1081
    # Disconnect if connected
1082
    $dbc->disconnect_if_idle() if $dbc->connected();
1083 1084 1085
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
1086

1087 1088 1089 1090 1091 1092 1093

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
1094
  Status     : Stable
1095 1096 1097

=cut

1098
sub disconnect_all {
Web Admin's avatar
fixed  
Web Admin committed
1099
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
1100
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
1101
    next unless $dbc;
1102
    # Disconnect if connected
1103 1104 1105
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
1106

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
=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
1125
  Status     : Stable