26f8dcac1f559a252ba5ba3d69627cf32c8d9c46
[dbsrgits/DBIx-Class-Historic.git] / lib / DBIx / Class / Storage / DBIHacks.pm
1 package   #hide from PAUSE
2   DBIx::Class::Storage::DBIHacks;
3
4 #
5 # This module contains code that should never have seen the light of day,
6 # does not belong in the Storage, or is otherwise unfit for public
7 # display. The arrival of SQLA2 should immediately obsolete 90% of this
8 #
9
10 use strict;
11 use warnings;
12
13 use base 'DBIx::Class::Storage';
14 use mro 'c3';
15
16 use List::Util 'first';
17 use Scalar::Util 'blessed';
18 use DBIx::Class::_Util 'UNRESOLVABLE_CONDITION';
19 use SQL::Abstract qw(is_plain_value is_literal_value);
20 use namespace::clean;
21
22 #
23 # This code will remove non-selecting/non-restricting joins from
24 # {from} specs, aiding the RDBMS query optimizer
25 #
26 sub _prune_unused_joins {
27   my ($self, $attrs) = @_;
28
29   # only standard {from} specs are supported, and we could be disabled in general
30   return ($attrs->{from}, {})  unless (
31     ref $attrs->{from} eq 'ARRAY'
32       and
33     @{$attrs->{from}} > 1
34       and
35     ref $attrs->{from}[0] eq 'HASH'
36       and
37     ref $attrs->{from}[1] eq 'ARRAY'
38       and
39     $self->_use_join_optimizer
40   );
41
42   my $orig_aliastypes = $self->_resolve_aliastypes_from_select_args($attrs);
43
44   my $new_aliastypes = { %$orig_aliastypes };
45
46   # we will be recreating this entirely
47   my @reclassify = 'joining';
48
49   # a grouped set will not be affected by amount of rows. Thus any
50   # purely multiplicator classifications can go
51   # (will be reintroduced below if needed by something else)
52   push @reclassify, qw(multiplying premultiplied)
53     if $attrs->{_force_prune_multiplying_joins} or $attrs->{group_by};
54
55   # nuke what will be recalculated
56   delete @{$new_aliastypes}{@reclassify};
57
58   my @newfrom = $attrs->{from}[0]; # FROM head is always present
59
60   # recalculate what we need once the multipliers are potentially gone
61   # ignore premultiplies, since they do not add any value to anything
62   my %need_joins;
63   for ( @{$new_aliastypes}{grep { $_ ne 'premultiplied' } keys %$new_aliastypes }) {
64     # add all requested aliases
65     $need_joins{$_} = 1 for keys %$_;
66
67     # add all their parents (as per joinpath which is an AoH { table => alias })
68     $need_joins{$_} = 1 for map { values %$_ } map { @{$_->{-parents}} } values %$_;
69   }
70
71   for my $j (@{$attrs->{from}}[1..$#{$attrs->{from}}]) {
72     push @newfrom, $j if (
73       (! defined $j->[0]{-alias}) # legacy crap
74         ||
75       $need_joins{$j->[0]{-alias}}
76     );
77   }
78
79   # we have a new set of joiners - for everything we nuked pull the classification
80   # off the original stack
81   for my $ctype (@reclassify) {
82     $new_aliastypes->{$ctype} = { map
83       { $need_joins{$_} ? ( $_ => $orig_aliastypes->{$ctype}{$_} ) : () }
84       keys %{$orig_aliastypes->{$ctype}}
85     }
86   }
87
88   return ( \@newfrom, $new_aliastypes );
89 }
90
91 #
92 # This is the code producing joined subqueries like:
93 # SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
94 #
95 sub _adjust_select_args_for_complex_prefetch {
96   my ($self, $attrs) = @_;
97
98   $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute') unless (
99     ref $attrs->{from} eq 'ARRAY'
100       and
101     @{$attrs->{from}} > 1
102       and
103     ref $attrs->{from}[0] eq 'HASH'
104       and
105     ref $attrs->{from}[1] eq 'ARRAY'
106   );
107
108   my $root_alias = $attrs->{alias};
109
110   # generate inner/outer attribute lists, remove stuff that doesn't apply
111   my $outer_attrs = { %$attrs };
112   delete @{$outer_attrs}{qw(from bind rows offset group_by _grouped_by_distinct having)};
113
114   my $inner_attrs = { %$attrs };
115   delete @{$inner_attrs}{qw(for collapse select as _related_results_construction)};
116
117   # there is no point of ordering the insides if there is no limit
118   delete $inner_attrs->{order_by} if (
119     delete $inner_attrs->{_order_is_artificial}
120       or
121     ! $inner_attrs->{rows}
122   );
123
124   # generate the inner/outer select lists
125   # for inside we consider only stuff *not* brought in by the prefetch
126   # on the outside we substitute any function for its alias
127   $outer_attrs->{select} = [ @{$attrs->{select}} ];
128
129   my ($root_node, $root_node_offset);
130
131   for my $i (0 .. $#{$inner_attrs->{from}}) {
132     my $node = $inner_attrs->{from}[$i];
133     my $h = (ref $node eq 'HASH')                                ? $node
134           : (ref $node  eq 'ARRAY' and ref $node->[0] eq 'HASH') ? $node->[0]
135           : next
136     ;
137
138     if ( ($h->{-alias}||'') eq $root_alias and $h->{-rsrc} ) {
139       $root_node = $h;
140       $root_node_offset = $i;
141       last;
142     }
143   }
144
145   $self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
146     unless $root_node;
147
148   # use the heavy duty resolver to take care of aliased/nonaliased naming
149   my $colinfo = $self->_resolve_column_info($inner_attrs->{from});
150   my $selected_root_columns;
151
152   for my $i (0 .. $#{$outer_attrs->{select}}) {
153     my $sel = $outer_attrs->{select}->[$i];
154
155     next if (
156       $colinfo->{$sel} and $colinfo->{$sel}{-source_alias} ne $root_alias
157     );
158
159     if (ref $sel eq 'HASH' ) {
160       $sel->{-as} ||= $attrs->{as}[$i];
161       $outer_attrs->{select}->[$i] = join ('.', $root_alias, ($sel->{-as} || "inner_column_$i") );
162     }
163     elsif (! ref $sel and my $ci = $colinfo->{$sel}) {
164       $selected_root_columns->{$ci->{-colname}} = 1;
165     }
166
167     push @{$inner_attrs->{select}}, $sel;
168
169     push @{$inner_attrs->{as}}, $attrs->{as}[$i];
170   }
171
172   # We will need to fetch all native columns in the inner subquery, which may
173   # be a part of an *outer* join condition, or an order_by (which needs to be
174   # preserved outside), or wheres. In other words everything but the inner
175   # selector
176   # We can not just fetch everything because a potential has_many restricting
177   # join collapse *will not work* on heavy data types.
178   my $connecting_aliastypes = $self->_resolve_aliastypes_from_select_args({
179     %$inner_attrs,
180     select => [],
181   });
182
183   for (sort map { keys %{$_->{-seen_columns}||{}} } map { values %$_ } values %$connecting_aliastypes) {
184     my $ci = $colinfo->{$_} or next;
185     if (
186       $ci->{-source_alias} eq $root_alias
187         and
188       ! $selected_root_columns->{$ci->{-colname}}++
189     ) {
190       # adding it to both to keep limits not supporting dark selectors happy
191       push @{$inner_attrs->{select}}, $ci->{-fq_colname};
192       push @{$inner_attrs->{as}}, $ci->{-fq_colname};
193     }
194   }
195
196   # construct the inner {from} and lock it in a subquery
197   # we need to prune first, because this will determine if we need a group_by below
198   # throw away all non-selecting, non-restricting multijoins
199   # (since we def. do not care about multiplication of the contents of the subquery)
200   my $inner_subq = do {
201
202     # must use it here regardless of user requests (vastly gentler on optimizer)
203     local $self->{_use_join_optimizer} = 1;
204
205     # throw away multijoins since we def. do not care about those inside the subquery
206     ($inner_attrs->{from}, my $inner_aliastypes) = $self->_prune_unused_joins ({
207       %$inner_attrs, _force_prune_multiplying_joins => 1
208     });
209
210     # uh-oh a multiplier (which is not us) left in, this is a problem for limits
211     # we will need to add a group_by to collapse the resultset for proper counts
212     if (
213       grep { $_ ne $root_alias } keys %{ $inner_aliastypes->{multiplying} || {} }
214         and
215       # if there are user-supplied groups - assume user knows wtf they are up to
216       ( ! $inner_aliastypes->{grouping} or $inner_attrs->{_grouped_by_distinct} )
217     ) {
218
219       my $cur_sel = { map { $_ => 1 } @{$inner_attrs->{select}} };
220
221       # *possibly* supplement the main selection with pks if not already
222       # there, as they will have to be a part of the group_by to collapse
223       # things properly
224       my $inner_select_with_extras;
225       my @pks = map { "$root_alias.$_" } $root_node->{-rsrc}->primary_columns
226         or $self->throw_exception( sprintf
227           'Unable to perform complex limited prefetch off %s without declared primary key',
228           $root_node->{-rsrc}->source_name,
229         );
230       for my $col (@pks) {
231         push @{ $inner_select_with_extras ||= [ @{$inner_attrs->{select}} ] }, $col
232           unless $cur_sel->{$col}++;
233       }
234
235       ($inner_attrs->{group_by}, $inner_attrs->{order_by}) = $self->_group_over_selection({
236         %$inner_attrs,
237         $inner_select_with_extras ? ( select => $inner_select_with_extras ) : (),
238         _aliastypes => $inner_aliastypes,
239       });
240     }
241
242     # we already optimized $inner_attrs->{from} above
243     # and already local()ized
244     $self->{_use_join_optimizer} = 0;
245
246     # generate the subquery
247     $self->_select_args_to_query (
248       @{$inner_attrs}{qw(from select where)},
249       $inner_attrs,
250     );
251   };
252
253   # Generate the outer from - this is relatively easy (really just replace
254   # the join slot with the subquery), with a major caveat - we can not
255   # join anything that is non-selecting (not part of the prefetch), but at
256   # the same time is a multi-type relationship, as it will explode the result.
257   #
258   # There are two possibilities here
259   # - either the join is non-restricting, in which case we simply throw it away
260   # - it is part of the restrictions, in which case we need to collapse the outer
261   #   result by tackling yet another group_by to the outside of the query
262
263   # work on a shallow copy
264   my @orig_from = @{$attrs->{from}};
265
266
267   $outer_attrs->{from} = \ my @outer_from;
268
269   # we may not be the head
270   if ($root_node_offset) {
271     # first generate the outer_from, up to the substitution point
272     @outer_from = splice @orig_from, 0, $root_node_offset;
273
274     # substitute the subq at the right spot
275     push @outer_from, [
276       {
277         -alias => $root_alias,
278         -rsrc => $root_node->{-rsrc},
279         $root_alias => $inner_subq,
280       },
281       # preserve attrs from what is now the head of the from after the splice
282       @{$orig_from[0]}[1 .. $#{$orig_from[0]}],
283     ];
284   }
285   else {
286     @outer_from = {
287       -alias => $root_alias,
288       -rsrc => $root_node->{-rsrc},
289       $root_alias => $inner_subq,
290     };
291   }
292
293   shift @orig_from; # what we just replaced above
294
295   # scan the *remaining* from spec against different attributes, and see which joins are needed
296   # in what role
297   my $outer_aliastypes = $outer_attrs->{_aliastypes} =
298     $self->_resolve_aliastypes_from_select_args({ %$outer_attrs, from => \@orig_from });
299
300   # unroll parents
301   my ($outer_select_chain, @outer_nonselecting_chains) = map { +{
302     map { $_ => 1 } map { values %$_} map { @{$_->{-parents}} } values %{ $outer_aliastypes->{$_} || {} }
303   } } qw/selecting restricting grouping ordering/;
304
305   # see what's left - throw away if not selecting/restricting
306   my $may_need_outer_group_by;
307   while (my $j = shift @orig_from) {
308     my $alias = $j->[0]{-alias};
309
310     if (
311       $outer_select_chain->{$alias}
312     ) {
313       push @outer_from, $j
314     }
315     elsif (first { $_->{$alias} } @outer_nonselecting_chains ) {
316       push @outer_from, $j;
317       $may_need_outer_group_by ||= $outer_aliastypes->{multiplying}{$alias} ? 1 : 0;
318     }
319   }
320
321   # also throw in a synthetic group_by if a non-selecting multiplier,
322   # to guard against cross-join explosions
323   # the logic is somewhat fragile, but relies on the idea that if a user supplied
324   # a group by on their own - they know what they were doing
325   if ( $may_need_outer_group_by and $attrs->{_grouped_by_distinct} ) {
326     ($outer_attrs->{group_by}, $outer_attrs->{order_by}) = $self->_group_over_selection ({
327       %$outer_attrs,
328       from => \@outer_from,
329     });
330   }
331
332   # This is totally horrific - the {where} ends up in both the inner and outer query
333   # Unfortunately not much can be done until SQLA2 introspection arrives, and even
334   # then if where conditions apply to the *right* side of the prefetch, you may have
335   # to both filter the inner select (e.g. to apply a limit) and then have to re-filter
336   # the outer select to exclude joins you didn't want in the first place
337   #
338   # OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
339   return $outer_attrs;
340 }
341
342 #
343 # I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
344 #
345 # Due to a lack of SQLA2 we fall back to crude scans of all the
346 # select/where/order/group attributes, in order to determine what
347 # aliases are needed to fulfill the query. This information is used
348 # throughout the code to prune unnecessary JOINs from the queries
349 # in an attempt to reduce the execution time.
350 # Although the method is pretty horrific, the worst thing that can
351 # happen is for it to fail due to some scalar SQL, which in turn will
352 # result in a vocal exception.
353 sub _resolve_aliastypes_from_select_args {
354   my ( $self, $attrs ) = @_;
355
356   $self->throw_exception ('Unable to analyze custom {from}')
357     if ref $attrs->{from} ne 'ARRAY';
358
359   # what we will return
360   my $aliases_by_type;
361
362   # see what aliases are there to work with
363   # and record who is a multiplier and who is premultiplied
364   my $alias_list;
365   for my $node (@{$attrs->{from}}) {
366
367     my $j = $node;
368     $j = $j->[0] if ref $j eq 'ARRAY';
369     my $al = $j->{-alias}
370       or next;
371
372     $alias_list->{$al} = $j;
373
374     $aliases_by_type->{multiplying}{$al} ||= { -parents => $j->{-join_path}||[] }
375       # not array == {from} head == can't be multiplying
376       if ref($node) eq 'ARRAY' and ! $j->{-is_single};
377
378     $aliases_by_type->{premultiplied}{$al} ||= { -parents => $j->{-join_path}||[] }
379       # parts of the path that are not us but are multiplying
380       if grep { $aliases_by_type->{multiplying}{$_} }
381           grep { $_ ne $al }
382            map { values %$_ }
383             @{ $j->{-join_path}||[] }
384   }
385
386   # get a column to source/alias map (including unambiguous unqualified ones)
387   my $colinfo = $self->_resolve_column_info ($attrs->{from});
388
389   # set up a botched SQLA
390   my $sql_maker = $self->sql_maker;
391
392   # these are throw away results, do not pollute the bind stack
393   local $sql_maker->{where_bind};
394   local $sql_maker->{group_bind};
395   local $sql_maker->{having_bind};
396   local $sql_maker->{from_bind};
397
398   # we can't scan properly without any quoting (\b doesn't cut it
399   # everywhere), so unless there is proper quoting set - use our
400   # own weird impossible character.
401   # Also in the case of no quoting, we need to explicitly disable
402   # name_sep, otherwise sorry nasty legacy syntax like
403   # { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
404   local $sql_maker->{quote_char} = $sql_maker->{quote_char};
405   local $sql_maker->{name_sep} = $sql_maker->{name_sep};
406
407   unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
408     $sql_maker->{quote_char} = ["\x00", "\xFF"];
409     # if we don't unset it we screw up retarded but unfortunately working
410     # 'MAX(foo.bar)' => { '>', 3 }
411     $sql_maker->{name_sep} = '';
412   }
413
414   my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
415
416   # generate sql chunks
417   my $to_scan = {
418     restricting => [
419       $sql_maker->_recurse_where ($attrs->{where}),
420       $sql_maker->_parse_rs_attrs ({ having => $attrs->{having} }),
421     ],
422     grouping => [
423       $sql_maker->_parse_rs_attrs ({ group_by => $attrs->{group_by} }),
424     ],
425     joining => [
426       $sql_maker->_recurse_from (
427         ref $attrs->{from}[0] eq 'ARRAY' ? $attrs->{from}[0][0] : $attrs->{from}[0],
428         @{$attrs->{from}}[1 .. $#{$attrs->{from}}],
429       ),
430     ],
431     selecting => [
432       map { ($sql_maker->_recurse_fields($_))[0] } @{$attrs->{select}},
433     ],
434     ordering => [
435       map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker),
436     ],
437   };
438
439   # throw away empty chunks and all 2-value arrayrefs: the thinking is that these are
440   # bind value specs left in by the sloppy renderer above. It is ok to do this
441   # at this point, since we are going to end up rewriting this crap anyway
442   for my $v (values %$to_scan) {
443     my @nv;
444     for (@$v) {
445       next if (
446         ! defined $_
447           or
448         (
449           ref $_ eq 'ARRAY'
450             and
451           ( @$_ == 0 or @$_ == 2 )
452         )
453       );
454
455       if (ref $_) {
456         require Data::Dumper::Concise;
457         $self->throw_exception("Unexpected ref in scan-plan: " . Data::Dumper::Concise::Dumper($v) );
458       }
459
460       push @nv, $_;
461     }
462
463     $v = \@nv;
464   }
465
466   # kill all selectors which look like a proper subquery
467   # this is a sucky heuristic *BUT* - if we get it wrong the query will simply
468   # fail to run, so we are relatively safe
469   $to_scan->{selecting} = [ grep {
470     $_ !~ / \A \s* \( \s* SELECT \s+ .+? \s+ FROM \s+ .+? \) \s* \z /xsi
471   } @{ $to_scan->{selecting} || [] } ];
472
473   # first see if we have any exact matches (qualified or unqualified)
474   for my $type (keys %$to_scan) {
475     for my $piece (@{$to_scan->{$type}}) {
476       if ($colinfo->{$piece} and my $alias = $colinfo->{$piece}{-source_alias}) {
477         $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
478         $aliases_by_type->{$type}{$alias}{-seen_columns}{$colinfo->{$piece}{-fq_colname}} = $piece;
479       }
480     }
481   }
482
483   # now loop through all fully qualified columns and get the corresponding
484   # alias (should work even if they are in scalarrefs)
485   for my $alias (keys %$alias_list) {
486     my $al_re = qr/
487       $lquote $alias $rquote $sep (?: $lquote ([^$rquote]+) $rquote )?
488         |
489       \b $alias \. ([^\s\)\($rquote]+)?
490     /x;
491
492     for my $type (keys %$to_scan) {
493       for my $piece (@{$to_scan->{$type}}) {
494         if (my @matches = $piece =~ /$al_re/g) {
495           $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
496           $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = "$alias.$_"
497             for grep { defined $_ } @matches;
498         }
499       }
500     }
501   }
502
503   # now loop through unqualified column names, and try to locate them within
504   # the chunks
505   for my $col (keys %$colinfo) {
506     next if $col =~ / \. /x;   # if column is qualified it was caught by the above
507
508     my $col_re = qr/ $lquote ($col) $rquote /x;
509
510     for my $type (keys %$to_scan) {
511       for my $piece (@{$to_scan->{$type}}) {
512         if ( my @matches = $piece =~ /$col_re/g) {
513           my $alias = $colinfo->{$col}{-source_alias};
514           $aliases_by_type->{$type}{$alias} ||= { -parents => $alias_list->{$alias}{-join_path}||[] };
515           $aliases_by_type->{$type}{$alias}{-seen_columns}{"$alias.$_"} = $_
516             for grep { defined $_ } @matches;
517         }
518       }
519     }
520   }
521
522   # Add any non-left joins to the restriction list (such joins are indeed restrictions)
523   for my $j (values %$alias_list) {
524     my $alias = $j->{-alias} or next;
525     $aliases_by_type->{restricting}{$alias} ||= { -parents => $j->{-join_path}||[] } if (
526       (not $j->{-join_type})
527         or
528       ($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
529     );
530   }
531
532   for (keys %$aliases_by_type) {
533     delete $aliases_by_type->{$_} unless keys %{$aliases_by_type->{$_}};
534   }
535
536   return $aliases_by_type;
537 }
538
539 # This is the engine behind { distinct => 1 } and the general
540 # complex prefetch grouper
541 sub _group_over_selection {
542   my ($self, $attrs) = @_;
543
544   my $colinfos = $self->_resolve_column_info ($attrs->{from});
545
546   my (@group_by, %group_index);
547
548   # the logic is: if it is a { func => val } we assume an aggregate,
549   # otherwise if \'...' or \[...] we assume the user knows what is
550   # going on thus group over it
551   for (@{$attrs->{select}}) {
552     if (! ref($_) or ref ($_) ne 'HASH' ) {
553       push @group_by, $_;
554       $group_index{$_}++;
555       if ($colinfos->{$_} and $_ !~ /\./ ) {
556         # add a fully qualified version as well
557         $group_index{"$colinfos->{$_}{-source_alias}.$_"}++;
558       }
559     }
560   }
561
562   my @order_by = $self->_extract_order_criteria($attrs->{order_by})
563     or return (\@group_by, $attrs->{order_by});
564
565   # add any order_by parts that are not already present in the group_by
566   # to maintain SQL cross-compatibility and general sanity
567   #
568   # also in case the original selection is *not* unique, or in case part
569   # of the ORDER BY refers to a multiplier - we will need to replace the
570   # skipped order_by elements with their MIN/MAX equivalents as to maintain
571   # the proper overall order without polluting the group criteria (and
572   # possibly changing the outcome entirely)
573
574   my ($leftovers, $sql_maker, @new_order_by, $order_chunks, $aliastypes);
575
576   my $group_already_unique = $self->_columns_comprise_identifying_set($colinfos, \@group_by);
577
578   for my $o_idx (0 .. $#order_by) {
579
580     # if the chunk is already a min/max function - there is nothing left to touch
581     next if $order_by[$o_idx][0] =~ /^ (?: min | max ) \s* \( .+ \) $/ix;
582
583     # only consider real columns (for functions the user got to do an explicit group_by)
584     my $chunk_ci;
585     if (
586       @{$order_by[$o_idx]} != 1
587         or
588       # only declare an unknown *plain* identifier as "leftover" if we are called with
589       # aliastypes to examine. If there are none - we are still in _resolve_attrs, and
590       # can just assume the user knows what they want
591       ( ! ( $chunk_ci = $colinfos->{$order_by[$o_idx][0]} ) and $attrs->{_aliastypes} )
592     ) {
593       push @$leftovers, $order_by[$o_idx][0];
594     }
595
596     next unless $chunk_ci;
597
598     # no duplication of group criteria
599     next if $group_index{$chunk_ci->{-fq_colname}};
600
601     $aliastypes ||= (
602       $attrs->{_aliastypes}
603         or
604       $self->_resolve_aliastypes_from_select_args({
605         from => $attrs->{from},
606         order_by => $attrs->{order_by},
607       })
608     ) if $group_already_unique;
609
610     # check that we are not ordering by a multiplier (if a check is requested at all)
611     if (
612       $group_already_unique
613         and
614       ! $aliastypes->{multiplying}{$chunk_ci->{-source_alias}}
615         and
616       ! $aliastypes->{premultiplied}{$chunk_ci->{-source_alias}}
617     ) {
618       push @group_by, $chunk_ci->{-fq_colname};
619       $group_index{$chunk_ci->{-fq_colname}}++
620     }
621     else {
622       # We need to order by external columns without adding them to the group
623       # (eiehter a non-unique selection, or a multi-external)
624       #
625       # This doesn't really make sense in SQL, however from DBICs point
626       # of view is rather valid (e.g. order the leftmost objects by whatever
627       # criteria and get the offset/rows many). There is a way around
628       # this however in SQL - we simply tae the direction of each piece
629       # of the external order and convert them to MIN(X) for ASC or MAX(X)
630       # for DESC, and group_by the root columns. The end result should be
631       # exactly what we expect
632
633       # FIXME - this code is a joke, will need to be completely rewritten in
634       # the DQ branch. But I need to push a POC here, otherwise the
635       # pesky tests won't pass
636       # wrap any part of the order_by that "responds" to an ordering alias
637       # into a MIN/MAX
638       $sql_maker ||= $self->sql_maker;
639       $order_chunks ||= [
640         map { ref $_ eq 'ARRAY' ? $_ : [ $_ ] } $sql_maker->_order_by_chunks($attrs->{order_by})
641       ];
642
643       my ($chunk, $is_desc) = $sql_maker->_split_order_chunk($order_chunks->[$o_idx][0]);
644
645       $new_order_by[$o_idx] = \[
646         sprintf( '%s( %s )%s',
647           ($is_desc ? 'MAX' : 'MIN'),
648           $chunk,
649           ($is_desc ? ' DESC' : ''),
650         ),
651         @ {$order_chunks->[$o_idx]} [ 1 .. $#{$order_chunks->[$o_idx]} ]
652       ];
653     }
654   }
655
656   $self->throw_exception ( sprintf
657     'Unable to programatically derive a required group_by from the supplied '
658   . 'order_by criteria. To proceed either add an explicit group_by, or '
659   . 'simplify your order_by to only include plain columns '
660   . '(supplied order_by: %s)',
661     join ', ', map { "'$_'" } @$leftovers,
662   ) if $leftovers;
663
664   # recreate the untouched order parts
665   if (@new_order_by) {
666     $new_order_by[$_] ||= \ $order_chunks->[$_] for ( 0 .. $#$order_chunks );
667   }
668
669   return (
670     \@group_by,
671     (@new_order_by ? \@new_order_by : $attrs->{order_by} ),  # same ref as original == unchanged
672   );
673 }
674
675 sub _resolve_ident_sources {
676   my ($self, $ident) = @_;
677
678   my $alias2source = {};
679
680   # the reason this is so contrived is that $ident may be a {from}
681   # structure, specifying multiple tables to join
682   if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
683     # this is compat mode for insert/update/delete which do not deal with aliases
684     $alias2source->{me} = $ident;
685   }
686   elsif (ref $ident eq 'ARRAY') {
687
688     for (@$ident) {
689       my $tabinfo;
690       if (ref $_ eq 'HASH') {
691         $tabinfo = $_;
692       }
693       if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
694         $tabinfo = $_->[0];
695       }
696
697       $alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc}
698         if ($tabinfo->{-rsrc});
699     }
700   }
701
702   return $alias2source;
703 }
704
705 # Takes $ident, \@column_names
706 #
707 # returns { $column_name => \%column_info, ... }
708 # also note: this adds -result_source => $rsrc to the column info
709 #
710 # If no columns_names are supplied returns info about *all* columns
711 # for all sources
712 sub _resolve_column_info {
713   my ($self, $ident, $colnames) = @_;
714
715   return {} if $colnames and ! @$colnames;
716
717   my $alias2src = $self->_resolve_ident_sources($ident);
718
719   my (%seen_cols, @auto_colnames);
720
721   # compile a global list of column names, to be able to properly
722   # disambiguate unqualified column names (if at all possible)
723   for my $alias (keys %$alias2src) {
724     my $rsrc = $alias2src->{$alias};
725     for my $colname ($rsrc->columns) {
726       push @{$seen_cols{$colname}}, $alias;
727       push @auto_colnames, "$alias.$colname" unless $colnames;
728     }
729   }
730
731   $colnames ||= [
732     @auto_colnames,
733     grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
734   ];
735
736   my (%return, $colinfos);
737   foreach my $col (@$colnames) {
738     my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
739
740     # if the column was seen exactly once - we know which rsrc it came from
741     $source_alias ||= $seen_cols{$colname}[0]
742       if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
743
744     next unless $source_alias;
745
746     my $rsrc = $alias2src->{$source_alias}
747       or next;
748
749     $return{$col} = {
750       %{
751           ( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname}
752             ||
753           $self->throw_exception(
754             "No such column '$colname' on source " . $rsrc->source_name
755           );
756       },
757       -result_source => $rsrc,
758       -source_alias => $source_alias,
759       -fq_colname => $col eq $colname ? "$source_alias.$col" : $col,
760       -colname => $colname,
761     };
762
763     $return{"$source_alias.$colname"} = $return{$col} if $col eq $colname;
764   }
765
766   return \%return;
767 }
768
769 # The DBIC relationship chaining implementation is pretty simple - every
770 # new related_relationship is pushed onto the {from} stack, and the {select}
771 # window simply slides further in. This means that when we count somewhere
772 # in the middle, we got to make sure that everything in the join chain is an
773 # actual inner join, otherwise the count will come back with unpredictable
774 # results (a resultset may be generated with _some_ rows regardless of if
775 # the relation which the $rs currently selects has rows or not). E.g.
776 # $artist_rs->cds->count - normally generates:
777 # SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
778 # which actually returns the number of artists * (number of cds || 1)
779 #
780 # So what we do here is crawl {from}, determine if the current alias is at
781 # the top of the stack, and if not - make sure the chain is inner-joined down
782 # to the root.
783 #
784 sub _inner_join_to_node {
785   my ($self, $from, $alias) = @_;
786
787   my $switch_branch = $self->_find_join_path_to_node($from, $alias);
788
789   return $from unless @{$switch_branch||[]};
790
791   # So it looks like we will have to switch some stuff around.
792   # local() is useless here as we will be leaving the scope
793   # anyway, and deep cloning is just too fucking expensive
794   # So replace the first hashref in the node arrayref manually
795   my @new_from = ($from->[0]);
796   my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
797
798   for my $j (@{$from}[1 .. $#$from]) {
799     my $jalias = $j->[0]{-alias};
800
801     if ($sw_idx->{$jalias}) {
802       my %attrs = %{$j->[0]};
803       delete $attrs{-join_type};
804       push @new_from, [
805         \%attrs,
806         @{$j}[ 1 .. $#$j ],
807       ];
808     }
809     else {
810       push @new_from, $j;
811     }
812   }
813
814   return \@new_from;
815 }
816
817 sub _find_join_path_to_node {
818   my ($self, $from, $target_alias) = @_;
819
820   # subqueries and other oddness are naturally not supported
821   return undef if (
822     ref $from ne 'ARRAY'
823       ||
824     ref $from->[0] ne 'HASH'
825       ||
826     ! defined $from->[0]{-alias}
827   );
828
829   # no path - the head is the alias
830   return [] if $from->[0]{-alias} eq $target_alias;
831
832   for my $i (1 .. $#$from) {
833     return $from->[$i][0]{-join_path} if ( ($from->[$i][0]{-alias}||'') eq $target_alias );
834   }
835
836   # something else went quite wrong
837   return undef;
838 }
839
840 sub _extract_order_criteria {
841   my ($self, $order_by, $sql_maker) = @_;
842
843   my $parser = sub {
844     my ($sql_maker, $order_by, $orig_quote_chars) = @_;
845
846     return scalar $sql_maker->_order_by_chunks ($order_by)
847       unless wantarray;
848
849     my ($lq, $rq, $sep) = map { quotemeta($_) } (
850       ($orig_quote_chars ? @$orig_quote_chars : $sql_maker->_quote_chars),
851       $sql_maker->name_sep
852     );
853
854     my @chunks;
855     for ($sql_maker->_order_by_chunks ($order_by) ) {
856       my $chunk = ref $_ ? [ @$_ ] : [ $_ ];
857       ($chunk->[0]) = $sql_maker->_split_order_chunk($chunk->[0]);
858
859       # order criteria may have come back pre-quoted (literals and whatnot)
860       # this is fragile, but the best we can currently do
861       $chunk->[0] =~ s/^ $lq (.+?) $rq $sep $lq (.+?) $rq $/"$1.$2"/xe
862         or $chunk->[0] =~ s/^ $lq (.+) $rq $/$1/x;
863
864       push @chunks, $chunk;
865     }
866
867     return @chunks;
868   };
869
870   if ($sql_maker) {
871     return $parser->($sql_maker, $order_by);
872   }
873   else {
874     $sql_maker = $self->sql_maker;
875
876     # pass these in to deal with literals coming from
877     # the user or the deep guts of prefetch
878     my $orig_quote_chars = [$sql_maker->_quote_chars];
879
880     local $sql_maker->{quote_char};
881     return $parser->($sql_maker, $order_by, $orig_quote_chars);
882   }
883 }
884
885 sub _order_by_is_stable {
886   my ($self, $ident, $order_by, $where) = @_;
887
888   my @cols = (
889     ( map { $_->[0] } $self->_extract_order_criteria($order_by) ),
890     ( $where ? keys %{ $self->_extract_fixed_condition_columns($where) } : () ),
891   ) or return 0;
892
893   my $colinfo = $self->_resolve_column_info($ident, \@cols);
894
895   return keys %$colinfo
896     ? $self->_columns_comprise_identifying_set( $colinfo,  \@cols )
897     : 0
898   ;
899 }
900
901 sub _columns_comprise_identifying_set {
902   my ($self, $colinfo, $columns) = @_;
903
904   my $cols_per_src;
905   $cols_per_src -> {$_->{-source_alias}} -> {$_->{-colname}} = $_
906     for grep { defined $_ } @{$colinfo}{@$columns};
907
908   for (values %$cols_per_src) {
909     my $src = (values %$_)[0]->{-result_source};
910     return 1 if $src->_identifying_column_set($_);
911   }
912
913   return 0;
914 }
915
916 # this is almost similar to _order_by_is_stable, except it takes
917 # a single rsrc, and will succeed only if the first portion of the order
918 # by is stable.
919 # returns that portion as a colinfo hashref on success
920 sub _extract_colinfo_of_stable_main_source_order_by_portion {
921   my ($self, $attrs) = @_;
922
923   my $nodes = $self->_find_join_path_to_node($attrs->{from}, $attrs->{alias});
924
925   return unless defined $nodes;
926
927   my @ord_cols = map
928     { $_->[0] }
929     ( $self->_extract_order_criteria($attrs->{order_by}) )
930   ;
931   return unless @ord_cols;
932
933   my $valid_aliases = { map { $_ => 1 } (
934     $attrs->{from}[0]{-alias},
935     map { values %$_ } @$nodes,
936   ) };
937
938   my $colinfos = $self->_resolve_column_info($attrs->{from});
939
940   my ($colinfos_to_return, $seen_main_src_cols);
941
942   for my $col (@ord_cols) {
943     # if order criteria is unresolvable - there is nothing we can do
944     my $colinfo = $colinfos->{$col} or last;
945
946     # if we reached the end of the allowed aliases - also nothing we can do
947     last unless $valid_aliases->{$colinfo->{-source_alias}};
948
949     $colinfos_to_return->{$col} = $colinfo;
950
951     $seen_main_src_cols->{$colinfo->{-colname}} = 1
952       if $colinfo->{-source_alias} eq $attrs->{alias};
953   }
954
955   # FIXME the condition may be singling out things on its own, so we
956   # conceivable could come back wi "stable-ordered by nothing"
957   # not confient enough in the parser yet, so punt for the time being
958   return unless $seen_main_src_cols;
959
960   my $main_src_fixed_cols_from_cond = [ $attrs->{where}
961     ? (
962       map
963       {
964         ( $colinfos->{$_} and $colinfos->{$_}{-source_alias} eq $attrs->{alias} )
965           ? $colinfos->{$_}{-colname}
966           : ()
967       }
968       keys %{ $self->_extract_fixed_condition_columns($attrs->{where}) }
969     )
970     : ()
971   ];
972
973   return $attrs->{result_source}->_identifying_column_set([
974     keys %$seen_main_src_cols,
975     @$main_src_fixed_cols_from_cond,
976   ]) ? $colinfos_to_return : ();
977 }
978
979 # Attempts to flatten a passed in SQLA condition as much as possible towards
980 # a plain hashref, *without* altering its semantics. Required by
981 # create/populate being able to extract definitive conditions from preexisting
982 # resultset {where} stacks
983 #
984 # FIXME - while relatively robust, this is still imperfect, one of the first
985 # things to tackle with DQ
986 sub _collapse_cond {
987   my ($self, $where, $where_is_anded_array) = @_;
988
989   if (! $where) {
990     return;
991   }
992   elsif ($where_is_anded_array or ref $where eq 'HASH') {
993
994     my @pairs;
995
996     my @pieces = $where_is_anded_array ? @$where : $where;
997     while (@pieces) {
998       my $chunk = shift @pieces;
999
1000       if (ref $chunk eq 'HASH') {
1001         push @pairs, map { [ $_ => $chunk->{$_} ] } sort keys %$chunk;
1002       }
1003       elsif (ref $chunk eq 'ARRAY') {
1004         push @pairs, [ -or => $chunk ]
1005           if @$chunk;
1006       }
1007       elsif ( ! ref $chunk) {
1008         push @pairs, [ $chunk, shift @pieces ];
1009       }
1010       else {
1011         push @pairs, [ '', $chunk ];
1012       }
1013     }
1014
1015     return unless @pairs;
1016
1017     my @conds = $self->_collapse_cond_unroll_pairs(\@pairs)
1018       or return;
1019
1020     # Consolidate various @conds back into something more compact
1021     my $fin;
1022
1023     for my $c (@conds) {
1024       if (ref $c ne 'HASH') {
1025         push @{$fin->{-and}}, $c;
1026       }
1027       else {
1028         for my $col (sort keys %$c) {
1029           if (exists $fin->{$col}) {
1030             my ($l, $r) = ($fin->{$col}, $c->{$col});
1031
1032             (ref $_ ne 'ARRAY' or !@$_) and $_ = [ -and => $_ ] for ($l, $r);
1033
1034             if (@$l and @$r and $l->[0] eq $r->[0] and $l->[0] eq '-and') {
1035               $fin->{$col} = [ -and => map { @$_[1..$#$_] } ($l, $r) ];
1036             }
1037             else {
1038               $fin->{$col} = [ -and => $fin->{$col}, $c->{$col} ];
1039             }
1040           }
1041           else {
1042             $fin->{$col} = $c->{$col};
1043           }
1044         }
1045       }
1046     }
1047
1048     if ( ref $fin->{-and} eq 'ARRAY' and @{$fin->{-and}} == 1 ) {
1049       my $piece = (delete $fin->{-and})->[0];
1050       if (ref $piece eq 'ARRAY') {
1051         $fin->{-or} = $fin->{-or} ? [ $piece, $fin->{-or} ] : $piece;
1052       }
1053       elsif (! exists $fin->{''}) {
1054         $fin->{''} = $piece;
1055       }
1056     }
1057
1058     return $fin;
1059   }
1060   elsif (ref $where eq 'ARRAY') {
1061     my @w = @$where;
1062
1063     while ( @w and (
1064       (ref $w[0] eq 'ARRAY' and ! @{$w[0]} )
1065         or
1066       (ref $w[0] eq 'HASH' and ! keys %{$w[0]})
1067     )) { shift @w };
1068
1069     return unless @w;
1070
1071     if ( @w == 1 ) {
1072       return ( ref $w[0] )
1073         ? $self->_collapse_cond($w[0])
1074         : { $w[0] => undef }
1075       ;
1076     }
1077     elsif ( @w == 2 and ! ref $w[0]) {
1078       if ( ( $w[0]||'' ) =~ /^\-and$/i ) {
1079         return (ref $w[1] eq 'HASH' or ref $w[1] eq 'ARRAY')
1080           ? $self->_collapse_cond($w[1], (ref $w[1] eq 'ARRAY') )
1081           : $self->throw_exception("Unsupported top-level op/arg pair: [ $w[0] => $w[1] ]")
1082         ;
1083       }
1084       else {
1085         return $self->_collapse_cond({ @w });
1086       }
1087     }
1088     else {
1089       return { -or => \@w };
1090     }
1091   }
1092   else {
1093     # not a hash not an array
1094     return { '' => $where };
1095   }
1096
1097   die 'should not get here';
1098 }
1099
1100 sub _collapse_cond_unroll_pairs {
1101   my ($self, $pairs) = @_;
1102
1103   my @conds;
1104
1105   while (@$pairs) {
1106     my ($lhs, $rhs) = @{ shift @$pairs };
1107
1108     if ($lhs eq '') {
1109       push @conds, $self->_collapse_cond($rhs);
1110     }
1111     elsif ( $lhs =~ /^\-and$/i ) {
1112       push @conds, $self->_collapse_cond($rhs, (ref $rhs eq 'ARRAY'));
1113     }
1114     elsif ( $lhs =~ /^\-or$/i ) {
1115       push @conds, $self->_collapse_cond(
1116         (ref $rhs eq 'HASH') ? [ map { $_ => $rhs->{$_} } sort keys %$rhs ] : $rhs
1117       );
1118     }
1119     else {
1120       if (ref $rhs eq 'HASH' and ! keys %$rhs) {
1121         # FIXME - SQLA seems to be doing... nothing...?
1122       }
1123       elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{-ident}) {
1124         push @conds, { $lhs => { '=', $rhs } };
1125       }
1126       elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{-value} and is_plain_value $rhs->{-value}) {
1127         push @conds, { $lhs => $rhs->{-value} };
1128       }
1129       elsif (ref $rhs eq 'HASH' and keys %$rhs == 1 and exists $rhs->{'='}) {
1130         if( is_literal_value $rhs->{'='}) {
1131           push @conds, { $lhs => $rhs };
1132         }
1133         else {
1134           for my $p ($self->_collapse_cond_unroll_pairs([ [ $lhs => $rhs->{'='} ] ])) {
1135
1136             # extra sanity check
1137             if (keys %$p > 1) {
1138               require Data::Dumper::Concise;
1139               local $Data::Dumper::Deepcopy = 1;
1140               $self->throw_exception(
1141                 "Internal error: unexpected collapse unroll:"
1142               . Data::Dumper::Concise::Dumper { in => { $lhs => $rhs }, out => $p }
1143               );
1144             }
1145
1146             my ($l, $r) = %$p;
1147
1148             push @conds, ( ! length ref $r or is_plain_value($r) )
1149               ? { $l => $r }
1150               : { $l => { '=' => $r } }
1151             ;
1152           }
1153         }
1154       }
1155       elsif (ref $rhs eq 'ARRAY') {
1156         # some of these conditionals encounter multi-values - roll them out using
1157         # an unshift, which will cause extra looping in the while{} above
1158         if (! @$rhs ) {
1159           push @conds, { $lhs => [] };
1160         }
1161         elsif ( ($rhs->[0]||'') =~ /^\-(?:and|or)$/i ) {
1162           $self->throw_exception("Value modifier not followed by any values: $lhs => [ $rhs->[0] ] ")
1163             if  @$rhs == 1;
1164
1165           if( $rhs->[0] =~ /^\-and$/i ) {
1166             unshift @$pairs, map { [ $lhs => $_ ] } @{$rhs}[1..$#$rhs];
1167           }
1168           # if not an AND then it's an OR
1169           elsif(@$rhs == 2) {
1170             unshift @$pairs, [ $lhs => $rhs->[1] ];
1171           }
1172           else {
1173             push @conds, { $lhs => $rhs };
1174           }
1175         }
1176         elsif (@$rhs == 1) {
1177           unshift @$pairs, [ $lhs => $rhs->[0] ];
1178         }
1179         else {
1180           push @conds, { $lhs => $rhs };
1181         }
1182       }
1183       else {
1184         push @conds, { $lhs => $rhs };
1185       }
1186     }
1187   }
1188
1189   return @conds;
1190 }
1191
1192 # Analyzes a given condition and attempts to extract all columns
1193 # with a definitive fixed-condition criteria. Returns a hashref
1194 # of k/v pairs suitable to be passed to set_columns(), with a
1195 # MAJOR CAVEAT - multi-value (contradictory) equalities are still
1196 # represented as a reference to the UNRESOVABLE_CONDITION constant
1197 # The reason we do this is that some codepaths only care about the
1198 # codition being stable, as opposed to actually making sense
1199 #
1200 # The normal mode is used to figure out if a resultset is constrained
1201 # to a column which is part of a unique constraint, which in turn
1202 # allows us to better predict how ordering will behave etc.
1203 #
1204 # With the optional "consider_nulls" boolean argument, the function
1205 # is instead used to infer inambiguous values from conditions
1206 # (e.g. the inheritance of resultset conditions on new_result)
1207 #
1208 my $undef_marker = \ do{ my $x = 'undef' };
1209 sub _extract_fixed_condition_columns {
1210   my ($self, $where, $consider_nulls) = @_;
1211   my $where_hash = $self->_collapse_cond($_[1]);
1212
1213   my $res = {};
1214   my ($c, $v);
1215   for $c (keys %$where_hash) {
1216     my $vals;
1217
1218     if (!defined ($v = $where_hash->{$c}) ) {
1219       $vals->{$undef_marker} = $v if $consider_nulls
1220     }
1221     elsif (
1222       ref $v eq 'HASH'
1223         and
1224       keys %$v == 1
1225     ) {
1226       if (exists $v->{-value}) {
1227         if (defined $v->{-value}) {
1228           $vals->{$v->{-value}} = $v->{-value}
1229         }
1230         elsif( $consider_nulls ) {
1231           $vals->{$undef_marker} = $v->{-value};
1232         }
1233       }
1234       # do not need to check for plain values - _collapse_cond did it for us
1235       elsif(ref $v->{'='} and is_literal_value($v->{'='}) ) {
1236         $vals->{$v->{'='}} = $v->{'='};
1237       }
1238     }
1239     elsif (
1240       ! length ref $v
1241         or
1242       is_plain_value ($v)
1243     ) {
1244       $vals->{$v} = $v;
1245     }
1246     elsif (ref $v eq 'ARRAY' and ($v->[0]||'') eq '-and') {
1247       for ( @{$v}[1..$#$v] ) {
1248         my $subval = $self->_extract_fixed_condition_columns({ $c => $_ }, 'consider nulls');  # always fish nulls out on recursion
1249         next unless exists $subval->{$c};  # didn't find anything
1250         $vals->{defined $subval->{$c} ? $subval->{$c} : $undef_marker} = $subval->{$c};
1251       }
1252     }
1253
1254     if (keys %$vals == 1) {
1255       ($res->{$c}) = (values %$vals)
1256         unless !$consider_nulls and exists $vals->{$undef_marker};
1257     }
1258     elsif (keys %$vals > 1) {
1259       $res->{$c} = UNRESOLVABLE_CONDITION;
1260     }
1261   }
1262
1263   $res;
1264 }
1265
1266 1;