X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSQLMaker.pm;h=791e4fc4782ca5e683c3cadf4b221f77161a32a8;hb=1efc866d8235ddd640d956352d59036a1cd3bbd7;hp=f041ce69d72b4dd26202d372661cfc90f66fe436;hpb=e5372da42c1bb393cd2aadde5765a09d64428581;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/SQLMaker.pm b/lib/DBIx/Class/SQLMaker.pm index f041ce6..791e4fc 100644 --- a/lib/DBIx/Class/SQLMaker.pm +++ b/lib/DBIx/Class/SQLMaker.pm @@ -1,5 +1,8 @@ package DBIx::Class::SQLMaker; +use strict; +use warnings; + =head1 NAME DBIx::Class::SQLMaker - An SQL::Abstract-based SQL maker class @@ -31,61 +34,100 @@ Currently the enhancements to L are: use base qw/ DBIx::Class::SQLMaker::LimitDialects SQL::Abstract - Class::Accessor::Grouped + DBIx::Class /; use mro 'c3'; -use strict; -use warnings; + use Sub::Name 'subname'; -use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/; +use DBIx::Class::Carp; use namespace::clean; __PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/); +sub _quoting_enabled { + ( defined $_[0]->{quote_char} and length $_[0]->{quote_char} ) ? 1 : 0 +} + +# for when I need a normalized l/r pair +sub _quote_chars { + + # in case we are called in the old !!$sm->_quote_chars fashion + return () if !wantarray and ( ! defined $_[0]->{quote_char} or ! length $_[0]->{quote_char} ); + + map + { defined $_ ? $_ : '' } + ( ref $_[0]->{quote_char} ? (@{$_[0]->{quote_char}}) : ( ($_[0]->{quote_char}) x 2 ) ) + ; +} + +# FIXME when we bring in the storage weaklink, check its schema +# weaklink and channel through $schema->throw_exception +sub throw_exception { DBIx::Class::Exception->throw($_[1]) } + BEGIN { - # reinstall the carp()/croak() functions imported into SQL::Abstract - # as Carp and Carp::Clan do not like each other much + # reinstall the belch()/puke() functions of SQL::Abstract with custom versions + # that use DBIx::Class::Carp/DBIx::Class::Exception instead of plain Carp no warnings qw/redefine/; - no strict qw/refs/; - for my $f (qw/carp croak/) { - - my $orig = \&{"SQL::Abstract::$f"}; - my $clan_import = \&{$f}; - *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" => - sub { - if (Carp::longmess() =~ /DBIx::Class::SQLMaker::[\w]+ .+? called \s at/x) { - $clan_import->(@_); - } - else { - goto $orig; - } - }; - } + + *SQL::Abstract::belch = subname 'SQL::Abstract::belch' => sub (@) { + my($func) = (caller(1))[3]; + carp "[$func] Warning: ", @_; + }; + + *SQL::Abstract::puke = subname 'SQL::Abstract::puke' => sub (@) { + my($func) = (caller(1))[3]; + __PACKAGE__->throw_exception("[$func] Fatal: " . join ('', @_)); + }; } # the "oh noes offset/top without limit" constant -# limited to 32 bits for sanity (and consistency, -# since it is ultimately handed to sprintf %u) +# limited to 31 bits for sanity (and consistency, +# since it may be handed to the like of sprintf %u) +# +# Also *some* builds of SQLite fail the test +# some_column BETWEEN ? AND ?: 1, 4294967295 +# with the proper integer bind attrs +# # Implemented as a method, since ::Storage::DBI also # refers to it (i.e. for the case of software_limit or # as the value to abuse with MSSQL ordered subqueries) -sub __max_int { 0xFFFFFFFF }; +sub __max_int () { 0x7FFFFFFF }; + +# we ne longer need to check this - DBIC has ways of dealing with it +# specifically ::Storage::DBI::_resolve_bindattrs() +sub _assert_bindval_matches_bindtype () { 1 }; + +# poor man's de-qualifier +sub _quote { + $_[0]->next::method( ( $_[0]{_dequalify_idents} and ! ref $_[1] ) + ? $_[1] =~ / ([^\.]+) $ /x + : $_[1] + ); +} + +sub _where_op_NEST { + carp_unique ("-nest in search conditions is deprecated, you most probably wanted:\n" + .q|{..., -and => [ \%cond0, \@cond1, \'cond2', \[ 'cond3', [ col => bind ] ], etc. ], ... }| + ); + + shift->next::method(@_); +} # Handle limit-dialect selection sub select { my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_; - $fields = $self->_recurse_fields($fields); + ($fields, @{$self->{select_bind}}) = $self->_recurse_fields($fields); if (defined $offset) { - croak ('A supplied offset must be a non-negative integer') + $self->throw_exception('A supplied offset must be a non-negative integer') if ( $offset =~ /\D/ or $offset < 0 ); } $offset ||= 0; if (defined $limit) { - croak ('A supplied limit must be a positive integer') + $self->throw_exception('A supplied limit must be a positive integer') if ( $limit =~ /\D/ or $limit <= 0 ); } elsif ($offset) { @@ -99,18 +141,32 @@ sub select { ($sql, @bind) = $self->next::method ($table, $fields, $where); - my $limiter = - $self->can ('emulate_limit') # also backcompat hook from SQLA::Limit - || - do { - my $dialect = $self->limit_dialect - or croak "Unable to generate SQL-limit - no limit dialect specified on $self, and no emulate_limit method found"; - $self->can ("_$dialect") - or croak (__PACKAGE__ . " does not implement the requested dialect '$dialect'"); - } - ; + my $limiter; - $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset); + if( $limiter = $self->can ('emulate_limit') ) { + carp_unique( + 'Support for the legacy emulate_limit() mechanism inherited from ' + . 'SQL::Abstract::Limit has been deprecated, and will be removed when ' + . 'DBIC transitions to Data::Query. If your code uses this type of ' + . 'limit specification please file an RT and provide the source of ' + . 'your emulate_limit() implementation, so an acceptable upgrade-path ' + . 'can be devised' + ); + } + else { + my $dialect = $self->limit_dialect + or $self->throw_exception( "Unable to generate SQL-limit - no limit dialect specified on $self" ); + + $limiter = $self->can ("_$dialect") + or $self->throw_exception(__PACKAGE__ . " does not implement the requested dialect '$dialect'"); + } + + $sql = $self->$limiter ( + $sql, + { %{$rs_attrs||{}}, _selector_sql => $fields }, + $limit, + $offset + ); } else { ($sql, @bind) = $self->next::method ($table, $fields, $where, $rs_attrs); @@ -129,7 +185,7 @@ sub select { sub _assemble_binds { my $self = shift; - return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/from where having order/); + return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/pre_select select from where group having order limit/); } my $for_syntax = { @@ -138,7 +194,15 @@ my $for_syntax = { }; sub _lock_select { my ($self, $type) = @_; - my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested"; + + my $sql; + if (ref($type) eq 'SCALAR') { + $sql = "FOR $$type"; + } + else { + $sql = $for_syntax->{$type} || $self->throw_exception( "Unknown SELECT .. FOR type '$type' requested" ); + } + return " $sql"; } @@ -151,13 +215,18 @@ sub insert { # which is sadly understood only by MySQL. Change default behavior here, # until SQLA2 comes with proper dialect support if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) { - my $sql = "INSERT INTO $_[1] DEFAULT VALUES"; + my @bind; + my $sql = sprintf( + 'INSERT INTO %s DEFAULT VALUES', $_[0]->_quote($_[1]) + ); - if (my $ret = ($_[3]||{})->{returning} ) { - $sql .= $_[0]->_insert_returning ($ret); + if ( ($_[3]||{})->{returning} ) { + my $s; + ($s, @bind) = $_[0]->_insert_returning ($_[3]); + $sql .= $s; } - return $sql; + return ($sql, @bind); } next::method(@_); @@ -170,44 +239,50 @@ sub _recurse_fields { return $$fields if $ref eq 'SCALAR'; if ($ref eq 'ARRAY') { - return join(', ', map { $self->_recurse_fields($_) } @$fields); + my (@select, @bind); + for my $field (@$fields) { + my ($select, @new_bind) = $self->_recurse_fields($field); + push @select, $select; + push @bind, @new_bind; + } + return (join(', ', @select), @bind); } elsif ($ref eq 'HASH') { my %hash = %$fields; # shallow copy my $as = delete $hash{-as}; # if supplied - my ($func, $args, @toomany) = %hash; + my ($func, $rhs, @toomany) = %hash; # there should be only one pair if (@toomany) { - croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields ); + $self->throw_exception( "Malformed select argument - too many keys in hash: " . join (',', keys %$fields ) ); } - if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) { - croak ( + if (lc ($func) eq 'distinct' && ref $rhs eq 'ARRAY' && @$rhs > 1) { + $self->throw_exception ( 'The select => { distinct => ... } syntax is not supported for multiple columns.' - .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }' - .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }' + .' Instead please use { group_by => [ qw/' . (join ' ', @$rhs) . '/ ] }' + .' or { select => [ qw/' . (join ' ', @$rhs) . '/ ], distinct => 1 }' ); } + my ($rhs_sql, @rhs_bind) = $self->_recurse_fields($rhs); my $select = sprintf ('%s( %s )%s', $self->_sqlcase($func), - $self->_recurse_fields($args), + $rhs_sql, $as ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) ) : '' ); - return $select; + return ($select, @rhs_bind); } - # Is the second check absolutely necessary? elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) { - return $self->_fold_sqlbind( $fields ); + return @{$$fields}; } else { - croak($ref . qq{ unexpected in _recurse_fields()}) + $self->throw_exception( $ref . qq{ unexpected in _recurse_fields()} ); } } @@ -216,7 +291,7 @@ sub _recurse_fields { # What we have been doing forever is hijacking the $order arg of # SQLA::select to pass in arbitrary pieces of data (first the group_by, # then pretty much the entire resultset attr-hash, as more and more -# things in the SQLA space need to have mopre info about the $rs they +# things in the SQLA space need to have more info about the $rs they # create SQL for. The alternative would be to keep expanding the # signature of _select with more and more positional parameters, which # is just gross. All hail SQLA2! @@ -225,8 +300,11 @@ sub _parse_rs_attrs { my $sql = ''; - if (my $g = $self->_recurse_fields($arg->{group_by}) ) { - $sql .= $self->_sqlcase(' group by ') . $g; + if ($arg->{group_by}) { + if ( my ($group_sql, @group_bind) = $self->_recurse_fields($arg->{group_by}) ) { + $sql .= $self->_sqlcase(' group by ') . $group_sql; + push @{$self->{group_bind}}, @group_bind; + } } if (defined $arg->{having}) { @@ -256,6 +334,18 @@ sub _order_by { } } +sub _split_order_chunk { + my ($self, $chunk) = @_; + + # strip off sort modifiers, but always succeed, so $1 gets reset + $chunk =~ s/ (?: \s+ (ASC|DESC) )? \s* $//ix; + + return ( + $chunk, + ( $1 and uc($1) eq 'DESC' ) ? 1 : 0, + ); +} + sub _table { # optimized due to hotttnesss # my ($self, $from) = @_; @@ -264,28 +354,40 @@ sub _table { return $_[0]->_recurse_from(@{$_[1]}); } elsif ($ref eq 'HASH') { - return $_[0]->_make_as($_[1]); + return $_[0]->_recurse_from($_[1]); + } + elsif ($ref eq 'REF' && ref ${$_[1]} eq 'ARRAY') { + my ($sql, @bind) = @{ ${$_[1]} }; + push @{$_[0]->{from_bind}}, @bind; + return $sql } } - return $_[0]->next::method ($_[1]); } sub _generate_join_clause { my ($self, $join_type) = @_; + $join_type = $self->{_default_jointype} + if ! defined $join_type; + return sprintf ('%s JOIN ', - $join_type ? ' ' . uc($join_type) : '' + $join_type ? $self->_sqlcase($join_type) : '' ); } sub _recurse_from { - my ($self, $from, @join) = @_; - my @sqlf; - push(@sqlf, $self->_make_as($from)); - foreach my $j (@join) { - my ($to, $on) = @$j; + my $self = shift; + return join (' ', $self->_gen_from_blocks(@_) ); +} + +sub _gen_from_blocks { + my ($self, $from, @joins) = @_; + my @fchunks = $self->_from_chunk_to_sql($from); + + for (@joins) { + my ($to, $on) = @$_; # check whether a join type exists my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to; @@ -295,67 +397,140 @@ sub _recurse_from { $join_type =~ s/^\s+ | \s+$//xg; } - $join_type = $self->{_default_jointype} if not defined $join_type; - - push @sqlf, $self->_generate_join_clause( $join_type ); + my @j = $self->_generate_join_clause( $join_type ); if (ref $to eq 'ARRAY') { - push(@sqlf, '(', $self->_recurse_from(@$to), ')'); - } else { - push(@sqlf, $self->_make_as($to)); + push(@j, '(', $self->_recurse_from(@$to), ')'); + } + else { + push(@j, $self->_from_chunk_to_sql($to)); } - push(@sqlf, ' ON ', $self->_join_condition($on)); - } - return join('', @sqlf); -} -sub _fold_sqlbind { - my ($self, $sqlbind) = @_; + my ($sql, @bind) = $self->_join_condition($on); + push(@j, ' ON ', $sql); + push @{$self->{from_bind}}, @bind; - my @sqlbind = @$$sqlbind; # copy - my $sql = shift @sqlbind; - push @{$self->{from_bind}}, @sqlbind; + push @fchunks, join '', @j; + } - return $sql; + return @fchunks; } -sub _make_as { - my ($self, $from) = @_; - return join(' ', map { (ref $_ eq 'SCALAR' ? $$_ - : ref $_ eq 'REF' ? $self->_fold_sqlbind($_) - : $self->_quote($_)) - } reverse each %{$self->_skip_options($from)}); -} +sub _from_chunk_to_sql { + my ($self, $fromspec) = @_; + + return join (' ', do { + if (! ref $fromspec) { + $self->_quote($fromspec); + } + elsif (ref $fromspec eq 'SCALAR') { + $$fromspec; + } + elsif (ref $fromspec eq 'REF' and ref $$fromspec eq 'ARRAY') { + push @{$self->{from_bind}}, @{$$fromspec}[1..$#$$fromspec]; + $$fromspec->[0]; + } + elsif (ref $fromspec eq 'HASH') { + my ($as, $table, $toomuch) = ( map + { $_ => $fromspec->{$_} } + ( grep { $_ !~ /^\-/ } keys %$fromspec ) + ); -sub _skip_options { - my ($self, $hash) = @_; - my $clean_hash = {}; - $clean_hash->{$_} = $hash->{$_} - for grep {!/^-/} keys %$hash; - return $clean_hash; + $self->throw_exception( "Only one table/as pair expected in from-spec but an exra '$toomuch' key present" ) + if defined $toomuch; + + ($self->_from_chunk_to_sql($table), $self->_quote($as) ); + } + else { + $self->throw_exception('Unsupported from refkind: ' . ref $fromspec ); + } + }); } sub _join_condition { my ($self, $cond) = @_; - if (ref $cond eq 'HASH') { - my %j; - for (keys %$cond) { - my $v = $cond->{$_}; - if (ref $v) { - croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'}) - if ref($v) ne 'SCALAR'; - $j{$_} = $v; + + # Backcompat for the old days when a plain hashref + # { 't1.col1' => 't2.col2' } meant ON t1.col1 = t2.col2 + if ( + ref $cond eq 'HASH' + and + keys %$cond == 1 + and + (keys %$cond)[0] =~ /\./ + and + ! ref ( (values %$cond)[0] ) + ) { + carp_unique( + "ResultSet {from} structures with conditions not conforming to the " + . "SQL::Abstract syntax are deprecated: you either need to stop abusing " + . "{from} altogether, or express the condition properly using the " + . "{ -ident => ... } operator" + ); + $cond = { keys %$cond => { -ident => values %$cond } } + } + elsif ( ref $cond eq 'ARRAY' ) { + # do our own ORing so that the hashref-shim above is invoked + my @parts; + my @binds; + foreach my $c (@$cond) { + my ($sql, @bind) = $self->_join_condition($c); + push @binds, @bind; + push @parts, $sql; + } + return join(' OR ', @parts), @binds; + } + + return $self->_recurse_where($cond); +} + +# This is hideously ugly, but SQLA does not understand multicol IN expressions +# FIXME TEMPORARY - DQ should have native syntax for this +# moved here to raise API questions +# +# !!! EXPERIMENTAL API !!! WILL CHANGE !!! +sub _where_op_multicolumn_in { + my ($self, $lhs, $rhs) = @_; + + if (! ref $lhs or ref $lhs eq 'ARRAY') { + my (@sql, @bind); + for (ref $lhs ? @$lhs : $lhs) { + if (! ref $_) { + push @sql, $self->_quote($_); + } + elsif (ref $_ eq 'SCALAR') { + push @sql, $$_; + } + elsif (ref $_ eq 'REF' and ref $$_ eq 'ARRAY') { + my ($s, @b) = @$$_; + push @sql, $s; + push @bind, @b; } else { - my $x = '= '.$self->_quote($v); $j{$_} = \$x; + $self->throw_exception("ARRAY of @{[ ref $_ ]}es unsupported for multicolumn IN lhs..."); } - }; - return scalar($self->_recurse_where(\%j)); - } elsif (ref $cond eq 'ARRAY') { - return join(' OR ', map { $self->_join_condition($_) } @$cond); - } else { - croak "Can't handle this yet!"; + } + $lhs = \[ join(', ', @sql), @bind]; + } + elsif (ref $lhs eq 'SCALAR') { + $lhs = \[ $$lhs ]; + } + elsif (ref $lhs eq 'REF' and ref $$lhs eq 'ARRAY' ) { + # noop + } + else { + $self->throw_exception( ref($lhs) . "es unsupported for multicolumn IN lhs..."); } + + # is this proper...? + $rhs = \[ $self->_recurse_where($rhs) ]; + + for ($lhs, $rhs) { + $$_->[0] = "( $$_->[0] )" + unless $$_->[0] =~ /^ \s* \( .* \) \s* $/xs; + } + + \[ join( ' IN ', shift @$$lhs, shift @$$rhs ), @$$lhs, @$$rhs ]; } 1;