X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FAbstract.pm;h=23a9dd692d75161c711db4b841f05264beed012f;hb=24cd952533bd92329da95784347da9754b870533;hp=3b7d65b1fda5e4af0a5d0e9d5f59881d239793b0;hpb=105cbaea841d055fdf1b2df8aabdf5d38676a0d8;p=scpubgit%2FQ-Branch.git diff --git a/lib/SQL/Abstract.pm b/lib/SQL/Abstract.pm index 3b7d65b..23a9dd6 100644 --- a/lib/SQL/Abstract.pm +++ b/lib/SQL/Abstract.pm @@ -38,7 +38,6 @@ our $AUTOLOAD; # See section WHERE: BUILTIN SPECIAL OPERATORS below for implementation my @BUILTIN_SPECIAL_OPS = ( {regex => qr/^ (?: not \s )? between $/ix, handler => sub { die "NOPE" }}, - {regex => qr/^ (?: not \s )? in $/ix, handler => sub { die "NOPE" }}, {regex => qr/^ is (?: \s+ not )? $/ix, handler => sub { die "NOPE" }}, ); @@ -68,6 +67,15 @@ sub is_literal_value ($) { : undef; } +sub is_undef_value ($) { + !defined($_[0]) + or ( + ref($_[0]) eq 'HASH' + and exists $_[0]->{-value} + and not defined $_[0]->{-value} + ); +} + # FIXME XSify - this can be done so much more efficiently sub is_plain_value ($) { no strict 'refs'; @@ -162,7 +170,7 @@ sub new { if ($class->isa('DBIx::Class::SQLMaker')) { push @{$opt{special_ops}}, our $DBIC_Compat_Op ||= { - regex => qr/^(?:ident|value)$/i, handler => sub { die "NOPE" } + regex => qr/^(?:ident|value|(?:not\s)?in)$/i, handler => sub { die "NOPE" } }; $opt{is_dbic_sqlmaker} = 1; } @@ -192,6 +200,7 @@ sub new { -and => '_expand_op_andor', -or => '_expand_op_andor', -nest => '_expand_nest', + -bind => sub { shift; +{ @_ } }, }; $opt{expand_op} = { @@ -200,8 +209,8 @@ sub new { 'in' => '_expand_in', 'not in' => '_expand_in', 'nest' => '_expand_nest', - (map +($_ => '_expand_op_andor'), - qw(and or)), + (map +($_ => '_expand_op_andor'), ('and', 'or')), + (map +($_ => '_expand_op_is'), ('is', 'is not')), }; # placeholder for _expand_unop system @@ -212,11 +221,9 @@ sub new { my ($op) = $name =~ /^-(.*)$/; $opt{expand_op}{$op} = sub { my ($self, $op, $arg, $k) = @_; - return +{ -op => [ - $self->{cmp}, - $self->_expand_ident(-ident => $k), - $self->_expand_expr({ '-'.$op => $arg }), - ] }; + return $self->_expand_expr_hashpair_cmp( + $k, { "-${op}" => $arg } + ); }; } } @@ -226,7 +233,15 @@ sub new { %{$opt{render}||{}} }; - $opt{render_op} = our $RENDER_OP; + $opt{render_op} = { + (map +($_ => '_render_op_between'), 'between', 'not between'), + (map +($_ => '_render_op_in'), 'in', 'not in'), + (map +($_ => '_render_unop_postfix'), + 'is null', 'is not null', 'asc', 'desc', + ), + (not => '_render_op_not'), + (map +($_ => '_render_op_andor'), qw(and or)), + }; return bless \%opt, $class; } @@ -540,6 +555,8 @@ sub where { return wantarray ? ($sql, @bind) : $sql; } +{ our $Default_Scalar_To = -value } + sub expand_expr { my ($self, $expr, $default_scalar_to) = @_; local our $Default_Scalar_To = $default_scalar_to if $default_scalar_to; @@ -561,6 +578,12 @@ sub render_expr { $self->render_aqt($self->expand_expr($expr)); } +sub _normalize_op { + my ($self, $raw) = @_; + s/^-(?=[a-z])//, s/\s+/_/g for my $op = lc $raw; + $op; +} + sub _expand_expr { my ($self, $expr) = @_; our $Expand_Depth ||= 0; local $Expand_Depth = $Expand_Depth + 1; @@ -588,10 +611,7 @@ sub _expand_expr { return +{ -literal => $literal }; } if (!ref($expr) or Scalar::Util::blessed($expr)) { - if (my $d = our $Default_Scalar_To) { - return $self->_expand_expr({ $d => $expr }); - } - return $self->_expand_value(-value => $expr); + return $self->_expand_expr_scalar($expr); } die "notreached"; } @@ -613,121 +633,35 @@ sub _expand_expr_hashpair { sub _expand_expr_hashpair_ident { my ($self, $k, $v) = @_; - if ( - !defined($v) - or ( - ref($v) eq 'HASH' - and exists $v->{-value} - and not defined $v->{-value} - ) - ) { - return $self->_expand_expr({ $k => { $self->{cmp} => undef } }); + + local our $Cur_Col_Meta = $k; + + # hash with multiple or no elements is andor + + if (ref($v) eq 'HASH' and keys %$v != 1) { + return $self->_expand_op_andor(-and => $v, $k); } - my $ik = $self->_expand_ident(-ident => $k); + + # undef needs to be re-sent with cmp to achieve IS/IS NOT NULL + + if (is_undef_value($v)) { + return $self->_expand_expr_hashpair_cmp($k => undef); + } + + # scalars and objects get expanded as whatever requested or values + if (!ref($v) or Scalar::Util::blessed($v)) { - my $d = our $Default_Scalar_To; - local our $Cur_Col_Meta = $k; - return $self->_expand_expr_hashpair_ident( - $k, - ($d - ? $self->_expand_expr($d => $v) - : { -value => $v } - ) - ); + return $self->_expand_expr_hashpair_scalar($k, $v); } + + # single key hashref is a hashtriple + if (ref($v) eq 'HASH') { - if (keys %$v > 1) { - return $self->_expand_op_andor(-and => [ - map +{ $k => { $_ => $v->{$_} } }, - sort keys %$v - ]); - } - return undef unless keys %$v; - my ($vk, $vv) = %$v; - my $op = join ' ', split '_', (map lc, $vk =~ /^-?(.*)$/)[0]; - $self->_assert_pass_injection_guard($op); - if ($op =~ s/ [_\s]? \d+ $//x ) { - return $self->_expand_expr($k, $v); - } - if (my $x = $self->{expand_op}{$op}) { - local our $Cur_Col_Meta = $k; - return $self->$x($op, $vv, $k); - } - if ($op =~ /^is(?: not)?$/) { - puke "$op can only take undef as argument" - if defined($vv) - and not ( - ref($vv) eq 'HASH' - and exists($vv->{-value}) - and !defined($vv->{-value}) - ); - return +{ -op => [ $op.' null', $ik ] }; - } - if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) { - return { -op => [ $op, $ik, $vv ] }; - } - if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { - return { -op => [ - $self->{cmp}, - $ik, - { -op => [ $op, $vv ] } - ] }; - } - if (ref($vv) eq 'ARRAY') { - my ($logic, @values) = ( - (defined($vv->[0]) and $vv->[0] =~ /^-(and|or)$/i) - ? @$vv - : (-or => @$vv) - ); - if ( - $op =~ $self->{inequality_op} - or $op =~ $self->{not_like_op} - ) { - if (lc($logic) eq '-or' and @values > 1) { - belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' " - . 'is technically equivalent to an always-true 1=1 (you probably wanted ' - . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)" - ; - } - } - unless (@values) { - # try to DWIM on equality operators - return - $op =~ $self->{equality_op} ? $self->sqlfalse - : $op =~ $self->{like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqlfalse - : $op =~ $self->{inequality_op} ? $self->sqltrue - : $op =~ $self->{not_like_op} ? belch("Supplying an empty arrayref to '@{[ uc $op]}' is deprecated") && $self->sqltrue - : puke "operator '$op' applied on an empty array (field '$k')"; - } - return $self->_expand_op_andor($logic => [ - map +{ $k => { $vk => $_ } }, - @values - ]); - } - if ( - !defined($vv) - or ( - ref($vv) eq 'HASH' - and exists $vv->{-value} - and not defined $vv->{-value} - ) - ) { - my $is = - $op =~ /^not$/i ? 'is not' # legacy - : $op =~ $self->{equality_op} ? 'is' - : $op =~ $self->{like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is' - : $op =~ $self->{inequality_op} ? 'is not' - : $op =~ $self->{not_like_op} ? belch("Supplying an undefined argument to '@{[ uc $op]}' is deprecated") && 'is not' - : puke "unexpected operator '$op' with undef operand"; - return +{ -op => [ $is.' null', $ik ] }; - } - local our $Cur_Col_Meta = $k; - return +{ -op => [ - $op, - $ik, - $self->_expand_expr($vv) - ] }; + return $self->_expand_expr_hashtriple($k, %$v); } + + # arrayref needs re-engineering over the elements + if (ref($v) eq 'ARRAY') { return $self->sqlfalse unless @$v; $self->_debug("ARRAY($k) means distribute over elements"); @@ -737,9 +671,10 @@ sub _expand_expr_hashpair_ident { : '-'.lc($self->{logic} || 'OR') ); return $self->_expand_op_andor( - $logic => [ map +{ $k => $_ }, @$v ] + $logic => $v, $k ); } + if (my $literal = is_literal_value($v)) { unless (length $k) { belch 'Hash-pairs consisting of an empty string with a literal are deprecated, and will be removed in 2.0: use -and => [ $literal ] instead'; @@ -756,50 +691,190 @@ sub _expand_expr_hashpair_ident { die "notreached"; } +sub _expand_expr_scalar { + my ($self, $expr) = @_; + + return $self->_expand_expr({ (our $Default_Scalar_To) => $expr }); +} + +sub _expand_expr_hashpair_scalar { + my ($self, $k, $v) = @_; + + return $self->_expand_expr_hashpair_cmp( + $k, $self->_expand_expr_scalar($v), + ); +} + sub _expand_expr_hashpair_op { my ($self, $k, $v) = @_; - my $op = $k; - $op =~ s/^-// if length($op) > 1; + + my $op = $self->_normalize_op($k); + $self->_assert_pass_injection_guard($op); - if (my ($rest) = $op =~/^not[_ ](.*)$/) { + + # Ops prefixed with -not_ get converted + + if (my ($rest) = $op =~/^not_(.*)$/) { return +{ -op => [ 'not', $self->_expand_expr({ "-${rest}", $v }) ] }; } - # top level special ops are illegal in general - # note that, arguably, if it makes no sense at top level, it also - # makes no sense on the other side of an = sign or similar but DBIC - # gets disappointingly upset if I disallow it - if ( - (our $Expand_Depth) == 1 - and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}} - ) { - puke "Illegal use of top-level '-$op'" - } - if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { - return { -op => [ $op, $v ] }; + + + { # Old SQLA compat + + my $op = join(' ', split '_', $op); + + # the old special op system requires illegality for top-level use + + if ( + (our $Expand_Depth) == 1 + and List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}} + ) { + puke "Illegal use of top-level '-$op'" + } + + # the old unary op system means we should touch nothing and let it work + + if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { + return { -op => [ $op, $v ] }; + } } + + # an explicit node type is currently assumed to be expanded (this is almost + # certainly wrong and there should be expansion anyway) + if ($self->{render}{$k}) { return { $k => $v }; } + + # hashref RHS values get expanded and used as op/func args + if ( ref($v) eq 'HASH' and keys %$v == 1 and (keys %$v)[0] =~ /^-/ ) { my ($func) = $k =~ /^-(.*)$/; - if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) { - return +{ -op => [ $func, $self->_expand_expr($v) ] }; + { # Old SQLA compat + if (List::Util::first { $func =~ $_->{regex} } @{$self->{special_ops}}) { + return +{ -op => [ $func, $self->_expand_expr($v) ] }; + } } return +{ -func => [ $func, $self->_expand_expr($v) ] }; } + + # scalars and literals get simply expanded + if (!ref($v) or is_literal_value($v)) { return +{ -op => [ $op, $self->_expand_expr($v) ] }; } + die "notreached"; } +sub _expand_expr_hashpair_cmp { + my ($self, $k, $v) = @_; + $self->_expand_expr_hashtriple($k, $self->{cmp}, $v); +} + +sub _expand_expr_hashtriple { + my ($self, $k, $vk, $vv) = @_; + + my $ik = $self->_expand_ident(-ident => $k); + + my $op = $self->_normalize_op($vk); + $self->_assert_pass_injection_guard($op); + + if ($op =~ s/ _? \d+ $//x ) { + return $self->_expand_expr($k, { $vk, $vv }); + } + if (my $x = $self->{expand_op}{$op}) { + local our $Cur_Col_Meta = $k; + return $self->$x($op, $vv, $k); + } + { # Old SQLA compat + + my $op = join(' ', split '_', $op); + + if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}) { + return { -op => [ $op, $ik, $vv ] }; + } + if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { + return { -op => [ + $self->{cmp}, + $ik, + { -op => [ $op, $vv ] } + ] }; + } + } + if (ref($vv) eq 'ARRAY') { + my @raw = @$vv; + my $logic = (defined($raw[0]) and $raw[0] =~ /^-(and|or)$/i) + ? shift @raw : '-or'; + my @values = map +{ $vk => $_ }, @raw; + if ( + $op =~ $self->{inequality_op} + or $op =~ $self->{not_like_op} + ) { + if (lc($logic) eq '-or' and @values > 1) { + belch "A multi-element arrayref as an argument to the inequality op '${\uc($op)}' " + . 'is technically equivalent to an always-true 1=1 (you probably wanted ' + . "to say ...{ \$inequality_op => [ -and => \@values ] }... instead)" + ; + } + } + unless (@values) { + # try to DWIM on equality operators + return ($self->_dwim_op_to_is($op, + "Supplying an empty arrayref to '%s' is deprecated", + "operator '%s' applied on an empty array (field '$k')" + ) ? $self->sqlfalse : $self->sqltrue); + } + return $self->_expand_op_andor($logic => \@values, $k); + } + if (is_undef_value($vv)) { + my $is = ($self->_dwim_op_to_is($op, + "Supplying an undefined argument to '%s' is deprecated", + "unexpected operator '%s' with undef operand", + ) ? 'is' : 'is not'); + + return $self->_expand_expr_hashpair($k => { $is, undef }); + } + local our $Cur_Col_Meta = $k; + return +{ -op => [ + $op, + $ik, + $self->_expand_expr($vv) + ] }; +} + +sub _dwim_op_to_is { + my ($self, $raw, $empty, $fail) = @_; + + my $op = $self->_normalize_op($raw); + + if ($op =~ /^not$/i) { + return 0; + } + if ($op =~ $self->{equality_op}) { + return 1; + } + if ($op =~ $self->{like_op}) { + belch(sprintf $empty, uc($op)); + return 1; + } + if ($op =~ $self->{inequality_op}) { + return 0; + } + if ($op =~ $self->{not_like_op}) { + belch(sprintf $empty, uc($op)); + return 0; + } + puke(sprintf $fail, $op); +} + sub _expand_ident { my ($self, $op, $body) = @_; unless (defined($body) or (ref($body) and ref($body) eq 'ARRAY')) { @@ -834,11 +909,15 @@ sub _expand_bool { sub _expand_op_andor { my ($self, $logic, $v, $k) = @_; if (defined $k) { - $v = [ map +{ $k, { $_ => $v->{$_} } }, - sort keys %$v ]; + $v = [ map +{ $k, $_ }, + (ref($v) eq 'HASH') + ? (map +{ $_ => $v->{$_} }, sort keys %$v) + : @$v, + ]; } my ($logop) = $logic =~ /^-?(.*)$/; if (ref($v) eq 'HASH') { + return undef unless keys %$v; return +{ -op => [ $logop, map $self->_expand_expr({ $_ => $v->{$_} }), @@ -881,6 +960,18 @@ sub _expand_op_andor { die "notreached"; } +sub _expand_op_is { + my ($self, $op, $vv, $k) = @_; + puke "$op can only take undef as argument" + if defined($vv) + and not ( + ref($vv) eq 'HASH' + and exists($vv->{-value}) + and !defined($vv->{-value}) + ); + return +{ -op => [ $op.' null', $self->_expand_ident(-ident => $k) ] }; +} + sub _expand_between { my ($self, $op, $vv, $k) = @_; local our $Cur_Col_Meta = $k; @@ -1005,98 +1096,101 @@ sub _render_literal { return @$literal; } -our $RENDER_OP = { - (map +($_ => sub { - my ($self, $op, $args) = @_; - my ($left, $low, $high) = @$args; - my ($rhsql, @rhbind) = do { - if (@$args == 2) { - puke "Single arg to between must be a literal" - unless $low->{-literal}; - @{$low->{-literal}} - } else { - my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high; - (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]), - @{$l}[1..$#$l], @{$h}[1..$#$h]) - } - }; - my ($lhsql, @lhbind) = $self->render_aqt($left); - return ( - join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'), - @lhbind, @rhbind - ); - }), 'between', 'not between'), - (map +($_ => sub { - my ($self, $op, $args) = @_; - my ($lhs, $rhs) = @$args; - my @in_bind; - my @in_sql = map { - my ($sql, @bind) = $self->render_aqt($_); - push @in_bind, @bind; - $sql; - } @$rhs; - my ($lhsql, @lbind) = $self->render_aqt($lhs); - return ( - $lhsql.' '.$self->_sqlcase($op).' ( ' - .join(', ', @in_sql) - .' )', - @lbind, @in_bind - ); - }), 'in', 'not in'), - (map +($_ => '_render_unop_postfix'), - 'is null', 'is not null', 'asc', 'desc', - ), - (not => '_render_op_not'), - (map +($_ => sub { - my ($self, $op, $args) = @_; - my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args; - return '' unless @parts; - return @{$parts[0]} if @parts == 1; - my ($final_sql) = join( - ' '.$self->_sqlcase($op).' ', - map $_->[0], @parts - ); - return ( - '('.$final_sql.')', - map @{$_}[1..$#$_], @parts - ); - }), qw(and or)), -}; - sub _render_op { my ($self, $v) = @_; my ($op, @args) = @$v; if (my $r = $self->{render_op}{$op}) { return $self->$r($op, \@args); } - my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}; - if ($us and @args > 1) { - puke "Special op '${op}' requires first value to be identifier" - unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0]; - my $k = join(($self->{name_sep}||'.'), @$ident); - local our $Expand_Depth = 1; - return $self->${\($us->{handler})}($k, $op, $args[1]); - } - if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { - return $self->${\($us->{handler})}($op, $args[0]); + + { # Old SQLA compat + + my $op = join(' ', split '_', $op); + + my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{special_ops}}; + if ($us and @args > 1) { + puke "Special op '${op}' requires first value to be identifier" + unless my ($ident) = map $_->{-ident}, grep ref($_) eq 'HASH', $args[0]; + my $k = join(($self->{name_sep}||'.'), @$ident); + local our $Expand_Depth = 1; + return $self->${\($us->{handler})}($k, $op, $args[1]); + } + if (my $us = List::Util::first { $op =~ $_->{regex} } @{$self->{unary_ops}}) { + return $self->${\($us->{handler})}($op, $args[0]); + } + } if (@args == 1) { return $self->_render_unop_prefix($op, \@args); } else { - my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @args; - return '' unless @parts; - my ($final_sql) = join( - ' '.$self->_sqlcase($op).' ', - map $_->[0], @parts - ); - return ( - $final_sql, - map @{$_}[1..$#$_], @parts - ); + return $self->_render_op_multop($op, \@args); } - die "unhandled"; + die "notreached"; +} + + +sub _render_op_between { + my ($self, $op, $args) = @_; + my ($left, $low, $high) = @$args; + my ($rhsql, @rhbind) = do { + if (@$args == 2) { + puke "Single arg to between must be a literal" + unless $low->{-literal}; + @{$low->{-literal}} + } else { + my ($l, $h) = map [ $self->render_aqt($_) ], $low, $high; + (join(' ', $l->[0], $self->_sqlcase('and'), $h->[0]), + @{$l}[1..$#$l], @{$h}[1..$#$h]) + } + }; + my ($lhsql, @lhbind) = $self->render_aqt($left); + return ( + join(' ', '(', $lhsql, $self->_sqlcase($op), $rhsql, ')'), + @lhbind, @rhbind + ); +} + +sub _render_op_in { + my ($self, $op, $args) = @_; + my ($lhs, $rhs) = @$args; + my @in_bind; + my @in_sql = map { + my ($sql, @bind) = $self->render_aqt($_); + push @in_bind, @bind; + $sql; + } @$rhs; + my ($lhsql, @lbind) = $self->render_aqt($lhs); + return ( + $lhsql.' '.$self->_sqlcase($op).' ( ' + .join(', ', @in_sql) + .' )', + @lbind, @in_bind + ); } +sub _render_op_andor { + my ($self, $op, $args) = @_; + my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args; + return '' unless @parts; + return @{$parts[0]} if @parts == 1; + my ($sql, @bind) = $self->_render_op_multop($op, $args); + return '( '.$sql.' )', @bind; +} + +sub _render_op_multop { + my ($self, $op, $args) = @_; + my @parts = grep length($_->[0]), map [ $self->render_aqt($_) ], @$args; + return '' unless @parts; + return @{$parts[0]} if @parts == 1; + my ($final_sql) = join( + ' '.$self->_sqlcase($op).' ', + map $_->[0], @parts + ); + return ( + $final_sql, + map @{$_}[1..$#$_], @parts + ); +} sub _render_op_not { my ($self, $op, $v) = @_; my ($sql, @bind) = $self->_render_unop_prefix($op, $v); @@ -1106,14 +1200,15 @@ sub _render_op_not { sub _render_unop_prefix { my ($self, $op, $v) = @_; my ($expr_sql, @bind) = $self->render_aqt($v->[0]); - my $op_sql = $self->_sqlcase($op); + + my $op_sql = $self->_sqlcase(join ' ', split '_', $op); return ("${op_sql} ${expr_sql}", @bind); } sub _render_unop_postfix { my ($self, $op, $v) = @_; my ($expr_sql, @bind) = $self->render_aqt($v->[0]); - my $op_sql = $self->_sqlcase($op); + my $op_sql = $self->_sqlcase(join ' ', split '_', $op); return ($expr_sql.' '.$op_sql, @bind); }