->type_info fix for buggy Firebird ODBC driver
[dbsrgits/DBIx-Class-Schema-Loader.git] / lib / DBIx / Class / Schema / Loader / DBI.pm
index 474d54b..031e074 100644 (file)
@@ -3,10 +3,19 @@ package DBIx::Class::Schema::Loader::DBI;
 use strict;
 use warnings;
 use base qw/DBIx::Class::Schema::Loader::Base/;
-use Class::C3;
+use mro 'c3';
 use Carp::Clan qw/^DBIx::Class/;
+use Try::Tiny;
+use namespace::clean;
 
-our $VERSION = '0.04999_07';
+our $VERSION = '0.07010';
+
+__PACKAGE__->mk_group_accessors('simple', qw/
+    _disable_pk_detection
+    _disable_uniq_detection
+    _disable_fk_detection
+    _passwords
+/);
 
 =head1 NAME
 
@@ -35,19 +44,23 @@ things.
 sub new {
     my $self = shift->next::method(@_);
 
-    # rebless to vendor-specific class if it exists and loads
-    my $dbh = $self->schema->storage->dbh;
-    my $driver = $dbh->{Driver}->{Name};
+    # rebless to vendor-specific class if it exists and loads and we're not in a
+    # custom class.
+    if (not $self->loader_class) {
+        my $dbh = $self->schema->storage->dbh;
+        my $driver = $dbh->{Driver}->{Name};
 
-    my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
-    if ($self->load_optional_class($subclass)) {
-        bless $self, $subclass unless $self->isa($subclass);
-        $self->_rebless;
+        my $subclass = 'DBIx::Class::Schema::Loader::DBI::' . $driver;
+        if ($self->load_optional_class($subclass)) {
+            bless $self, $subclass unless $self->isa($subclass);
+            $self->_rebless;
+        }
     }
 
     # Set up the default quoting character and name seperators
-    $self->{_quoter} = $self->_build_quoter;
+    $self->{_quoter}  = $self->_build_quoter;
     $self->{_namesep} = $self->_build_namesep;
+
     # For our usage as regex matches, concatenating multiple quoter
     # values works fine (e.g. s/\Q<>\E// if quoter was [ '<', '>' ])
     if( ref $self->{_quoter} eq 'ARRAY') {
@@ -83,23 +96,58 @@ sub _rebless { }
 
 # Returns an array of table names
 sub _tables_list { 
-    my $self = shift;
+    my ($self, $opts) = (shift, shift);
 
     my ($table, $type) = @_ ? @_ : ('%', '%');
 
     my $dbh = $self->schema->storage->dbh;
     my @tables = $dbh->tables(undef, $self->db_schema, $table, $type);
 
-    my $qt = qr/\Q$self->{_quoter}\E/;
+    my $qt = qr/[\Q$self->{_quoter}\E"'`\[\]]/;
+
+    my $all_tables_quoted = (grep /$qt/, @tables) == @tables;
 
-    if ($self->{_quoter} && $tables[0] =~ /$qt/) {
+    if ($self->{_quoter} && $all_tables_quoted) {
         s/.* $qt (?= .* $qt)//xg for @tables;
     } else {
         s/^.*\Q$self->{_namesep}\E// for @tables;
     }
     s/$qt//g for @tables;
 
-    return @tables;
+    return $self->_filter_tables(\@tables, $opts);
+}
+
+# apply constraint/exclude and ignore bad tables and views
+sub _filter_tables {
+    my ($self, $tables, $opts) = @_;
+
+    my @tables = @$tables;
+    my @filtered_tables;
+
+    $opts ||= {};
+    my $constraint   = $opts->{constraint};
+    my $exclude      = $opts->{exclude};
+
+    @tables = grep { /$constraint/ } @$tables if defined $constraint;
+    @tables = grep { ! /$exclude/  } @$tables if defined $exclude;
+
+    LOOP: for my $table (@tables) {
+        try {
+            local $^W = 0; # for ADO
+            my $sth = $self->_sth_for($table, undef, \'1 = 0');
+            $sth->execute;
+        }
+        catch {
+            warn "Bad table or view '$table', ignoring: $_\n";
+            $self->_unregister_source_for_table($table);
+            no warnings 'exiting';
+            next LOOP;
+        };
+
+        push @filtered_tables, $table;
+    }
+
+    return @filtered_tables;
 }
 
 =head2 load
@@ -116,34 +164,37 @@ sub load {
     $self->next::method(@_);
 }
 
-sub _quote_table_name {
+sub _table_as_sql {
     my ($self, $table) = @_;
 
-    my $qt = $self->schema->storage->sql_maker->quote_char;
-
-    if (ref $qt) {
-        return $qt->[0] . $table . $qt->[1];
+    if($self->{db_schema}) {
+        $table = $self->{db_schema} . $self->{_namesep} .
+            $self->_quote_table_name($table);
+    } else {
+        $table = $self->_quote_table_name($table);
     }
 
-    return $qt . $table . $qt;
+    return $table;
 }
 
-# Returns an arrayref of column names
-sub _table_columns {
-    my ($self, $table) = @_;
+sub _sth_for {
+    my ($self, $table, $fields, $where) = @_;
 
     my $dbh = $self->schema->storage->dbh;
 
-    if($self->{db_schema}) {
-        $table = $self->{db_schema} . $self->{_namesep} .
-            $self->_quote_table_name($table);
-    } else {
-        $table = $self->_quote_table_name($table);
-    }
+    my $sth = $dbh->prepare($self->schema->storage->sql_maker
+        ->select(\$self->_table_as_sql($table), $fields, $where));
 
-    my $sth = $dbh->prepare($self->schema->storage->sql_maker->select(\$table, undef, \'1 = 0'));
+    return $sth;
+}
+
+# Returns an arrayref of column names
+sub _table_columns {
+    my ($self, $table) = @_;
+
+    my $sth = $self->_sth_for($table, undef, \'1 = 0');
     $sth->execute;
-    my $retval = \@{$sth->{NAME_lc}};
+    my $retval = $self->preserve_case ? \@{$sth->{NAME}} : \@{$sth->{NAME_lc}};
     $sth->finish;
 
     $retval;
@@ -153,9 +204,22 @@ sub _table_columns {
 sub _table_pk_info { 
     my ($self, $table) = @_;
 
+    return [] if $self->_disable_pk_detection;
+
     my $dbh = $self->schema->storage->dbh;
 
-    my @primary = map { lc } $dbh->primary_key('', $self->db_schema, $table);
+    my @primary = try {
+        $dbh->primary_key('', $self->db_schema, $table);
+    }
+    catch {
+        warn "Cannot find primary keys for this driver: $_";
+        $self->_disable_pk_detection(1);
+        return ();
+    };
+
+    return [] if not @primary;
+
+    @primary = map { $self->_lc($_) } @primary;
     s/\Q$self->{_quoter}\E//g for @primary;
 
     return \@primary;
@@ -165,9 +229,13 @@ sub _table_pk_info {
 sub _table_uniq_info {
     my ($self, $table) = @_;
 
+    return [] if $self->_disable_uniq_detection;
+
     my $dbh = $self->schema->storage->dbh;
-    if(!$dbh->can('statistics_info')) {
-        warn "No UNIQUE constraint information can be gathered for this vendor";
+
+    if (not $dbh->can('statistics_info')) {
+        warn "No UNIQUE constraint information can be gathered for this driver";
+        $self->_disable_uniq_detection(1);
         return [];
     }
 
@@ -182,17 +250,14 @@ sub _table_uniq_info {
             || !defined $row->{ORDINAL_POSITION}
             || !$row->{COLUMN_NAME};
 
-        $indices{$row->{INDEX_NAME}}->{$row->{ORDINAL_POSITION}} = $row->{COLUMN_NAME};
+        $indices{$row->{INDEX_NAME}}[$row->{ORDINAL_POSITION}] = $self->_lc($row->{COLUMN_NAME});
     }
     $sth->finish;
 
     my @retval;
     foreach my $index_name (keys %indices) {
         my $index = $indices{$index_name};
-        push(@retval, [ $index_name => [
-            map { $index->{$_} }
-                sort keys %$index
-        ]]);
+        push(@retval, [ $index_name => [ @$index[1..$#$index] ] ]);
     }
 
     return \@retval;
@@ -202,9 +267,19 @@ sub _table_uniq_info {
 sub _table_fk_info {
     my ($self, $table) = @_;
 
+    return [] if $self->_disable_fk_detection;
+
     my $dbh = $self->schema->storage->dbh;
-    my $sth = $dbh->foreign_key_info( '', $self->db_schema, '',
-                                      '', $self->db_schema, $table );
+    my $sth = try {
+        $dbh->foreign_key_info( '', $self->db_schema, '',
+                                '', $self->db_schema, $table );
+    }
+    catch {
+        warn "Cannot introspect relationships for this driver: $_";
+        $self->_disable_fk_detection(1);
+        return undef;
+    };
+
     return [] if !$sth;
 
     my %rels;
@@ -212,15 +287,15 @@ sub _table_fk_info {
     my $i = 1; # for unnamed rels, which hopefully have only 1 column ...
     while(my $raw_rel = $sth->fetchrow_arrayref) {
         my $uk_tbl  = $raw_rel->[2];
-        my $uk_col  = lc $raw_rel->[3];
-        my $fk_col  = lc $raw_rel->[7];
+        my $uk_col  = $self->_lc($raw_rel->[3]);
+        my $fk_col  = $self->_lc($raw_rel->[7]);
         my $relid   = ($raw_rel->[11] || ( "__dcsld__" . $i++ ));
         $uk_tbl =~ s/\Q$self->{_quoter}\E//g;
         $uk_col =~ s/\Q$self->{_quoter}\E//g;
         $fk_col =~ s/\Q$self->{_quoter}\E//g;
         $relid  =~ s/\Q$self->{_quoter}\E//g;
         $rels{$relid}->{tbl} = $uk_tbl;
-        $rels{$relid}->{cols}->{$uk_col} = $fk_col;
+        $rels{$relid}->{cols}{$uk_col} = $fk_col;
     }
     $sth->finish;
 
@@ -242,49 +317,71 @@ sub _columns_info_for {
 
     my $dbh = $self->schema->storage->dbh;
 
+    my %result;
+
     if ($dbh->can('column_info')) {
-        my %result;
-        eval {
-            my $sth = $dbh->column_info( undef, $self->db_schema, $table, '%' );
-            while ( my $info = $sth->fetchrow_hashref() ){
-                my %column_info;
-                $column_info{data_type}   = $info->{TYPE_NAME};
-                $column_info{size}      = $info->{COLUMN_SIZE};
-                $column_info{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
-                $column_info{default_value} = $info->{COLUMN_DEF};
-                my $col_name = $info->{COLUMN_NAME};
-                $col_name =~ s/^\"(.*)\"$/$1/;
-
-                my $extra_info = $self->_extra_column_info($info) || {};
-
-                $result{$col_name} = { %column_info, %$extra_info };
+        my $sth = $self->_dbh_column_info($dbh, undef, $self->db_schema, $table, '%' );
+        while ( my $info = $sth->fetchrow_hashref() ){
+            my $column_info = {};
+            $column_info->{data_type}     = lc $info->{TYPE_NAME};
+
+            my $size = $info->{COLUMN_SIZE};
+
+            if (defined $size && defined $info->{DECIMAL_DIGITS}) {
+                $column_info->{size} = [$size, $info->{DECIMAL_DIGITS}];
             }
-            $sth->finish;
-        };
-      return \%result if !$@ && scalar keys %result;
-    }
+            elsif (defined $size) {
+                $column_info->{size} = $size;
+            }
+
+            $column_info->{is_nullable}   = $info->{NULLABLE} ? 1 : 0;
+            $column_info->{default_value} = $info->{COLUMN_DEF} if defined $info->{COLUMN_DEF};
+            my $col_name = $info->{COLUMN_NAME};
+            $col_name =~ s/^\"(.*)\"$/$1/;
+
+            $col_name = $self->_lc($col_name);
+
+            my $extra_info = $self->_extra_column_info(
+                $table, $col_name, $column_info, $info
+            ) || {};
+            $column_info = { %$column_info, %$extra_info };
+
+            $result{$col_name} = $column_info;
+        }
+        $sth->finish;
 
-    if($self->db_schema) {
-        $table = $self->db_schema . $self->{_namesep} . $table;
+        return \%result if %result;
     }
-    my %result;
-    my $sth = $dbh->prepare($self->schema->storage->sql_maker->select($table, undef, \'1 = 0'));
+
+    my $sth = $self->_sth_for($table, undef, \'1 = 0');
     $sth->execute;
-    my @columns = @{$sth->{NAME_lc}};
-    for my $i ( 0 .. $#columns ){
-        my %column_info;
-        $column_info{data_type} = $sth->{TYPE}->[$i];
-        $column_info{size} = $sth->{PRECISION}->[$i];
-        $column_info{is_nullable} = $sth->{NULLABLE}->[$i] ? 1 : 0;
-
-        if ($column_info{data_type} =~ m/^(.*?)\((.*?)\)$/) {
-            $column_info{data_type} = $1;
-            $column_info{size}    = $2;
+
+    my @columns = @{ $sth->{NAME} };
+
+    for my $i (0 .. $#columns) {
+        my $column_info = {};
+        $column_info->{data_type} = lc $sth->{TYPE}[$i];
+
+        my $size = $sth->{PRECISION}[$i];
+
+        if (defined $size && defined $sth->{SCALE}[$i]) {
+            $column_info->{size} = [$size, $sth->{SCALE}[$i]];
+        }
+        elsif (defined $size) {
+            $column_info->{size} = $size;
+        }
+
+        $column_info->{is_nullable} = $sth->{NULLABLE}[$i] ? 1 : 0;
+
+        if ($column_info->{data_type} =~ m/^(.*?)\((.*?)\)$/) {
+            $column_info->{data_type} = $1;
+            $column_info->{size}    = $2;
         }
 
-        my $extra_info = $self->_extra_column_info($table, $columns[$i], $sth, $i) || {};
+        my $extra_info = $self->_extra_column_info($table, $columns[$i], $column_info) || {};
+        $column_info = { %$column_info, %$extra_info };
 
-        $result{$columns[$i]} = { %column_info, %$extra_info };
+        $result{ $self->_lc($columns[$i]) } = $column_info;
     }
     $sth->finish;
 
@@ -292,24 +389,62 @@ sub _columns_info_for {
         my $colinfo = $result{$col};
         my $type_num = $colinfo->{data_type};
         my $type_name;
-        if(defined $type_num && $dbh->can('type_info')) {
-            my $type_info = $dbh->type_info($type_num);
+        if (defined $type_num && $type_num =~ /^-?\d+\z/ && $dbh->can('type_info')) {
+            my $type_info = do {
+                # for buggy Firebird ODBC driver
+                local $dbh->{LongReadLen} = 100_000;
+                local $dbh->{LongTruncOk} = 1;
+                $dbh->type_info($type_num);
+            };
             $type_name = $type_info->{TYPE_NAME} if $type_info;
-            $colinfo->{data_type} = $type_name if $type_name;
+            $colinfo->{data_type} = lc $type_name if $type_name;
         }
     }
 
     return \%result;
 }
 
-# Override this in vendor class to return any additional column
-# attributes
+# do not use this, override _columns_info_for instead
 sub _extra_column_info {}
 
+# override to mask warnings if needed (see mysql)
+sub _dbh_column_info {
+    my ($self, $dbh) = (shift, shift);
+
+    return $dbh->column_info(@_);
+}
+
+# If a coderef uses DBI->connect, this should get its connect info.
+sub _try_infer_connect_info_from_coderef {
+    my ($self, $code) = @_;
+
+    my ($dsn, $user, $pass, $params);
+
+    no warnings 'redefine';
+
+    local *DBI::connect = sub {
+        (undef, $dsn, $user, $pass, $params) = @_;
+    };
+
+    $code->();
+
+    return ($dsn, $user, $pass, $params);
+}
+
 =head1 SEE ALSO
 
 L<DBIx::Class::Schema::Loader>
 
+=head1 AUTHOR
+
+See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>.
+
+=head1 LICENSE
+
+This library is free software; you can redistribute it and/or modify it under
+the same terms as Perl itself.
+
 =cut
 
 1;
+# vim:et sts=4 sw=4 tw=0: