1 package SQL::Abstract::Converter;
6 use Data::Query::ExprHelpers;
10 has renderer_will_quote => (
18 has default_logic => (
19 is => 'ro', coerce => sub { uc($_[0]) }, default => sub { 'OR' }
23 is => 'ro', default => sub { 1 }
26 has cmp => (is => 'ro', default => sub { '=' });
28 has sqltrue => (is => 'ro', default => sub { '1=1' });
29 has sqlfalse => (is => 'ro', default => sub { '0=1' });
31 has special_ops => (is => 'ro', default => sub { [] });
33 # XXX documented but I don't current fail any tests not using it
34 has unary_ops => (is => 'ro', default => sub { [] });
36 has injection_guard => (
47 has identifier_sep => (
48 is => 'ro', default => sub { '.' },
51 has always_quote => (is => 'ro', default => sub { 1 });
53 has convert => (is => 'ro');
55 has array_datatypes => (is => 'ro');
58 my ($self, $literal) = @_;
60 ($literal, @bind) = @$literal if ref($literal) eq 'ARRAY';
61 Literal('SQL', $literal, [ $self->_bind_to_dq(@bind) ]);
65 my ($self, @bind) = @_;
69 $self->_assert_bindval_matches_bindtype(@bind);
70 map perl_scalar_value(reverse @$_), @bind
72 : map perl_scalar_value($_), @bind
76 my ($self, $value) = @_;
77 $self->_maybe_convert_dq(perl_scalar_value($value, our $Cur_Col_Meta));
81 my ($self, $ident) = @_;
82 $self->_assert_pass_injection_guard($ident)
83 unless $self->renderer_will_quote;
84 $self->_maybe_convert_dq(
86 if (my $sep = $self->identifier_sep) {
87 split /\Q$sep/, $ident
95 sub _maybe_convert_dq {
97 if (my $c = $self->{where_convert}) {
98 Operator({ 'SQL.Naive' => 'apply' }, [
99 Identifier($self->_sqlcase($c)),
109 my ($self, $op, @args) = @_;
110 $self->_assert_pass_injection_guard($op);
111 Operator({ 'SQL.Naive' => $op }, \@args);
114 sub _assert_pass_injection_guard {
115 if ($_[1] =~ $_[0]->{injection_guard}) {
116 my $class = ref $_[0];
117 die "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
118 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
119 . "{injection_guard} attribute to ${class}->new()"
124 my ($self, $table, $data, $options) = @_;
125 my (@names, @values);
126 if (ref($data) eq 'HASH') {
127 @names = sort keys %$data;
128 foreach my $k (@names) {
129 local our $Cur_Col_Meta = $k;
130 push @values, $self->_mutation_rhs_to_dq($data->{$k});
132 } elsif (ref($data) eq 'ARRAY') {
133 local our $Cur_Col_Meta;
134 @values = map $self->_mutation_rhs_to_dq($_), @$data;
136 die "Not handled yet";
139 if (my $r_source = $options->{returning}) {
141 map +(ref($_) ? $self->_expr_to_dq($_) : $self->_ident_to_dq($_)),
142 (ref($r_source) eq 'ARRAY' ? @$r_source : $r_source),
146 (@names ? ([ map $self->_ident_to_dq($_), @names ]) : undef),
148 $self->_table_to_dq($table),
149 ($returning ? ($returning) : undef),
153 sub _mutation_rhs_to_dq {
155 if (ref($v) eq 'ARRAY') {
156 if ($self->{array_datatypes}) {
157 return $self->_value_to_dq($v);
159 $v = \do { my $x = $v };
161 if (ref($v) eq 'HASH') {
162 my ($op, $arg, @rest) = %$v;
164 die 'Operator calls in update/insert must be in the form { -op => $arg }'
165 if (@rest or not $op =~ /^\-(.+)/);
167 return $self->_expr_to_dq($v);
171 my ($self, $table, $data, $where) = @_;
173 die "Unsupported data type specified to \$sql->update"
174 unless ref $data eq 'HASH';
178 foreach my $k (sort keys %$data) {
180 local our $Cur_Col_Meta = $k;
181 push @set, [ $self->_ident_to_dq($k), $self->_mutation_rhs_to_dq($v) ];
186 $self->_where_to_dq($where),
187 $self->_table_to_dq($table),
192 my ($self, $table, undef, $where) = @_;
194 my $source_dq = $self->_table_to_dq($table);
196 if (my $where_dq = $self->_where_to_dq($where)) {
197 $source_dq = Where($where_dq, $source_dq);
205 my ($table, $fields, $where, $order) = @_;
207 my $source_dq = $self->_source_to_dq(@_);
209 my $ordered_dq = do {
211 $self->_order_by_to_dq($order, undef, undef, $source_dq);
217 return $self->_select_select_to_dq($fields, $ordered_dq);
220 sub _select_select_to_dq {
221 my ($self, $fields, $from_dq) = @_;
226 $self->_select_field_list_to_dq($fields),
231 sub _select_field_list_to_dq {
232 my ($self, $fields) = @_;
233 [ map $self->_select_field_to_dq($_),
234 ref($fields) eq 'ARRAY' ? @$fields : $fields ];
237 sub _select_field_to_dq {
238 my ($self, $field) = @_;
239 if (my $ref = ref($field)) {
240 if ($ref eq 'REF' and ref($$field) eq 'HASH') {
243 return $self->_literal_to_dq($$field);
246 return $self->_ident_to_dq($field)
250 my ($self, $table, $where) = @_;
252 $self->_where_to_dq($where),
253 $self->_table_to_dq($table),
258 my ($self, $where, $logic) = @_;
260 return undef unless defined($where);
262 # if we're given a simple string assume it's a literal
263 return $self->_literal_to_dq($where) if !ref($where);
265 # turn the convert misfeature on - only used in WHERE clauses
266 local $self->{where_convert} = $self->convert;
268 return $self->_expr_to_dq($where, $logic);
271 my %op_conversions = (
280 'defined' => 'IS NOT NULL',
284 my ($self, $where, $logic) = @_;
286 if (ref($where) eq 'ARRAY') {
287 return $self->_expr_to_dq_ARRAYREF($where, $logic);
288 } elsif (ref($where) eq 'HASH') {
289 return $self->_expr_to_dq_HASHREF($where, $logic);
291 ref($where) eq 'SCALAR'
292 or (ref($where) eq 'REF' and ref($$where) eq 'ARRAY')
294 return $self->_literal_to_dq($$where);
295 } elsif (ref($where) eq 'REF' and ref($$where) eq 'HASH') {
299 and not $_->{operator}{'SQL.Naive'}
300 and my $op = $_->{operator}{'Perl'}
302 my $sql_op = $op_conversions{$op} || uc($op);
305 operator => { 'SQL.Naive' => $sql_op }
310 } elsif (!ref($where) or Scalar::Util::blessed($where)) {
311 return $self->_value_to_dq($where);
313 die "Can't handle $where";
316 sub _expr_to_dq_ARRAYREF {
317 my ($self, $where, $logic) = @_;
319 $logic = uc($logic || $self->default_logic || 'OR');
320 $logic eq 'AND' or $logic eq 'OR' or die "unknown logic: $logic";
322 return unless @$where;
324 my ($first, @rest) = @$where;
326 return $self->_expr_to_dq($first) unless @rest;
330 $self->_where_hashpair_to_dq($first => shift(@rest));
332 $self->_expr_to_dq($first);
336 return $self->_expr_to_dq_ARRAYREF(\@rest, $logic) unless $first_dq;
339 $logic, $first_dq, $self->_expr_to_dq_ARRAYREF(\@rest, $logic)
343 sub _expr_to_dq_HASHREF {
344 my ($self, $where, $logic) = @_;
346 $logic = uc($logic) if $logic;
349 $self->_where_hashpair_to_dq($_ => $where->{$_}, $logic)
352 return $dq[0] unless @dq > 1;
354 my $final = pop(@dq);
356 foreach my $dq (reverse @dq) {
357 $final = $self->_op_to_dq($logic||'AND', $dq, $final);
363 sub _where_to_dq_SCALAR {
364 shift->_value_to_dq(@_);
368 my ($self, $op, $v) = @_;
369 my @args = map $self->_expr_to_dq($_), (ref($v) eq 'ARRAY' ? @$v : $v);
371 # Ok. Welcome to stupid compat code land. An SQLA expr that would in the
372 # absence of this piece of crazy render to:
378 # { -a => { -b => { -c => $x } } }
380 # actually needs to render to:
384 # because SQL sucks, and databases are hateful, and SQLA is Just That DWIM.
386 # However, we don't want to catch 'A(x)' and turn it into 'A x'
388 # So the way we deal with this is to go through all our arguments, and
389 # then if the argument is -also- an apply, i.e. at least 'B', we check
390 # its arguments - and if there's only one of them, and that isn't an apply,
391 # then we convert to the bareword form. The end result should be:
394 # A( B( x ) ) -> A( B x )
395 # A( B( C( x ) ) ) -> A( B( C x ) )
396 # A( B( x + y ) ) -> A( B( x + y ) )
397 # A( B( x, y ) ) -> A( B( x, y ) )
399 # If this turns out not to be quite right, please add additional tests
400 # to either 01generate.t or 02where.t *and* update this comment.
402 foreach my $arg (@args) {
404 is_Operator($arg) and $arg->{operator}{'SQL.Naive'} eq 'apply'
405 and @{$arg->{args}} == 2 and !is_Operator($arg->{args}[1])
408 $arg->{operator}{'SQL.Naive'} = (shift @{$arg->{args}})->{elements}->[0];
411 $self->_assert_pass_injection_guard($op);
412 return $self->_op_to_dq(
413 apply => $self->_ident_to_dq($op), @args
417 sub _where_hashpair_to_dq {
418 my ($self, $k, $v, $logic) = @_;
420 if ($k =~ /^-(.*)/s) {
422 if ($op eq 'AND' or $op eq 'OR') {
423 return $self->_expr_to_dq($v, $op);
424 } elsif ($op eq 'NEST') {
425 return $self->_expr_to_dq($v);
426 } elsif ($op eq 'NOT') {
427 return $self->_op_to_dq(NOT => $self->_expr_to_dq($v));
428 } elsif ($op eq 'BOOL') {
429 return ref($v) ? $self->_expr_to_dq($v) : $self->_ident_to_dq($v);
430 } elsif ($op eq 'NOT_BOOL') {
431 return $self->_op_to_dq(
432 NOT => ref($v) ? $self->_expr_to_dq($v) : $self->_ident_to_dq($v)
434 } elsif ($op eq 'IDENT') {
435 return $self->_ident_to_dq($v);
436 } elsif ($op eq 'VALUE') {
437 return $self->_value_to_dq($v);
438 } elsif ($op =~ /^(?:AND|OR|NEST)_?\d+/) {
439 die "Use of [and|or|nest]_N modifiers is no longer supported";
441 return $self->_apply_to_dq($op, $v);
444 local our $Cur_Col_Meta = $k;
445 if (ref($v) eq 'ARRAY') {
447 return $self->_literal_to_dq($self->{sqlfalse});
448 } elsif (defined($v->[0]) && $v->[0] =~ /-(and|or)/i) {
449 return $self->_expr_to_dq_ARRAYREF([
450 map +{ $k => $_ }, @{$v}[1..$#$v]
453 return $self->_expr_to_dq_ARRAYREF([
454 map +{ $k => $_ }, @$v
456 } elsif (ref($v) eq 'SCALAR' or (ref($v) eq 'REF' and ref($$v) eq 'ARRAY')) {
457 return Literal('SQL', [ $self->_ident_to_dq($k), $self->_literal_to_dq($$v) ]);
459 my ($op, $rhs) = do {
460 if (ref($v) eq 'HASH') {
462 return $self->_expr_to_dq_ARRAYREF([
463 map +{ $k => { $_ => $v->{$_} } }, sort keys %$v
466 my ($op, $value) = %$v;
467 s/^-//, s/_/ /g for $op;
468 if ($op =~ /^(and|or)$/i) {
469 return $self->_expr_to_dq({ $k => $value }, $op);
471 my $special_op = List::Util::first {$op =~ $_->{regex}}
472 @{$self->{special_ops}}
474 return $self->_literal_to_dq(
475 [ $special_op->{handler}->($k, $op, $value) ]
477 } elsif ($op =~ /^(?:AND|OR|NEST)_?\d+$/i) {
478 die "Use of [and|or|nest]_N modifiers is no longer supported";
485 if ($op eq 'BETWEEN' or $op eq 'IN' or $op eq 'NOT IN' or $op eq 'NOT BETWEEN') {
486 die "Can't use undef argument for operator $op" unless defined $rhs;
487 $rhs = [$rhs] unless ref $rhs;
488 if (ref($rhs) ne 'ARRAY') {
490 # have to add parens if none present because -in => \"SELECT ..."
491 # got documented. mst hates everything.
492 if (ref($rhs) eq 'SCALAR') {
494 1 while ($x =~ s/\A\s*\((.*)\)\s*\Z/$1/s);
496 } elsif (ref($rhs) eq 'REF') {
497 if (ref($$rhs) eq 'ARRAY') {
498 my ($x, @rest) = @{$$rhs};
499 1 while ($x =~ s/\A\s*\((.*)\)\s*\Z/$1/s);
500 $rhs = \[ $x, @rest ];
501 } elsif (ref($$rhs) eq 'HASH') {
502 return $self->_op_to_dq($op, $self->_ident_to_dq($k), $$rhs);
506 return $self->_op_to_dq(
507 $op, $self->_ident_to_dq($k), $self->_literal_to_dq($$rhs)
510 if (grep !defined, @$rhs) {
511 my ($inop, $logic, $nullop) = $op =~ /^NOT/
512 ? (-not_in => AND => { '!=' => undef })
513 : (-in => OR => undef);
514 if (my @defined = grep defined, @$rhs) {
515 return $self->_expr_to_dq_ARRAYREF([
516 { $k => { $inop => \@defined } },
520 return $self->_expr_to_dq_HASHREF({ $k => $nullop });
522 return $self->_literal_to_dq(
523 $op =~ /^NOT/ ? $self->{sqltrue} : $self->{sqlfalse}
525 return $self->_op_to_dq(
526 $op, $self->_ident_to_dq($k), map $self->_expr_to_dq($_), @$rhs
528 } elsif ($op =~ s/^NOT (?!LIKE)//) {
529 return $self->_where_hashpair_to_dq(-not => { $k => { $op => $rhs } });
530 } elsif ($op eq 'IDENT') {
531 return $self->_op_to_dq(
532 $self->{cmp}, $self->_ident_to_dq($k), $self->_ident_to_dq($rhs)
534 } elsif ($op eq 'VALUE') {
535 return $self->_op_to_dq(
536 $self->{cmp}, $self->_ident_to_dq($k), $self->_value_to_dq($rhs)
538 } elsif (!defined($rhs)) {
540 if ($op eq '=' or $op eq 'LIKE' or $op eq 'IS') {
542 } elsif ($op eq '!=' or $op eq 'NOT LIKE' or $op eq 'IS NOT') {
545 die "Can't do undef -> NULL transform for operator ${op}";
548 return $self->_op_to_dq($null_op, $self->_ident_to_dq($k));
550 if (ref($rhs) eq 'ARRAY') {
552 return $self->_literal_to_dq(
553 $op eq '!=' ? $self->{sqltrue} : $self->{sqlfalse}
555 } elsif (defined($rhs->[0]) and $rhs->[0] =~ /^-(and|or)$/i) {
556 return $self->_expr_to_dq_ARRAYREF([
557 map +{ $k => { $op => $_ } }, @{$rhs}[1..$#$rhs]
559 } elsif ($op =~ /^-(?:AND|OR|NEST)_?\d+/) {
560 die "Use of [and|or|nest]_N modifiers is no longer supported";
562 return $self->_expr_to_dq_ARRAYREF([
563 map +{ $k => { $op => $_ } }, @$rhs
566 return $self->_op_to_dq(
567 $op, $self->_ident_to_dq($k), $self->_expr_to_dq($rhs)
572 sub _order_by_to_dq {
573 my ($self, $arg, $dir, $nulls, $from) = @_;
579 (defined($dir) ? (!!($dir =~ /desc/i)) : undef),
581 ($from ? ($from) : undef),
585 $dq->{by} = $self->_ident_to_dq($arg);
586 } elsif (ref($arg) eq 'ARRAY') {
588 local our $Order_Inner unless our $Order_Recursing;
589 local $Order_Recursing = 1;
591 foreach my $member (@$arg) {
593 my $next = $self->_order_by_to_dq($member, $dir, $nulls, $from);
595 $inner->{from} = $next if $inner;
596 $inner = $Order_Inner || $next;
598 $Order_Inner = $inner;
600 } elsif (ref($arg) eq 'REF' and ref($$arg) eq 'ARRAY') {
601 $dq->{by} = $self->_literal_to_dq($$arg);
602 } elsif (ref($arg) eq 'REF' and ref($$arg) eq 'HASH') {
604 } elsif (ref($arg) eq 'SCALAR') {
606 # < mst> right, but if it doesn't match that, it goes "ok, right, not sure,
607 # totally leaving this untouched as a literal"
608 # < mst> so I -think- it's relatively robust
609 # < ribasushi> right, it's relatively safe then
610 # < ribasushi> is this regex centralized?
611 # < mst> it only exists in _order_by_to_dq in SQL::Abstract::Converter
612 # < mst> it only exists because you were kind enough to support new
613 # dbihacks crack combined with old literal order_by crack
614 # < ribasushi> heh :)
616 # this should take into account our quote char and name sep
618 my $match_ident = '\w+(?:\.\w+)*';
620 if (my ($ident, $dir) = $$arg =~ /^(${match_ident})(?:\s+(desc|asc))?$/i) {
621 $dq->{by} = $self->_ident_to_dq($ident);
622 $dq->{reverse} = 1 if $dir and lc($dir) eq 'desc';
624 $dq->{by} = $self->_literal_to_dq($$arg);
626 } elsif (ref($arg) eq 'HASH') {
627 return () unless %$arg;
629 my ($direction, $val);
630 foreach my $key (keys %$arg) {
631 if ( $key =~ /^-(desc|asc)/i ) {
632 die "hash passed to _order_by_to_dq must have exactly one of -desc or -asc"
633 if defined $direction;
636 } elsif ($key =~ /^-nulls$/i) {
637 $nulls = $arg->{$key};
638 die "invalid value for -nulls" unless $nulls =~ /^(?:first|last|none)$/i;
640 die "invalid key ${key} in hash passed to _order_by_to_dq";
644 die "hash passed to _order_by_to_dq must have exactly one of -desc or -asc"
645 unless defined $direction;
647 return $self->_order_by_to_dq($val, $direction, $nulls, $from);
649 die "Can't handle $arg in _order_by_to_dq";
655 my ($self, $from) = @_;
656 if (ref($from) eq 'ARRAY') {
657 die "Empty FROM list" unless my @f = @$from;
658 my $dq = $self->_table_to_dq(shift @f);
659 while (my $x = shift @f) {
662 $self->_table_to_dq($x),
666 } elsif (ref($from) eq 'SCALAR' or (ref($from) eq 'REF')) {
667 $self->_literal_to_dq($$from);
669 $self->_ident_to_dq($from);
675 #my ($self, $col, @vals) = @_;
677 #LDNOTE : changed original implementation below because it did not make
678 # sense when bindtype eq 'columns' and @vals > 1.
679 # return $self->{bindtype} eq 'columns' ? [ $col, @vals ] : @vals;
681 # called often - tighten code
682 return $_[0]->bind_meta
683 ? map {[$_[1], $_]} @_[2 .. $#_]
688 # Dies if any element of @bind is not in [colname => value] format
689 # if bindtype is 'columns'.
690 sub _assert_bindval_matches_bindtype {
691 # my ($self, @bind) = @_;
693 if ($self->bind_meta) {
695 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
696 die "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
702 # Fix SQL case, if so requested
704 return $_[0]->lower_case ? $_[1] : uc($_[1]);