X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSQLMaker.pm;h=66b6c735de4f4af692ff06bac16c509a6b7ea0c5;hb=2bb4c37b6a5f36d851c4a8ee6f5791e179491fd0;hp=f43aa0b0abb19719d595b8ffcd6c0560ecbbacc3;hpb=3f5b99fea8b445c7a61057f4210a715ffb8e677e;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/SQLMaker.pm b/lib/DBIx/Class/SQLMaker.pm index f43aa0b..66b6c73 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 @@ -24,6 +27,10 @@ Currently the enhancements to L are: =item * Support of C<...FOR UPDATE> type of select statement modifiers +=item * The L operator + +=item * The L operator + =back =cut @@ -31,13 +38,13 @@ 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 DBIx::Class::Exception; use namespace::clean; __PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/); @@ -50,34 +57,114 @@ sub _quote_chars { ; } +# 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) { - goto $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 ('', @_)); + }; + + # Current SQLA pollutes its namespace - clean for the time being + namespace::clean->clean_subroutines(qw/SQL::Abstract carp croak confess/); } # 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 }; + +# poor man's de-qualifier +sub _quote { + $_[0]->next::method( ( $_[0]{_dequalify_idents} and ! ref $_[1] ) + ? $_[1] =~ / ([^\.]+) $ /x + : $_[1] + ); +} + +sub new { + my $self = shift->next::method(@_); + + # use the same coderefs, they are prepared to handle both cases + my @extra_dbic_syntax = ( + { regex => qr/^ ident $/xi, handler => '_where_op_IDENT' }, + { regex => qr/^ value $/xi, handler => '_where_op_VALUE' }, + ); + + push @{$self->{special_ops}}, @extra_dbic_syntax; + push @{$self->{unary_ops}}, @extra_dbic_syntax; + + $self; +} + +sub _where_op_IDENT { + my $self = shift; + my ($op, $rhs) = splice @_, -2; + if (ref $rhs) { + $self->throw_exception("-$op takes a single scalar argument (a quotable identifier)"); + } + + # in case we are called as a top level special op (no '=') + my $lhs = shift; + + $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs); + + return $lhs + ? "$lhs = $rhs" + : $rhs + ; +} + +sub _where_op_VALUE { + my $self = shift; + my ($op, $rhs) = splice @_, -2; + + # in case we are called as a top level special op (no '=') + my $lhs = shift; + + my @bind = [ + ($lhs || $self->{_nested_func_lhs} || $self->throw_exception("Unable to find bindtype for -value $rhs") ), + $rhs + ]; + + return $lhs + ? ( + $self->_convert($self->_quote($lhs)) . ' = ' . $self->_convert('?'), + @bind + ) + : ( + $self->_convert('?'), + @bind, + ) + ; +} + +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 { @@ -87,13 +174,13 @@ sub select { $fields = $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) { @@ -112,9 +199,9 @@ sub select { || 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"; + or $self->throw_exception( "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'"); + or $self->throw_exception(__PACKAGE__ . " does not implement the requested dialect '$dialect'"); } ; @@ -137,7 +224,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/select from where group having order limit/); } my $for_syntax = { @@ -146,7 +233,7 @@ my $for_syntax = { }; sub _lock_select { my ($self, $type) = @_; - my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested"; + my $sql = $for_syntax->{$type} || $self->throw_exception( "Unknown SELECT .. FOR type '$type' requested" ); return " $sql"; } @@ -159,13 +246,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(@_); @@ -189,11 +281,11 @@ sub _recurse_fields { # 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 ( + $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 }' @@ -212,10 +304,11 @@ sub _recurse_fields { } # Is the second check absolutely necessary? elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) { - return $self->_fold_sqlbind( $fields ); + push @{$self->{select_bind}}, @{$$fields}[1..$#$$fields]; + return $$fields->[0]; } else { - croak($ref . qq{ unexpected in _recurse_fields()}) + $self->throw_exception( $ref . qq{ unexpected in _recurse_fields()} ); } } @@ -233,8 +326,13 @@ 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}) { + # horible horrible, waiting for refactor + local $self->{select_bind}; + if (my $g = $self->_recurse_fields($arg->{group_by}) ) { + $sql .= $self->_sqlcase(' group by ') . $g; + push @{$self->{group_bind} ||= []}, @{$self->{select_bind}||[]}; + } } if (defined $arg->{having}) { @@ -272,28 +370,41 @@ 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; @@ -303,71 +414,123 @@ 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 (' ', $self->_SWITCH_refkind($fromspec, { + SCALARREF => sub { + $$fromspec; + }, + ARRAYREFREF => sub { + push @{$self->{from_bind}}, @{$$fromspec}[1..$#$$fromspec]; + $$fromspec->[0]; + }, + HASHREF => sub { + 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) ); + }, + SCALAR => sub { + $self->_quote($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; - } - else { - my $x = '= '.$self->_quote($v); $j{$_} = \$x; - } - }; - 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!"; + + # Backcompat for the old days when a plain hashref + # { 't1.col1' => 't2.col2' } meant ON t1.col1 = t2.col2 + # Once things settle we should start warning here so that + # folks unroll their hacks + if ( + ref $cond eq 'HASH' + and + keys %$cond == 1 + and + (keys %$cond)[0] =~ /\./ + and + ! ref ( (values %$cond)[0] ) + ) { + $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); } 1; +=head1 OPERATORS + +=head2 -ident + +Used to explicitly specify an SQL identifier. Takes a plain string as value +which is then invariably treated as a column name (and is being properly +quoted if quoting has been requested). Most useful for comparison of two +columns: + + my %where = ( + priority => { '<', 2 }, + requestor => { -ident => 'submitter' } + ); + +which results in: + + $stmt = 'WHERE "priority" < ? AND "requestor" = "submitter"'; + @bind = ('2'); + +=head2 -value + +The -value operator signals that the argument to the right is a raw bind value. +It will be passed straight to DBI, without invoking any of the SQL::Abstract +condition-parsing logic. This allows you to, for example, pass an array as a +column value for databases that support array datatypes, e.g.: + + my %where = ( + array => { -value => [1, 2, 3] } + ); + +which results in: + + $stmt = 'WHERE array = ?'; + @bind = ([1, 2, 3]); + =head1 AUTHORS See L.