Registry.pm 53 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 = 48;
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

=cut
153

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
sub load_all {
    my $class = shift;
    my ( $config_file, $verbose, $no_clear ) = @_;

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

    $verbose  ||= 0;
    $no_clear ||= 0;

    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 );
        }

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
        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 );
        }
209

210
        if ( defined $cfg ) {
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
            # This is a map from group names to Ensembl DB adaptors.
            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' );

            my %default_adaptor_args = ();

            if ( $cfg->SectionExists('default') ) {
                # The 'default' section is special.  It contain default
                # values that should be implicit to all other section in
236 237 238 239 240 241 242 243 244 245 246 247 248
                # 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 ) ]
                    );
249
                }
250

251 252 253 254 255 256 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
                %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;
                }

282 283 284 285 286
                # 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.

287 288 289
                my $alias = $cfg->val( $section, 'alias' );
                $cfg->delval( $section, 'alias' );

290 291 292 293 294 295 296 297 298 299 300
                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.
301 302 303 304 305 306 307 308 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 );
                }

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

314 315 316
                eval "require $adaptor";
                if ($@) { die($@) }

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
                $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...
332
} ## end sub load_all
333 334

=head2 clear
335

336 337 338 339 340
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
341
  Status     : Stable
342 343 344 345 346 347 348 349 350 351 352

=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
353
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
354 355 356
}

#
357
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
358 359 360 361
#

=head2 add_db

362
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
363 364 365 366 367
  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
368
  Status     : At Risk.
369
             : This is here for backwards compatibility only and may be removed 
370 371 372
             : 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
373 374 375 376 377 378
=cut

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


379 380
  if(lc($db->species()) ne lc($adap->species)){
    $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)} = $adap;
381
  }
Ian Longden's avatar
Ian Longden committed
382 383 384 385
}

=head2 remove_db

386
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
387 388 389 390
  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
391
  Status     : At Risk.
392
             : This is here for backwards compatibility only and may be removed 
393 394
             : 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
395 396 397 398 399 400

=cut

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

401 402
  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
403 404 405 406 407 408

  return $ret;
}

=head2 get_db

409
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
410 411 412 413
  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
414
  Status     : At Risk.
415
             : This is here for backwards compatibility only and may be removed 
416 417
             : 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
418 419 420 421 422 423

=cut

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

424
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor(lc($db->species),lc($name));
425 426 427 428

  if(defined($ret)){
    return $ret;
  }
429
  return $registry_register{lc($db->species())}{lc($db->group())}{'_special'}{lc($name)};
Ian Longden's avatar
Ian Longden committed
430 431 432 433
}

=head2 get_all_db_adaptors

434
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
435 436 437
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
438
  Status     : At Risk.
439
             : This is here for backwards compatibility only and may be removed 
440 441 442
             : 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
443 444 445 446 447 448 449

=cut

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

Ian Longden's avatar
Ian Longden committed
450 451 452 453
# 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'}}){
454
    if(lc($dba->species()) eq lc($db->species())){
Ian Longden's avatar
Ian Longden committed
455 456 457 458
      $ret{$dba->group()} = $dba;
    } 
  }

459
 foreach my $key (keys %{$registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}}){
460
   $ret{$key} = $registry_register{$class->get_alias($db->species())}{lc($db->group())}{'_special'}{$key};
Ian Longden's avatar
Ian Longden committed
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
 }

  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
479 480
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
481 482 483 484 485 486

=cut

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

487 488 489 490 491
  if(!($class->alias_exists($species))){
    $class->add_alias($species,$species);
  }
  

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

494
  $registry_register{$species}{lc($group)}{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

  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
516
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
517 518 519 520 521 522 523 524

=cut

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

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

525 526
  return  $registry_register{$species}{lc($group)}{'_DB'};

Ian Longden's avatar
Ian Longden committed
527 528 529 530
}

=head2 get_all_DBAdaptors

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

=cut

sub get_all_DBAdaptors{
544 545
  my ($class,@args)=@_;
  my @ret;
Ian Longden's avatar
Ian Longden committed
546

547 548 549 550 551 552
  my ($species, $group) = 
    rearrange([qw(SPECIES GROUP)], @args);
  if(defined($species)){
    $species = $class->get_alias($species);
  }
  foreach my $dba (@{$registry_register{'_DBA'}}){
553
    if(!defined($species) || lc($species) eq lc($dba->species)){
554 555 556 557 558 559 560 561
      if(!defined($group) || lc($group) eq lc($dba->group)){
	push @ret, $dba;
      }
    }
  }


  return \@ret;
Ian Longden's avatar
Ian Longden committed
562 563
}

564 565 566 567 568 569
=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);
570
  Status     : Stable
571 572 573 574 575 576 577 578 579

=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
580
    if($dbc && $dbc->can('equals') && $dbc->equals($dbc_orig)){
581 582 583 584 585 586 587
      push @return, $dba;
    }
  }
  return \@return;
}


Ian Longden's avatar
Ian Longden committed
588 589 590 591 592 593 594 595
#
# 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.
596 597 598
  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
599 600
  Returntype : none
  Exceptions : none
601
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
602 603 604 605

=cut

sub add_DNAAdaptor{
Ian Longden's avatar
Ian Longden committed
606
  my ($class, $species, $group, $dnadb_species, $dnadb_group) = @_;
Ian Longden's avatar
Ian Longden committed
607 608

  $species = $class->get_alias($species);
609
  $dnadb_species = $class->get_alias($dnadb_species);
610
  if($dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor')){
Ian Longden's avatar
Ian Longden committed
611
    deprecated("");
612 613
  }
  else{
614 615
    $registry_register{$species}{lc($group)}{'_DNA'} = $dnadb_group;
    $registry_register{$species}{lc($group)}{'_DNA2'} = $dnadb_species;
616
  }
Ian Longden's avatar
Ian Longden committed
617 618 619 620 621 622 623 624 625
}

=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
626
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
627 628 629 630 631 632 633

=cut

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

  $species = $class->get_alias($species);
634 635
  my $new_group = $registry_register{$species}{lc($group)}{'_DNA'};
  my $new_species = $registry_register{$species}{lc($group)}{'_DNA2'};
636
  if( defined $new_group ) {
Ian Longden's avatar
Ian Longden committed
637
    return  $class->get_DBAdaptor($new_species,$new_group);
638 639 640
  } else {
    return undef;
  }
Ian Longden's avatar
Ian Longden committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
}

#
# 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
657 658
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675


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

676
  if(defined($reset)){ # JUST REST THE HASH VALUE NO MORE PROCESSING NEEDED
677
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
678 679
    return;
  }
680
  if(defined($registry_register{$species}{lc($group)}{lc($type)})){ 
Glenn Proctor's avatar
Glenn Proctor committed
681
    #print STDERR ("Overwriting Adaptor in Registry for $species $group $type\n");
682
    $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
683 684
   return;
  }
685
  $registry_register{$species}{lc($group)}{lc($type)} = $adap;
Ian Longden's avatar
Ian Longden committed
686 687 688

  if(!defined ($registry_register{$species}{'list'})){
    my @list =();
689
    push(@list,$type);
Ian Longden's avatar
Ian Longden committed
690 691 692
    $registry_register{$species}{'list'}= \@list;
  }
  else{
693
    push(@{$registry_register{$species}{'list'}},$type);
Ian Longden's avatar
Ian Longden committed
694 695
  }

696

Ian Longden's avatar
Ian Longden committed
697

698
  if(!defined ($registry_register{lc($type)}{$species})){
Ian Longden's avatar
Ian Longden committed
699 700
    my @list =();
    push(@list,$adap);
701
    $registry_register{lc($type)}{$species}= \@list;
Ian Longden's avatar
Ian Longden committed
702 703
  }
  else{
704
    push(@{$registry_register{lc($type)}{$species}},$adap);
Ian Longden's avatar
Ian Longden committed
705 706 707 708 709 710 711 712 713 714 715 716 717
  }

}


=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
718
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
719 720 721 722 723 724

=cut

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

728
  my $dnadb_group =  $registry_register{$species}{lc($group)}{_DNA};
729

730 731
  if( defined($dnadb_group) && defined($dnadb_adaptors{lc($type)}) ) {
      $species = $registry_register{$species}{lc($group)}{'_DNA2'};
732
      $group = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
733 734
  }

735
  my $ret = $registry_register{$species}{lc($group)}{lc($type)};
Ian Longden's avatar
Ian Longden committed
736
  if(!defined($ret)){
737
    return undef;
Ian Longden's avatar
Ian Longden committed
738 739
  }
  if(!ref($ret)){ # not instantiated yet
740
    my $dba = $registry_register{$species}{lc($group)}{'_DB'};
Ian Longden's avatar
Ian Longden committed
741 742 743 744 745 746 747
    my $module = $ret;
    eval "require $module";

    if($@) {
      warning("$module cannot be found.\nException $@\n");
      return undef;
    }
748 749 750 751
    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
752 753 754 755 756 757 758 759 760 761
    my $adap = "$module"->new($dba);
    Bio::EnsEMBL::Registry->add_adaptor($species, $group, $type, $adap, "reset");
    $ret = $adap;
  }

  return $ret;
}

=head2 get_all_adaptors

762 763 764 765 766 767
  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
768
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
769
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
770
  Exceptions : none
771
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
772 773 774 775

=cut

sub get_all_adaptors{
776 777 778 779
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
780

781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813

  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'}}){ 
814
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
	  $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
832 833 834 835 836 837 838 839 840 841 842
}


=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
843
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
844 845 846 847 848 849

=cut

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

850
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
851 852 853 854 855 856 857 858
}

=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
859
  Exceptions : none
860
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
861 862 863 864

=cut

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

867
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
868
    return $key;
Ian Longden's avatar
Ian Longden committed
869
  }
870
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
871
}
872 873 874 875

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
Ian Longden's avatar
Ian Longden committed
876
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
877 878 879
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
880
  Status     : Stable
881 882 883 884 885 886

=cut

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

887
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
888 889 890 891
    return 1;
  }
  return 0;
}
892

893 894 895 896 897 898 899
=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
900
  Status     : Stable
901 902 903

=cut

904
sub set_disconnect_when_inactive{
905
  foreach my $dba ( @{get_all_DBAdaptors()}){
906 907
    my $dbc = $dba->dbc;
    #disconnect if connected
908
    $dbc->disconnect_if_idle() if $dbc->connected();
909 910 911
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
912

913 914 915 916 917 918 919

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
920
  Status     : Stable
921 922 923

=cut

924
sub disconnect_all {
Web Admin's avatar
fixed  
Web Admin committed
925
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
926
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
927
    next unless $dbc;
928 929 930 931
    #disconnect if connected
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
932

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
=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
951
  Status     : Stable
952 953 954 955

=cut

sub change_access{
Steve Trevanion's avatar
Steve Trevanion committed
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
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);
	}
972 973 974
    }
}

975 976


977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
=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");
  }
}


1021
=head2 load_registry_from_db
1022

1023 1024 1025 1026 1027 1028 1029 1030 1031
  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 
1032 1033 1034 1035 1036 1037
  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.
1038 1039 1040 1041 1042
  Arg [WAIT_TIMEOUT]: (optional) integer
                 Time in seconds for the wait timeout to happen. Time after which
                 the connection is deleted if not used. By default this is 28800 (8 hours)
                 So set this to greater than this if your connection are getting deleted.
                 Only set this if you are having problems and know what you are doing.
1043 1044 1045 1046 1047

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

1048
  Description: Will load the correct versions of the ensembl databases for the
1049
               software release it can find on a database instance into the 
1050
               registry. Also adds a set of standard aliases.
1051 1052

  Exceptions : None.
1053
  Status     : Stable
1054 1055
 
=cut
1056

1057
sub load_registry_from_db {
1058
  my($self, @args) = @_;
1059 1060
  my ($host, $port, $user, $pass, $verbose, $db_version, $wait_timeout) =
    rearrange([qw(HOST PORT USER PASS VERBOSE DB_VERSION WAIT_TIMEOUT )], @args);
1061 1062 1063 1064 1065 1066 1067



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

  $user ||= "ensro";
1068
  $port ||= 3306;
1069
  $wait_timeout ||= 0;
1070 1071 1072 1073 1074 1075
  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;
1076
  my $software_version = $self->software_version();
1077 1078 1079
  if (defined($db_version)) {
    $software_version = $db_version;
  }
1080
  print "Will only load $software_version databases\n" if ($verbose);
1081 1082
  for my $db (@dbnames){
    if($db =~ /^([a-z]+_[a-z]+_[a-z]+)_(\d+)_(\d+[a-z]*)/){
1083
      if($2 eq $software_version){
1084 1085 1086 1087
	$temp{$1} = $2."_".$3;
      }
    }
    elsif($db =~ /^ensembl_compara_(\d+)/){
1088
      if($1 eq $software_version){
1089 1090 1091 1092
	$compara_version = $1;
      }
    }
    elsif($db =~ /^ensembl_go_(\d+)/){
1093
      if($1 eq $software_version){
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	$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,
1117 1118
	-dbname => $coredb,
        -wait_timeout => $wait_timeout
1119 1120 1121 1122 1123
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $coredb." loaded\n" if ($verbose);
  }
1124

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
  # 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,
1138 1139
	-dbname => $cdnadb,
        -wait_timeout => $wait_timeout
1140 1141 1142 1143 1144 1145
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $cdnadb." loaded\n" if ($verbose);
  }

1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
  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,
1157
        -wait_timeout => $wait_timeout,
1158 1159 1160 1161 1162 1163
	-dbname => $vegadb
      );
    (my $sp = $species ) =~ s/_/ /g;
    $self->add_alias( $species, $sp );
    print $vegadb." loaded\n" if ($verbose);
  }
1164
  
Ian Longden's avatar
Ian Longden committed
1165
  my @other_dbs = grep { /^[a-z]+_[a-z]+_otherfeatures_\d+_/ } @dbnames;
1166
  
Ian Longden's avatar
Ian Longden committed
1167 1168
  for my $other_db ( @other_dbs ) {
    my ($species, $num) = ( $other_db =~ /(^[a-z]+_[a-z]+)_otherfeatures_(\d+)/ );
1169
    my $dba = Bio::EnsEMBL::DBSQL::DBAdaptor->new