Unqualify imported functions
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / SQLMaker.pm
1 package DBIx::Class::SQLMaker;
2
3 =head1 NAME
4
5 DBIx::Class::SQLMaker - An SQL::Abstract-based SQL maker class
6
7 =head1 DESCRIPTION
8
9 This module is a subclass of L<SQL::Abstract> and includes a number of
10 DBIC-specific workarounds, not yet suitable for inclusion into the
11 L<SQL::Abstract> core. It also provides all (and more than) the functionality
12 of L<SQL::Abstract::Limit>, see L<DBIx::Class::SQLMaker::LimitDialects> for
13 more info.
14
15 Currently the enhancements to L<SQL::Abstract> are:
16
17 =over
18
19 =item * Support for C<JOIN> statements (via extended C<table/from> support)
20
21 =item * Support of functions in C<SELECT> lists
22
23 =item * C<GROUP BY>/C<HAVING> support (via extensions to the order_by parameter)
24
25 =item * Support of C<...FOR UPDATE> type of select statement modifiers
26
27 =item * The -ident operator
28
29 =back
30
31 =cut
32
33 use base qw/
34   DBIx::Class::SQLMaker::LimitDialects
35   SQL::Abstract
36   Class::Accessor::Grouped
37 /;
38 use mro 'c3';
39 use strict;
40 use warnings;
41 use Sub::Name 'subname';
42 use Carp::Clan qw/^DBIx::Class|^SQL::Abstract|^Try::Tiny/;
43 use namespace::clean;
44
45 __PACKAGE__->mk_group_accessors (simple => qw/quote_char name_sep limit_dialect/);
46
47 # for when I need a normalized l/r pair
48 sub _quote_chars {
49   map
50     { defined $_ ? $_ : '' }
51     ( ref $_[0]->{quote_char} ? (@{$_[0]->{quote_char}}) : ( ($_[0]->{quote_char}) x 2 ) )
52   ;
53 }
54
55 BEGIN {
56   # reinstall the carp()/croak() functions imported into SQL::Abstract
57   # as Carp and Carp::Clan do not like each other much
58   no warnings qw/redefine/;
59   no strict qw/refs/;
60   for my $f (qw/carp croak/) {
61
62     my $orig = \&{"SQL::Abstract::$f"};
63     my $clan_import = \&{$f};
64     *{"SQL::Abstract::$f"} = subname "SQL::Abstract::$f" =>
65       sub {
66         if (Carp::longmess() =~ /DBIx::Class::SQLMaker::[\w]+ .+? called \s at/x) {
67           goto $clan_import;
68         }
69         else {
70           goto $orig;
71         }
72       };
73   }
74 }
75
76 # the "oh noes offset/top without limit" constant
77 # limited to 32 bits for sanity (and consistency,
78 # since it is ultimately handed to sprintf %u)
79 # Implemented as a method, since ::Storage::DBI also
80 # refers to it (i.e. for the case of software_limit or
81 # as the value to abuse with MSSQL ordered subqueries)
82 sub __max_int { 0xFFFFFFFF };
83
84 sub new {
85   my $self = shift->next::method(@_);
86
87   # use the same coderef, it is prepared to handle both cases
88   push @{$self->{special_ops}}, {
89     regex => qr/^ ident $/xi, handler => '_where_op_IDENT',
90   };
91   push @{$self->{unary_ops}}, {
92     regex => qr/^ ident $/xi, handler => '_where_op_IDENT',
93   };
94
95   $self;
96 }
97
98 sub _where_op_IDENT {
99   my $self = shift;
100   my ($op, $rhs) = splice @_, -2;
101   if (ref $rhs) {
102     croak "-$op takes a single scalar argument (a quotable identifier)";
103   }
104
105   # in case we are called as a top level special op
106   my $lhs = shift;
107
108   $_ = $self->_convert($self->_quote($_)) for ($lhs, $rhs);
109
110   return $lhs
111     ? "$lhs = $rhs"
112     : $rhs
113   ;
114 }
115
116 # Handle limit-dialect selection
117 sub select {
118   my ($self, $table, $fields, $where, $rs_attrs, $limit, $offset) = @_;
119
120
121   $fields = $self->_recurse_fields($fields);
122
123   if (defined $offset) {
124     croak ('A supplied offset must be a non-negative integer')
125       if ( $offset =~ /\D/ or $offset < 0 );
126   }
127   $offset ||= 0;
128
129   if (defined $limit) {
130     croak ('A supplied limit must be a positive integer')
131       if ( $limit =~ /\D/ or $limit <= 0 );
132   }
133   elsif ($offset) {
134     $limit = $self->__max_int;
135   }
136
137
138   my ($sql, @bind);
139   if ($limit) {
140     # this is legacy code-flow from SQLA::Limit, it is not set in stone
141
142     ($sql, @bind) = $self->next::method ($table, $fields, $where);
143
144     my $limiter =
145       $self->can ('emulate_limit')  # also backcompat hook from SQLA::Limit
146         ||
147       do {
148         my $dialect = $self->limit_dialect
149           or croak "Unable to generate SQL-limit - no limit dialect specified on $self, and no emulate_limit method found";
150         $self->can ("_$dialect")
151           or croak (__PACKAGE__ . " does not implement the requested dialect '$dialect'");
152       }
153     ;
154
155     $sql = $self->$limiter ($sql, $rs_attrs, $limit, $offset);
156   }
157   else {
158     ($sql, @bind) = $self->next::method ($table, $fields, $where, $rs_attrs);
159   }
160
161   push @{$self->{where_bind}}, @bind;
162
163 # this *must* be called, otherwise extra binds will remain in the sql-maker
164   my @all_bind = $self->_assemble_binds;
165
166   $sql .= $self->_lock_select ($rs_attrs->{for})
167     if $rs_attrs->{for};
168
169   return wantarray ? ($sql, @all_bind) : $sql;
170 }
171
172 sub _assemble_binds {
173   my $self = shift;
174   return map { @{ (delete $self->{"${_}_bind"}) || [] } } (qw/from where having order/);
175 }
176
177 my $for_syntax = {
178   update => 'FOR UPDATE',
179   shared => 'FOR SHARE',
180 };
181 sub _lock_select {
182   my ($self, $type) = @_;
183   my $sql = $for_syntax->{$type} || croak "Unknown SELECT .. FOR type '$type' requested";
184   return " $sql";
185 }
186
187 # Handle default inserts
188 sub insert {
189 # optimized due to hotttnesss
190 #  my ($self, $table, $data, $options) = @_;
191
192   # SQLA will emit INSERT INTO $table ( ) VALUES ( )
193   # which is sadly understood only by MySQL. Change default behavior here,
194   # until SQLA2 comes with proper dialect support
195   if (! $_[2] or (ref $_[2] eq 'HASH' and !keys %{$_[2]} ) ) {
196     my $sql = "INSERT INTO $_[1] DEFAULT VALUES";
197
198     if (my $ret = ($_[3]||{})->{returning} ) {
199       $sql .= $_[0]->_insert_returning ($ret);
200     }
201
202     return $sql;
203   }
204
205   next::method(@_);
206 }
207
208 sub _recurse_fields {
209   my ($self, $fields) = @_;
210   my $ref = ref $fields;
211   return $self->_quote($fields) unless $ref;
212   return $$fields if $ref eq 'SCALAR';
213
214   if ($ref eq 'ARRAY') {
215     return join(', ', map { $self->_recurse_fields($_) } @$fields);
216   }
217   elsif ($ref eq 'HASH') {
218     my %hash = %$fields;  # shallow copy
219
220     my $as = delete $hash{-as};   # if supplied
221
222     my ($func, $args, @toomany) = %hash;
223
224     # there should be only one pair
225     if (@toomany) {
226       croak "Malformed select argument - too many keys in hash: " . join (',', keys %$fields );
227     }
228
229     if (lc ($func) eq 'distinct' && ref $args eq 'ARRAY' && @$args > 1) {
230       croak (
231         'The select => { distinct => ... } syntax is not supported for multiple columns.'
232        .' Instead please use { group_by => [ qw/' . (join ' ', @$args) . '/ ] }'
233        .' or { select => [ qw/' . (join ' ', @$args) . '/ ], distinct => 1 }'
234       );
235     }
236
237     my $select = sprintf ('%s( %s )%s',
238       $self->_sqlcase($func),
239       $self->_recurse_fields($args),
240       $as
241         ? sprintf (' %s %s', $self->_sqlcase('as'), $self->_quote ($as) )
242         : ''
243     );
244
245     return $select;
246   }
247   # Is the second check absolutely necessary?
248   elsif ( $ref eq 'REF' and ref($$fields) eq 'ARRAY' ) {
249     return $self->_fold_sqlbind( $fields );
250   }
251   else {
252     croak($ref . qq{ unexpected in _recurse_fields()})
253   }
254 }
255
256
257 # this used to be a part of _order_by but is broken out for clarity.
258 # What we have been doing forever is hijacking the $order arg of
259 # SQLA::select to pass in arbitrary pieces of data (first the group_by,
260 # then pretty much the entire resultset attr-hash, as more and more
261 # things in the SQLA space need to have mopre info about the $rs they
262 # create SQL for. The alternative would be to keep expanding the
263 # signature of _select with more and more positional parameters, which
264 # is just gross. All hail SQLA2!
265 sub _parse_rs_attrs {
266   my ($self, $arg) = @_;
267
268   my $sql = '';
269
270   if (my $g = $self->_recurse_fields($arg->{group_by}) ) {
271     $sql .= $self->_sqlcase(' group by ') . $g;
272   }
273
274   if (defined $arg->{having}) {
275     my ($frag, @bind) = $self->_recurse_where($arg->{having});
276     push(@{$self->{having_bind}}, @bind);
277     $sql .= $self->_sqlcase(' having ') . $frag;
278   }
279
280   if (defined $arg->{order_by}) {
281     $sql .= $self->_order_by ($arg->{order_by});
282   }
283
284   return $sql;
285 }
286
287 sub _order_by {
288   my ($self, $arg) = @_;
289
290   # check that we are not called in legacy mode (order_by as 4th argument)
291   if (ref $arg eq 'HASH' and not grep { $_ =~ /^-(?:desc|asc)/i } keys %$arg ) {
292     return $self->_parse_rs_attrs ($arg);
293   }
294   else {
295     my ($sql, @bind) = $self->next::method($arg);
296     push @{$self->{order_bind}}, @bind;
297     return $sql;
298   }
299 }
300
301 sub _table {
302 # optimized due to hotttnesss
303 #  my ($self, $from) = @_;
304   if (my $ref = ref $_[1] ) {
305     if ($ref eq 'ARRAY') {
306       return $_[0]->_recurse_from(@{$_[1]});
307     }
308     elsif ($ref eq 'HASH') {
309       return $_[0]->_make_as($_[1]);
310     }
311   }
312
313   return $_[0]->next::method ($_[1]);
314 }
315
316 sub _generate_join_clause {
317     my ($self, $join_type) = @_;
318
319     return sprintf ('%s JOIN ',
320       $join_type ?  ' ' . uc($join_type) : ''
321     );
322 }
323
324 sub _recurse_from {
325   my ($self, $from, @join) = @_;
326   my @sqlf;
327   push(@sqlf, $self->_make_as($from));
328   foreach my $j (@join) {
329     my ($to, $on) = @$j;
330
331
332     # check whether a join type exists
333     my $to_jt = ref($to) eq 'ARRAY' ? $to->[0] : $to;
334     my $join_type;
335     if (ref($to_jt) eq 'HASH' and defined($to_jt->{-join_type})) {
336       $join_type = $to_jt->{-join_type};
337       $join_type =~ s/^\s+ | \s+$//xg;
338     }
339
340     $join_type = $self->{_default_jointype} if not defined $join_type;
341
342     push @sqlf, $self->_generate_join_clause( $join_type );
343
344     if (ref $to eq 'ARRAY') {
345       push(@sqlf, '(', $self->_recurse_from(@$to), ')');
346     } else {
347       push(@sqlf, $self->_make_as($to));
348     }
349     push(@sqlf, ' ON ', $self->_join_condition($on));
350   }
351   return join('', @sqlf);
352 }
353
354 sub _fold_sqlbind {
355   my ($self, $sqlbind) = @_;
356
357   my @sqlbind = @$$sqlbind; # copy
358   my $sql = shift @sqlbind;
359   push @{$self->{from_bind}}, @sqlbind;
360
361   return $sql;
362 }
363
364 sub _make_as {
365   my ($self, $from) = @_;
366   return join(' ', map { (ref $_ eq 'SCALAR' ? $$_
367                         : ref $_ eq 'REF'    ? $self->_fold_sqlbind($_)
368                         : $self->_quote($_))
369                        } reverse each %{$self->_skip_options($from)});
370 }
371
372 sub _skip_options {
373   my ($self, $hash) = @_;
374   my $clean_hash = {};
375   $clean_hash->{$_} = $hash->{$_}
376     for grep {!/^-/} keys %$hash;
377   return $clean_hash;
378 }
379
380 sub _join_condition {
381   my ($self, $cond) = @_;
382   if (ref $cond eq 'HASH') {
383     my %j;
384     for (keys %$cond) {
385       my $v = $cond->{$_};
386       if (ref $v) {
387         croak (ref($v) . qq{ reference arguments are not supported in JOINS - try using \"..." instead'})
388             if ref($v) ne 'SCALAR';
389         $j{$_} = $v;
390       }
391       else {
392         my $x = '= '.$self->_quote($v); $j{$_} = \$x;
393       }
394     };
395     return scalar($self->_recurse_where(\%j));
396   } elsif (ref $cond eq 'ARRAY') {
397     return join(' OR ', map { $self->_join_condition($_) } @$cond);
398   } else {
399     croak "Can't handle this yet!";
400   }
401 }
402
403 1;
404
405 =head1 AUTHORS
406
407 See L<DBIx::Class/CONTRIBUTORS>.
408
409 =head1 LICENSE
410
411 You may distribute this code under the same terms as Perl itself.
412
413 =cut