1 package SQL::Abstract::Converter;
6 use Data::Query::Constants qw(
7 DQ_IDENTIFIER DQ_OPERATOR DQ_VALUE DQ_LITERAL DQ_JOIN DQ_SELECT DQ_ORDER
8 DQ_WHERE DQ_DELETE DQ_UPDATE DQ_INSERT
10 use Data::Query::ExprHelpers qw(perl_scalar_value);
14 has renderer_will_quote => (
22 has default_logic => (
23 is => 'ro', coerce => sub { uc($_[0]) }, default => sub { 'OR' }
27 is => 'ro', default => sub { 1 }
30 has cmp => (is => 'ro', default => sub { '=' });
32 has sqltrue => (is => 'ro', default => sub { '1=1' });
33 has sqlfalse => (is => 'ro', default => sub { '0=1' });
35 has special_ops => (is => 'ro', default => sub { [] });
37 # XXX documented but I don't current fail any tests not using it
38 has unary_ops => (is => 'ro', default => sub { [] });
40 has injection_guard => (
51 has identifier_sep => (
52 is => 'ro', default => sub { '.' },
55 has always_quote => (is => 'ro', default => sub { 1 });
57 has convert => (is => 'ro');
59 has array_datatypes => (is => 'ro');
62 my ($self, $literal) = @_;
64 ($literal, @bind) = @$literal if ref($literal) eq 'ARRAY';
69 (@bind ? (values => [ $self->_bind_to_dq(@bind) ]) : ()),
74 my ($self, @bind) = @_;
78 $self->_assert_bindval_matches_bindtype(@bind);
79 map perl_scalar_value(reverse @$_), @bind
81 : map perl_scalar_value($_), @bind
85 my ($self, $value) = @_;
86 $self->_maybe_convert_dq(perl_scalar_value($value, our $Cur_Col_Meta));
90 my ($self, $ident) = @_;
91 $self->_assert_pass_injection_guard($ident)
92 unless $self->renderer_will_quote;
93 $self->_maybe_convert_dq({
94 type => DQ_IDENTIFIER,
95 elements => [ split /\Q${\$self->identifier_sep}/, $ident ],
99 sub _maybe_convert_dq {
100 my ($self, $dq) = @_;
101 if (my $c = $self->{where_convert}) {
104 operator => { 'SQL.Naive' => 'apply' },
106 { type => DQ_IDENTIFIER, elements => [ $self->_sqlcase($c) ] },
116 my ($self, $op, @args) = @_;
117 $self->_assert_pass_injection_guard($op);
120 operator => { 'SQL.Naive' => $op },
125 sub _assert_pass_injection_guard {
126 if ($_[1] =~ $_[0]->{injection_guard}) {
127 my $class = ref $_[0];
128 die "Possible SQL injection attempt '$_[1]'. If this is indeed a part of the "
129 . "desired SQL use literal SQL ( \'...' or \[ '...' ] ) or supply your own "
130 . "{injection_guard} attribute to ${class}->new()"
135 my ($self, $table, $data, $options) = @_;
136 my (@names, @values);
137 if (ref($data) eq 'HASH') {
138 @names = sort keys %$data;
139 foreach my $k (@names) {
140 local our $Cur_Col_Meta = $k;
141 push @values, $self->_mutation_rhs_to_dq($data->{$k});
143 } elsif (ref($data) eq 'ARRAY') {
144 local our $Cur_Col_Meta;
145 @values = map $self->_mutation_rhs_to_dq($_), @$data;
147 die "Not handled yet";
150 if (my $r_source = $options->{returning}) {
152 map +(ref($_) ? $self->_expr_to_dq($_) : $self->_ident_to_dq($_)),
153 (ref($r_source) eq 'ARRAY' ? @$r_source : $r_source),
158 target => $self->_table_to_dq($table),
159 (@names ? (names => [ map $self->_ident_to_dq($_), @names ]) : ()),
160 values => [ \@values ],
161 ($returning ? (returning => $returning) : ()),
165 sub _mutation_rhs_to_dq {
167 if (ref($v) eq 'ARRAY') {
168 if ($self->{array_datatypes}) {
169 return $self->_value_to_dq($v);
171 $v = \do { my $x = $v };
173 if (ref($v) eq 'HASH') {
174 my ($op, $arg, @rest) = %$v;
176 die 'Operator calls in update/insert must be in the form { -op => $arg }'
177 if (@rest or not $op =~ /^\-(.+)/);
179 return $self->_expr_to_dq($v);
183 my ($self, $table, $data, $where) = @_;
185 die "Unsupported data type specified to \$sql->update"
186 unless ref $data eq 'HASH';
190 foreach my $k (sort keys %$data) {
192 local our $Cur_Col_Meta = $k;
193 push @set, [ $self->_ident_to_dq($k), $self->_mutation_rhs_to_dq($v) ];
198 target => $self->_table_to_dq($table),
200 where => $self->_where_to_dq($where),
205 my ($self, $table, undef, $where) = @_;
207 my $source_dq = $self->_table_to_dq($table);
209 if (my $where_dq = $self->_where_to_dq($where)) {
222 my ($table, $fields, $where, $order) = @_;
224 my $source_dq = $self->_source_to_dq(@_);
226 my $ordered_dq = do {
228 $self->_order_by_to_dq($order, undef, $source_dq);
234 return $self->_select_select_to_dq($fields, $ordered_dq);
237 sub _select_select_to_dq {
238 my ($self, $fields, $from_dq) = @_;
244 select => $self->_select_field_list_to_dq($fields),
249 sub _select_field_list_to_dq {
250 my ($self, $fields) = @_;
251 [ map $self->_select_field_to_dq($_),
252 ref($fields) eq 'ARRAY' ? @$fields : $fields ];
255 sub _select_field_to_dq {
256 my ($self, $field) = @_;
257 if (my $ref = ref($field)) {
258 if ($ref eq 'REF' and ref($$field) eq 'HASH') {
261 return $self->_literal_to_dq($$field);
264 return $self->_ident_to_dq($field)
268 my ($self, $table, $where) = @_;
271 target => $self->_table_to_dq($table),
272 where => $self->_where_to_dq($where),
277 my ($self, $where, $logic) = @_;
279 return undef unless defined($where);
281 # if we're given a simple string assume it's a literal
282 return $self->_literal_to_dq($where) if !ref($where);
284 # turn the convert misfeature on - only used in WHERE clauses
285 local $self->{where_convert} = $self->convert;
287 return $self->_expr_to_dq($where, $logic);
291 my ($self, $where, $logic) = @_;
293 if (ref($where) eq 'ARRAY') {
294 return $self->_expr_to_dq_ARRAYREF($where, $logic);
295 } elsif (ref($where) eq 'HASH') {
296 return $self->_expr_to_dq_HASHREF($where, $logic);
298 ref($where) eq 'SCALAR'
299 or (ref($where) eq 'REF' and ref($$where) eq 'ARRAY')
301 return $self->_literal_to_dq($$where);
302 } elsif (ref($where) eq 'REF' and ref($$where) eq 'HASH') {
304 } elsif (!ref($where) or Scalar::Util::blessed($where)) {
305 return $self->_value_to_dq($where);
307 die "Can't handle $where";
310 sub _expr_to_dq_ARRAYREF {
311 my ($self, $where, $logic) = @_;
313 $logic = uc($logic || $self->default_logic || 'OR');
314 $logic eq 'AND' or $logic eq 'OR' or die "unknown logic: $logic";
316 return unless @$where;
318 my ($first, @rest) = @$where;
320 return $self->_expr_to_dq($first) unless @rest;
324 $self->_where_hashpair_to_dq($first => shift(@rest));
326 $self->_expr_to_dq($first);
330 return $self->_expr_to_dq_ARRAYREF(\@rest, $logic) unless $first_dq;
333 $logic, $first_dq, $self->_expr_to_dq_ARRAYREF(\@rest, $logic)
337 sub _expr_to_dq_HASHREF {
338 my ($self, $where, $logic) = @_;
340 $logic = uc($logic) if $logic;
343 $self->_where_hashpair_to_dq($_ => $where->{$_}, $logic)
346 return $dq[0] unless @dq > 1;
348 my $final = pop(@dq);
350 foreach my $dq (reverse @dq) {
351 $final = $self->_op_to_dq($logic||'AND', $dq, $final);
357 sub _where_to_dq_SCALAR {
358 shift->_value_to_dq(@_);
362 my ($self, $op, $v) = @_;
363 my @args = map $self->_expr_to_dq($_), (ref($v) eq 'ARRAY' ? @$v : $v);
365 # Ok. Welcome to stupid compat code land. An SQLA expr that would in the
366 # absence of this piece of crazy render to:
372 # { -a => { -b => { -c => $x } } }
374 # actually needs to render to:
378 # because SQL sucks, and databases are hateful, and SQLA is Just That DWIM.
380 # However, we don't want to catch 'A(x)' and turn it into 'A x'
382 # So the way we deal with this is to go through all our arguments, and
383 # then if the argument is -also- an apply, i.e. at least 'B', we check
384 # its arguments - and if there's only one of them, and that isn't an apply,
385 # then we convert to the bareword form. The end result should be:
388 # A( B( x ) ) -> A( B x )
389 # A( B( C( x ) ) ) -> A( B( C x ) )
390 # A( B( x + y ) ) -> A( B( x + y ) )
391 # A( B( x, y ) ) -> A( B( x, y ) )
393 # If this turns out not to be quite right, please add additional tests
394 # to either 01generate.t or 02where.t *and* update this comment.
396 foreach my $arg (@args) {
398 $arg->{type} eq DQ_OPERATOR and $arg->{operator}{'SQL.Naive'} eq 'apply'
399 and @{$arg->{args}} == 2 and $arg->{args}[1]{type} ne DQ_OPERATOR
401 $arg->{operator}{'SQL.Naive'} = (shift @{$arg->{args}})->{elements}->[0];
404 $self->_assert_pass_injection_guard($op);
405 return $self->_op_to_dq(
406 apply => $self->_ident_to_dq($op), @args
410 sub _where_hashpair_to_dq {
411 my ($self, $k, $v, $logic) = @_;
413 if ($k =~ /^-(.*)/s) {
415 if ($op eq 'AND' or $op eq 'OR') {
416 return $self->_expr_to_dq($v, $op);
417 } elsif ($op eq 'NEST') {
418 return $self->_expr_to_dq($v);
419 } elsif ($op eq 'NOT') {
420 return $self->_op_to_dq(NOT => $self->_expr_to_dq($v));
421 } elsif ($op eq 'BOOL') {
422 return ref($v) ? $self->_expr_to_dq($v) : $self->_ident_to_dq($v);
423 } elsif ($op eq 'NOT_BOOL') {
424 return $self->_op_to_dq(
425 NOT => ref($v) ? $self->_expr_to_dq($v) : $self->_ident_to_dq($v)
427 } elsif ($op eq 'IDENT') {
428 return $self->_ident_to_dq($v);
429 } elsif ($op eq 'VALUE') {
430 return $self->_value_to_dq($v);
431 } elsif ($op =~ /^(?:AND|OR|NEST)_?\d+/) {
432 die "Use of [and|or|nest]_N modifiers is no longer supported";
434 return $self->_apply_to_dq($op, $v);
437 local our $Cur_Col_Meta = $k;
438 if (ref($v) eq 'ARRAY') {
440 return $self->_literal_to_dq($self->{sqlfalse});
441 } elsif (defined($v->[0]) && $v->[0] =~ /-(and|or)/i) {
442 return $self->_expr_to_dq_ARRAYREF([
443 map +{ $k => $_ }, @{$v}[1..$#$v]
446 return $self->_expr_to_dq_ARRAYREF([
447 map +{ $k => $_ }, @$v
449 } elsif (ref($v) eq 'SCALAR' or (ref($v) eq 'REF' and ref($$v) eq 'ARRAY')) {
453 parts => [ $self->_ident_to_dq($k), $self->_literal_to_dq($$v) ]
456 my ($op, $rhs) = do {
457 if (ref($v) eq 'HASH') {
459 return $self->_expr_to_dq_ARRAYREF([
460 map +{ $k => { $_ => $v->{$_} } }, sort keys %$v
463 my ($op, $value) = %$v;
464 s/^-//, s/_/ /g for $op;
465 if ($op =~ /^(and|or)$/i) {
466 return $self->_expr_to_dq({ $k => $value }, $op);
468 my $special_op = List::Util::first {$op =~ $_->{regex}}
469 @{$self->{special_ops}}
471 return $self->_literal_to_dq(
472 [ $special_op->{handler}->($k, $op, $value) ]
474 } elsif ($op =~ /^(?:AND|OR|NEST)_?\d+$/i) {
475 die "Use of [and|or|nest]_N modifiers is no longer supported";
482 if ($op eq 'BETWEEN' or $op eq 'IN' or $op eq 'NOT IN' or $op eq 'NOT BETWEEN') {
483 if (ref($rhs) ne 'ARRAY') {
485 # have to add parens if none present because -in => \"SELECT ..."
486 # got documented. mst hates everything.
487 if (ref($rhs) eq 'SCALAR') {
489 1 while ($x =~ s/\A\s*\((.*)\)\s*\Z/$1/s);
492 my ($x, @rest) = @{$$rhs};
493 1 while ($x =~ s/\A\s*\((.*)\)\s*\Z/$1/s);
494 $rhs = \[ $x, @rest ];
497 return $self->_op_to_dq(
498 $op, $self->_ident_to_dq($k), $self->_literal_to_dq($$rhs)
501 return $self->_literal_to_dq($self->{sqlfalse}) unless @$rhs;
502 return $self->_op_to_dq(
503 $op, $self->_ident_to_dq($k), map $self->_expr_to_dq($_), @$rhs
505 } elsif ($op =~ s/^NOT (?!LIKE)//) {
506 return $self->_where_hashpair_to_dq(-not => { $k => { $op => $rhs } });
507 } elsif ($op eq 'IDENT') {
508 return $self->_op_to_dq(
509 $self->{cmp}, $self->_ident_to_dq($k), $self->_ident_to_dq($rhs)
511 } elsif ($op eq 'VALUE') {
512 return $self->_op_to_dq(
513 $self->{cmp}, $self->_ident_to_dq($k), $self->_value_to_dq($rhs)
515 } elsif (!defined($rhs)) {
517 if ($op eq '=' or $op eq 'LIKE') {
519 } elsif ($op eq '!=') {
522 die "Can't do undef -> NULL transform for operator ${op}";
525 return $self->_op_to_dq($null_op, $self->_ident_to_dq($k));
527 if (ref($rhs) eq 'ARRAY') {
529 return $self->_literal_to_dq(
530 $op eq '!=' ? $self->{sqltrue} : $self->{sqlfalse}
532 } elsif (defined($rhs->[0]) and $rhs->[0] =~ /^-(and|or)$/i) {
533 return $self->_expr_to_dq_ARRAYREF([
534 map +{ $k => { $op => $_ } }, @{$rhs}[1..$#$rhs]
536 } elsif ($op =~ /^-(?:AND|OR|NEST)_?\d+/) {
537 die "Use of [and|or|nest]_N modifiers is no longer supported";
539 return $self->_expr_to_dq_ARRAYREF([
540 map +{ $k => { $op => $_ } }, @$rhs
543 return $self->_op_to_dq(
544 $op, $self->_ident_to_dq($k), $self->_expr_to_dq($rhs)
549 sub _order_by_to_dq {
550 my ($self, $arg, $dir, $from) = @_;
556 (defined($dir) ? (reverse => !!($dir =~ /desc/i)) : ()),
557 ($from ? (from => $from) : ()),
561 $dq->{by} = $self->_ident_to_dq($arg);
562 } elsif (ref($arg) eq 'ARRAY') {
564 local our $Order_Inner unless our $Order_Recursing;
565 local $Order_Recursing = 1;
567 foreach my $member (@$arg) {
569 my $next = $self->_order_by_to_dq($member, $dir, $from);
571 $inner->{from} = $next if $inner;
572 $inner = $Order_Inner || $next;
574 $Order_Inner = $inner;
576 } elsif (ref($arg) eq 'REF' and ref($$arg) eq 'ARRAY') {
577 $dq->{by} = $self->_literal_to_dq($$arg);
578 } elsif (ref($arg) eq 'SCALAR') {
580 # < mst> right, but if it doesn't match that, it goes "ok, right, not sure,
581 # totally leaving this untouched as a literal"
582 # < mst> so I -think- it's relatively robust
583 # < ribasushi> right, it's relatively safe then
584 # < ribasushi> is this regex centralized?
585 # < mst> it only exists in _order_by_to_dq in SQL::Abstract::Converter
586 # < mst> it only exists because you were kind enough to support new
587 # dbihacks crack combined with old literal order_by crack
588 # < ribasushi> heh :)
590 if (my ($ident, $dir) = $$arg =~ /^(\w+)(?:\s+(desc|asc))?$/i) {
591 $dq->{by} = $self->_ident_to_dq($ident);
592 $dq->{reverse} = 1 if $dir and lc($dir) eq 'desc';
594 $dq->{by} = $self->_literal_to_dq($$arg);
596 } elsif (ref($arg) eq 'HASH') {
597 my ($key, $val, @rest) = %$arg;
601 if (@rest or not $key =~ /^-(desc|asc)/i) {
602 die "hash passed to _order_by must have exactly one key (-desc or -asc)";
605 return $self->_order_by_to_dq($val, $dir, $from);
607 die "Can't handle $arg in _order_by_to_dq";
613 my ($self, $from) = @_;
614 if (ref($from) eq 'ARRAY') {
615 die "Empty FROM list" unless my @f = @$from;
616 my $dq = $self->_table_to_dq(shift @f);
617 while (my $x = shift @f) {
620 join => [ $dq, $self->_table_to_dq($x) ]
624 } elsif (ref($from) eq 'SCALAR' or (ref($from) eq 'REF')) {
625 $self->_literal_to_dq($$from);
627 $self->_ident_to_dq($from);
633 #my ($self, $col, @vals) = @_;
635 #LDNOTE : changed original implementation below because it did not make
636 # sense when bindtype eq 'columns' and @vals > 1.
637 # return $self->{bindtype} eq 'columns' ? [ $col, @vals ] : @vals;
639 # called often - tighten code
640 return $_[0]->bind_meta
641 ? map {[$_[1], $_]} @_[2 .. $#_]
646 # Dies if any element of @bind is not in [colname => value] format
647 # if bindtype is 'columns'.
648 sub _assert_bindval_matches_bindtype {
649 # my ($self, @bind) = @_;
651 if ($self->bind_meta) {
653 if (!defined $_ || ref($_) ne 'ARRAY' || @$_ != 2) {
654 die "bindtype 'columns' selected, you need to pass: [column_name => bind_value]"
660 # Fix SQL case, if so requested
662 return $_[0]->lower_case ? $_[1] : uc($_[1]);