Registry.pm 73.7 KB
Newer Older
1
=head1 LICENSE
Ian Longden's avatar
Ian Longden committed
2

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
  Copyright (c) 1999-2009 The European Bioinformatics Institute and
  Genome Research Limited.  All rights reserved.

  This software is distributed under a modified Apache license.
  For license details, please see

    http://www.ensembl.org/info/about/code_licence.html

=head1 CONTACT

  Please email comments or questions to the public Ensembl
  developers list at <ensembl-dev@ebi.ac.uk>.

  Questions may also be sent to the Ensembl help desk at
  <helpdesk@ensembl.org>.

=cut
Ian Longden's avatar
Ian Longden committed
20
21
22
23
24
25
26

=head1 NAME

Bio::EnsEMBL::Registry

=head1 SYNOPSIS

27
  use Bio::EnsEMBL::Registry;
28

29
30
31
32
33
  my $registry = 'Bio::EnsEMBL::Registry';

  $registry->load_all("configuration_file");

  $gene_adaptor = $registry->get_adaptor( 'Human', 'Core', 'Gene' );
Ian Longden's avatar
Ian Longden committed
34
35
36
37


=head1 DESCRIPTION

38
39
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
40

41
42
The registry can be loaded from a configuration file using the load_all
method.
Ian Longden's avatar
Ian Longden committed
43

44
45
46
47
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
48

49
50
For the Web server ENSEMBL_REGISTRY should be set in SiteDefs.pm.  This
will then be passed on to load_all.
51
52


53
54
55
56
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.

57
58
The four types of registries are for db adaptors, dba adaptors, dna
adaptors and the standard type.
Ian Longden's avatar
Ian Longden committed
59
60
61

=head2 db

62
63
These are registries for backwards compatibility and enable the
subroutines to add other adaptors to connections.
Ian Longden's avatar
Ian Longden committed
64

65
66
67
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.
Ian Longden's avatar
Ian Longden committed
68
69

So if before we had
70

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

We now want to change this to
74

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


=head2 DBA

These are the stores for the DBAdaptors

83
84
The Registry will create all the DBConnections needed now if you set up
the configuration correctly. So instead of the old commands like
Ian Longden's avatar
Ian Longden committed
85

86
87
  my $db           = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);
  my $exon_adaptor = $db->get_ExonAdaptor;
Ian Longden's avatar
Ian Longden committed
88
89
90

we should now have just

91
92
  my $exon_adaptor =
    Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
93
94
95
96


=head2 DNA

97
98
99
This is an internal Registry and allows the configuration of a dnadb.
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
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" );
Ian Longden's avatar
Ian Longden committed
104
105
106
107


=head2 adaptors

108
109
This is the registry for all the general types of adaptors like
GeneAdaptor, ExonAdaptor, Slice Adaptor etc.
Ian Longden's avatar
Ian Longden committed
110
111
112

These are accessed by the get_adaptor subroutine i.e.

113
114
  my $exon_adaptor =
    Bio::EnsEMBL::Registry->get_adaptor( "human", "core", "exon" );
Ian Longden's avatar
Ian Longden committed
115
116
117
118
119
120
121
122
123

=head1 METHODS

=cut

package Bio::EnsEMBL::Registry;

use strict;

124
use Bio::EnsEMBL::DBSQL::DBAdaptor;
Ian Longden's avatar
Ian Longden committed
125
126
use Bio::EnsEMBL::Utils::Exception qw( deprecate throw warning );
use Bio::EnsEMBL::Utils::Argument qw(rearrange);
127
use Bio::EnsEMBL::Utils::ConfigRegistry;
128
use DBI;
Ian Longden's avatar
Ian Longden committed
129
130
131

use vars qw(%registry_register);

Daniel Rios's avatar
Daniel Rios committed
132
my $API_VERSION = 55;
Ian Longden's avatar
Ian Longden committed
133

134
135
# This is a map from group names to Ensembl DB adaptors.  Used by
# load_all() and reset_DBAdaptor().
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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',
  'ontology'      => 'Bio::EnsEMBL::DBSQL::OntologyDBAdaptor',
  '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',
);
152
153


Ian Longden's avatar
Ian Longden committed
154
=head2 load_all
155

156
157
 Will load the registry with the configuration file which is
 obtained from the first in the following and in that order.
158

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

162
163
  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
164

165
166
  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
167

168
169
  Arg [1]    : (optional) string
               Name of file to load the registry from.
170

171
172
  Arg [2]    : (optional) integer
               If not 0, will print out all information.
173

174
  Arg [3]    : (optional) integer
175
176
177
178
179
180
181
182
183
184
185
186
187
188
               If not 0, the database connection will not be
               cleared, if 0 or if not set the database connections
               will be cleared (this is the default).

  Arg [4]:     (optional) boolean
               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
189
190
191
  Example    : Bio::EnsEMBL::Registry->load_all();
  Returntype : none
  Exceptions : none
192
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
193
194

=cut
195

196
197
sub load_all {
    my $class = shift;
198
    my ( $config_file, $verbose, $no_clear, $no_cache ) = @_;
199
200
201
202
203
204

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

    $verbose  ||= 0;
    $no_clear ||= 0;
205
    $no_cache ||= 0;
206
207
208
209
210
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

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

236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
        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 );
        }
252

253
        if ( defined $cfg ) {
254
		  my %default_adaptor_args = ();
255
256
257
258

            if ( $cfg->SectionExists('default') ) {
                # The 'default' section is special.  It contain default
                # values that should be implicit to all other section in
259
260
261
262
263
264
265
266
267
268
269
270
271
                # 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 ) ]
                    );
272
                }
273

274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
                %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;
                }

305
306
307
308
309
                # 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.

310
311
312
                my $alias = $cfg->val( $section, 'alias' );
                $cfg->delval( $section, 'alias' );

313
314
315
316
317
318
319
320
321
322
323
                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.
324
325
326
                # We trust the user to provide sensible key-value pairs.
                my %adaptor_args = %default_adaptor_args;
                foreach my $parameter ( $cfg->Parameters($section) ) {
327
328
329
330
331
332
333
334
                  $adaptor_args{ '-' . $parameter } =
                    $cfg->val( $section, $parameter );

                  # when set, do not use the feature cache in the
                  # different adaptors
                  if ($no_cache) {
                    $adaptor_args{'-no_cache'} = 1;
                  }
335
336
337
338
339
340
341
342
                }

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

343
344
345
                eval "require $adaptor";
                if ($@) { die($@) }

346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
                $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...
361
} ## end sub load_all
362
363

=head2 clear
364

365
366
367
368
369
 Will clear the registry and disconnect from all databases.

  Example    : Bio::EnsEMBL::Registry->clear();
  Returntype : none
  Exceptions : none
370
  Status     : Stable
371
372
373
374
375
376
377
378
379
380
381

=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
382
  %registry_register = ();
Ian Longden's avatar
Ian Longden committed
383
384
385
}

#
386
# db adaptors. (for backwards compatibility)
Ian Longden's avatar
Ian Longden committed
387
388
389
390
#

=head2 add_db

391
  Arg [1]    : db (DBAdaptor) to add adaptor to.
Ian Longden's avatar
Ian Longden committed
392
393
394
395
396
  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
397
  Status     : At Risk.
398
399
400
401
             : This is here for backwards compatibility 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
402

403
=cut
Ian Longden's avatar
Ian Longden committed
404

405
406
sub add_db {
  my ( $class, $db, $name, $adap ) = @_;
Ian Longden's avatar
Ian Longden committed
407

408
409
410
  if ( lc( $db->species() ) ne lc( $adap->species ) ) {
    $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
      {'_special'}{ lc($name) } = $adap;
411
  }
Ian Longden's avatar
Ian Longden committed
412
413
414
415
}

=head2 remove_db

416
  Arg [1]    : db (DBAdaptor) to remove adaptor from.
Ian Longden's avatar
Ian Longden committed
417
418
419
420
  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
421
  Status     : At Risk.
422
423
424
425
             : This is here for backwards compatibility 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
426
427
428

=cut

429
430
431
432
433
434
sub remove_db {
  my ( $class, $db, $name ) = @_;

  my $ret =
    $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
    {'_special'}{ lc($name) };
Ian Longden's avatar
Ian Longden committed
435

436
437
  $registry_register{ lc( $db->species() ) }{ lc( $db->group() ) }
    {'_special'}{ lc($name) } = undef;
Ian Longden's avatar
Ian Longden committed
438
439
440
441
442
443

  return $ret;
}

=head2 get_db

444
  Arg [1]    : db (DBAdaptor) to get adaptor from.
Ian Longden's avatar
Ian Longden committed
445
446
447
448
  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
449
  Status     : At Risk.
450
451
452
453
             : This is here for backwards compatibility 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
454
455
456

=cut

457
458
sub get_db {
  my ( $class, $db, $name ) = @_;
Ian Longden's avatar
Ian Longden committed
459

460
461
  my $ret = Bio::EnsEMBL::Registry->get_DBAdaptor( lc( $db->species ),
    lc($name) );
462

463
464
465
466
  if ( defined($ret) ) { return $ret }

  return $registry_register{ lc( $db->species() ) }
    { lc( $db->group() ) }{'_special'}{ lc($name) };
Ian Longden's avatar
Ian Longden committed
467
468
469
470
}

=head2 get_all_db_adaptors

471
  Arg [1]    : db (DBAdaptor) to get all the adaptors from.
Ian Longden's avatar
Ian Longden committed
472
473
474
  Example    : my $db = Bio::EnsEMBL::Registry->get_all_db_adaptors($db);
  Returntype : adaptor
  Exceptions : none
475
  Status     : At Risk.
476
477
478
479
             : This is here for backwards compatibility 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");
480

Ian Longden's avatar
Ian Longden committed
481
482
483

=cut

484
485
486
sub get_all_db_adaptors {
  my ( $class, $db ) = @_;
  my %ret = ();
Ian Longden's avatar
Ian Longden committed
487

488
489
  # 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
490

491
492
493
494
  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
495
496
  }

497
  foreach my $key (
498
499
500
    keys %{
      $registry_register{ $class->get_alias( $db->species() ) }
        { lc( $db->group() ) }{'_special'} } )
501
502
503
504
505
  {
    $ret{$key} =
      $registry_register{ $class->get_alias( $db->species() ) }
      { lc( $db->group() ) }{'_special'}{$key};
  }
Ian Longden's avatar
Ian Longden committed
506
507

  return \%ret;
508
} ## end sub get_all_db_adaptors
Ian Longden's avatar
Ian Longden committed
509
510
511
512
513
514
515
516
517
518
519
520
521
522


#
# 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
523
524
  caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
525
526
527

=cut

528
529
sub add_DBAdaptor {
  my ( $class, $species, $group, $adap ) = @_;
Ian Longden's avatar
Ian Longden committed
530

531
532
  if ( !( $class->alias_exists($species) ) ) {
    $class->add_alias( $species, $species );
533
534
  }

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

537
  $registry_register{$species}{ lc($group) }{'_DB'} = $adap;
Ian Longden's avatar
Ian Longden committed
538

539
540
541
542
543
544
  if ( !defined( $registry_register{'_DBA'} ) ) {
    my @list = ();
    push( @list, $adap );
    $registry_register{'_DBA'} = \@list;
  } else {
    push( @{ $registry_register{'_DBA'} }, $adap );
Ian Longden's avatar
Ian Longden committed
545
546
547
548
549
550
551
552
553
554
555
556
557
  }

}



=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
558
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
559
560
561

=cut

562
563
sub get_DBAdaptor {
  my ( $class, $species, $group ) = @_;
Ian Longden's avatar
Ian Longden committed
564
565
566

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

567
  return $registry_register{$species}{ lc($group) }{'_DB'};
Ian Longden's avatar
Ian Longden committed
568
569
570
571
}

=head2 get_all_DBAdaptors

572
573
574
575
  Arg [SPECIES]: (optional) string 
                  species name to get adaptors for
  Arg [GROUP]  : (optional) string 
                  group name to get adaptors for
576
577
578
579
580
581
582
583
584
  Example      : 
                @dba =
                  @{ Bio::EnsEMBL::Registry->get_all_DBAdaptors() };

                @human_dbas =
                  @{ Bio::EnsEMBL::Registry->get_all_DBAdaptors(
                    -species => 'human'
                  ) };

585
586
  Returntype   : list of DBAdaptors
  Exceptions   : none
587
  Status       : Stable
Ian Longden's avatar
Ian Longden committed
588
589
590

=cut

591
592
593
594
sub get_all_DBAdaptors {
  my ( $class, @args ) = @_;

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

596
  if ( defined($species) ) { $species = $class->get_alias($species) }
597

598
  my @ret;
599
  foreach my $dba ( @{ $registry_register{'_DBA'} } ) {
600
601
602
603
    if ( ( !defined($species) || lc($species) eq lc( $dba->species() ) )
      && ( !defined($group) || lc($group) eq lc( $dba->group() ) ) )
    {
      push( @ret, $dba );
604
605
606
607
    }
  }

  return \@ret;
Ian Longden's avatar
Ian Longden committed
608
609
}

610
611
=head2 get_all_DBAdaptors_by_connection

612
  Arg [1]    : DBConnection used to find DBAdaptors
613
  Returntype : reference to list of DBAdaptors
614
615
616
  Exceptions : none
  Example    : @dba = @{ Bio::EnsEMBL::Registry
                  ->get_all_DBAdaptors_by_connection($dbc) };
617
  Status     : Stable
618
619
620

=cut

621
622
623
sub get_all_DBAdaptors_by_connection {
  my ( $self, $dbc_orig ) = @_;

624
625
  my @return;

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
  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 );
661
662
    }
  }
663

664
665
666
  return \@return;
}

667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
=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
682
683
  
 
684
  delete $registry_register{$species}{$group};
685
  # This will remove the DBAdaptor and all the other adaptors
686

687
  # Now remove if from the _DBA array
688
689
  my $index;

Nathan Johnson's avatar
Nathan Johnson committed
690

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

694
695
696
    if(($dba->species eq $species) &&
       $dba->group eq $group){
      $index = $i;
Nathan Johnson's avatar
Nathan Johnson committed
697

698
699
700
701
      last;
    }
  }
  
702
  
703
  # Now remove from _DBA cache
704
  splice(@{$registry_register{'_DBA'}}, $index, 1) if defined $index;
Nathan Johnson's avatar
Nathan Johnson committed
705

706
707
708
  return;
}

709

Nathan Johnson's avatar
Nathan Johnson committed
710
711
712
713
714
715
716

=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
717
  Arg [8]:     hashref - Hash ref of additional parameters e.g. eFG dnadb params for auto selecting dnadb
718
719
  Usage :      $reg->reset_registry_db( 'homo_sapiens', 'core',
                  'homo_sapiens_core_37_35j' );
Nathan Johnson's avatar
Nathan Johnson committed
720
721
722
723
724
725
726
727
  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

728
729
730
731
732
sub reset_DBAdaptor {
  my (
    $self, $species, $group, $dbname, $host,
    $port, $user,    $pass,  $params
  ) = @_;
Nathan Johnson's avatar
Nathan Johnson committed
733

734
  # Check mandatory params
735
736
737
738
  if ( !( defined $species && defined $group && defined $dbname ) ) {
    throw(
      'Must provide at least a species, group, and dbname parameter '
        . 'to redefine a DB in the registry' );
Nathan Johnson's avatar
Nathan Johnson committed
739
  }
740

741
  # Validate species here
Nathan Johnson's avatar
Nathan Johnson committed
742
  my $alias = $self->get_alias($species);
743
744
745
  throw("Could not find registry alias for species:\t$species")
    if ( !defined $alias );

746
  # Get all current defaults if not defined
Nathan Johnson's avatar
Nathan Johnson committed
747

748
  my $db = $self->get_DBAdaptor( $alias, $group );
749
  my $class;
Nathan Johnson's avatar
Nathan Johnson committed
750

751
752
753
754
755
756
757
758
759
  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) };
760

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

767
  $self->remove_DBAdaptor( $alias, $group );
Nathan Johnson's avatar
Nathan Johnson committed
768

769
770
771
772
  #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
773

774
  # ConfigRegistry should automatically add this to the Registry
775
776

  $db = $class->new(
777
778
779
780
781
782
783
784
    -user    => $user,
    -host    => $host,
    -port    => $port,
    -pass    => $pass,
    -dbname  => $dbname,
    -species => $alias,
    -group   => $group,
    %{$params} );
Nathan Johnson's avatar
Nathan Johnson committed
785
786

  return $db;
787
} ## end sub reset_DBAdaptor
Nathan Johnson's avatar
Nathan Johnson committed
788
789


Ian Longden's avatar
Ian Longden committed
790
791
792
793
794
795
796
797
#
# 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.
798
799
800
  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
801
802
  Returntype : none
  Exceptions : none
803
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
804
805
806

=cut

807
808
sub add_DNAAdaptor {
  my ( $class, $species, $group, $dnadb_species, $dnadb_group ) = @_;
Ian Longden's avatar
Ian Longden committed
809

810
  $species       = $class->get_alias($species);
811
  $dnadb_species = $class->get_alias($dnadb_species);
812
  if ( $dnadb_group->isa('Bio::EnsEMBL::DBSQL::DBAdaptor') ) {
Ian Longden's avatar
Ian Longden committed
813
    deprecated("");
814
815
816
817
  } else {
    $registry_register{$species}{ lc($group) }{'_DNA'} = $dnadb_group;
    $registry_register{$species}{ lc($group) }{'_DNA2'} =
      $dnadb_species;
818
  }
Ian Longden's avatar
Ian Longden committed
819
820
821
822
823
824
825
826
827
}

=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
828
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
829
830
831

=cut

832
833
sub get_DNAAdaptor {
  my ( $class, $species, $group ) = @_;
Ian Longden's avatar
Ian Longden committed
834
835

  $species = $class->get_alias($species);
836
837
838
839
840
  my $new_group   = $registry_register{$species}{ lc($group) }{'_DNA'};
  my $new_species = $registry_register{$species}{ lc($group) }{'_DNA2'};

  if ( defined $new_group ) {
    return $class->get_DBAdaptor( $new_species, $new_group );
841
  }
842
843

  return undef;
Ian Longden's avatar
Ian Longden committed
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
}

#
# 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
860
861
  Caller     : internal
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
862
863
864

=cut

865
866
sub add_adaptor {
  my ( $class, $species, $group, $type, $adap, $reset ) = @_;
Ian Longden's avatar
Ian Longden committed
867
868
869

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

870
871
872
873
874
  # 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
875

876
877
878
  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
879
880
    return;
  }
881
882
883
884
885
886
887
  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
888
  }
889
  $registry_register{$species}{ lc($group) }{ lc($type) } = $adap;
Ian Longden's avatar
Ian Longden committed
890

891
892
893
894
  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
895
896
  }

897
898
899
900
  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
901
902
  }

903
} ## end sub add_adaptor
Ian Longden's avatar
Ian Longden committed
904
905
906
907
908
909
910
911
912
913


=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
914
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
915
916
917

=cut

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

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

923
924
925
926
927
928
929
930
  my %dnadb_adaptors = (
    'sequence'                 => 1,
    'assemblymapper'           => 1,
    'karyotypeband'            => 1,
    'repeatfeature'            => 1,
    'coordsystem'              => 1,
    'assemblyexceptionfeature' => 1
  );
931

932
  ## warn "$species, $group, $type";
933
934
935

  $type = lc($type);

936
  my $dnadb_group = $registry_register{$species}{ lc($group) }{'_DNA'};
937

938
939
940
941
942
  if ( defined($dnadb_group)
    && defined( $dnadb_adaptors{ lc($type) } ) )
  {
    $species = $registry_register{$species}{ lc($group) }{'_DNA2'};
    $group   = $dnadb_group;
Ian Longden's avatar
Ian Longden committed
943
944
  }

945
  my $ret = $registry_register{$species}{ lc($group) }{ lc($type) };
946
947
  if ( !defined($ret) ) { return undef }
  if ( ref($ret) )      { return $ret }
948

949
  # Not instantiated yet
Ian Longden's avatar
Ian Longden committed
950

951
952
953
954
955
956
957
  my $dba    = $registry_register{$species}{ lc($group) }{'_DB'};
  my $module = $ret;

  eval "require $module";
  if ($@) {
    warning("'$module' cannot be found.\nException $@\n");
    return undef;
Ian Longden's avatar
Ian Longden committed
958
959
  }

960
961
962
963
964
965
966
967
968
969
970
971
  if (
    !defined( $registry_register{$species}{ lc($group) }{'CHECKED'} ) )
  {
    $registry_register{$species}{ lc($group) }{'CHECKED'} = 1;
    $class->version_check($dba);
  }

  my $adap = "$module"->new($dba);
  Bio::EnsEMBL::Registry->add_adaptor( $species, $group, $type, $adap,
    'reset' );
  $ret = $adap;

Ian Longden's avatar
Ian Longden committed
972
  return $ret;
973
} ## end sub get_adaptor
Ian Longden's avatar
Ian Longden committed
974
975
976

=head2 get_all_adaptors

977
978
979
980
981
982
  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
983
  Example    : @adaps = @{Bio::EnsEMBL::Registry->get_all_adaptors()};
984
  Returntype : ref to list of adaptors
Ian Longden's avatar
Ian Longden committed
985
  Exceptions : none
986
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
987
988
989
990

=cut

sub get_all_adaptors{
991
992
993
994
  my ($class,@args)= @_;
  my ($species, $group, $type);
  my @ret=();
  my (%species_hash, %group_hash, %type_hash);
Ian Longden's avatar
Ian Longden committed
995

996

997
  if(@args == 1){ # Old species only one parameter
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
    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'}}){ 
1029
	foreach my $ty (@{$registry_register{lc($dba->species)}{'list'}}){
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
	  $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
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
}


=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
1058
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
1059
1060
1061
1062
1063
1064

=cut

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

1065
  $registry_register{'_ALIAS'}{lc($key)} = lc($species);
Ian Longden's avatar
Ian Longden committed
1066
1067
1068
1069
1070
1071
1072
1073
}

=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
1074
  Exceptions : none
1075
  Status     : Stable
Ian Longden's avatar
Ian Longden committed
1076
1077
1078
1079

=cut

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

1082
  if(!defined($registry_register{'_ALIAS'}{lc($key)})){
1083
    return $key;
Ian Longden's avatar
Ian Longden committed
1084
  }
1085
  return $registry_register{'_ALIAS'}{lc($key)};
Ian Longden's avatar
Ian Longden committed
1086
}
1087
1088
1089
1090

=head2 alias_exists

  Arg [1]    : name of the possible alias to get species for
Ian Longden's avatar
Ian Longden committed
1091
  Example    : Bio::EnsEMBL::Registry->alias_exists("Human");
1092
1093
1094
  Description: does the species name exist.
  Returntype : 1 if exists else 0
  Exceptions : none
1095
  Status     : Stable
1096
1097
1098
1099
1100
1101

=cut

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

1102
  if(defined($registry_register{'_ALIAS'}{lc($key)})){
1103
1104
1105
1106
    return 1;
  }
  return 0;
}
1107

1108
1109
1110
1111
1112
1113
1114
=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
1115
  Status     : Stable
1116
1117
1118

=cut

1119
sub set_disconnect_when_inactive{
1120
  foreach my $dba ( @{get_all_DBAdaptors()}){
1121
    my $dbc = $dba->dbc;
1122
    # Disconnect if connected
1123
    $dbc->disconnect_if_idle() if $dbc->connected();
1124
1125
1126
    $dbc->disconnect_when_inactive(1);
  }
}
Ian Longden's avatar
Ian Longden committed
1127

1128
1129
1130
1131
1132
1133
1134

=head2 disconnect_all

  Example    : Bio::EnsEMBL::Registry->disconnect_all();
  Description: disconnect from all the databases.
  Returntype : none
  Exceptions : none
1135
  Status     : Stable
1136
1137
1138

=cut

1139
sub disconnect_all {
Web Admin's avatar
fixed    
Web Admin committed
1140
  foreach my $dba ( @{get_all_DBAdaptors()||[]} ){
1141
    my $dbc = $dba->dbc;
Web Admin's avatar
Web Admin committed
1142
    next unless $dbc;
1143
    # Disconnect if connected
1144
1145
1146
    $dbc->disconnect_if_idle() if $dbc->connected();
  }
}
1147

1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
=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
1166
  Status     : Stable
1167
1168
1169
1170

=cut

sub change_access{
Steve Trevanion's avatar
Steve Trevanion committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
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);
	}
1187
1188
1189
    }
}

1190
1191


1192
1193
=head2 load_registry_from_url

Glenn Proctor's avatar
Typos.    
Glenn Proctor committed
1194
  Arg [1] : string $url
1195
  Arg [2] : (optional) integer
1196
            If not 0, will print out all information.
1197
  Arg [3] : (optional) integer
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
          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

  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.

1219
1220
1221
1222
1223
1224
  Exceptions : None.
  Status     : Stable
 
=cut

sub load_registry_from_url {
1225
  my ($self, $url, $verbose, $no_cache) = @_;
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244

  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,
1245
1246
        -verbose => $verbose,
	-no_cache => $no_cache);
1247
1248
1249
1250
1251
1252
  } else {
    throw("Only MySQL URLs are accepted at the moment");
  }
}


1253
=head2 load_registry_from_db
1254

1255
1256
1257
  Arg [HOST] : string
                The domain name of the database host to connect to.

1258
  Arg [USER] : string
1259
1260
                The name of the database user to connect with.

1261
  Arg [PASS] : (optional) string
1262
1263
1264
1265
                The password to be used to connect to the database.

  Arg [PORT] : (optional) integer
                The port to use when connecting to the database.
1266

1267
1268
  Arg [VERBOSE]: (optional) boolean
                Whether to print database messages.
1269

1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297