/usr/local/CPAN/DBIx-Class/DBIHacks.pm
package #hide from PAUSE
DBIx::Class::Storage::DBIHacks;
#
# This module contains code that should never have seen the light of day,
# does not belong in the Storage, or is otherwise unfit for public
# display. The arrival of SQLA2 should immediately oboslete 90% of this
#
use strict;
use warnings;
use base 'DBIx::Class::Storage';
use mro 'c3';
use List::Util 'first';
use Scalar::Util 'blessed';
use namespace::clean;
#
# This code will remove non-selecting/non-restricting joins from
# {from} specs, aiding the RDBMS query optimizer
#
sub _prune_unused_joins {
my $self = shift;
my ($from, $select, $where, $attrs) = @_;
return $from unless $self->_use_join_optimizer;
if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY') {
return $from; # only standard {from} specs are supported
}
my $aliastypes = $self->_resolve_aliastypes_from_select_args(@_);
# a grouped set will not be affected by amount of rows. Thus any
# {multiplying} joins can go
delete $aliastypes->{multiplying} if $attrs->{group_by};
my @newfrom = $from->[0]; # FROM head is always present
my %need_joins;
for (values %$aliastypes) {
# add all requested aliases
$need_joins{$_} = 1 for keys %$_;
# add all their parents (as per joinpath which is an AoH { table => alias })
$need_joins{$_} = 1 for map { values %$_ } map { @$_ } values %$_;
}
for my $j (@{$from}[1..$#$from]) {
push @newfrom, $j if (
(! $j->[0]{-alias}) # legacy crap
||
$need_joins{$j->[0]{-alias}}
);
}
return \@newfrom;
}
#
# This is the code producing joined subqueries like:
# SELECT me.*, other.* FROM ( SELECT me.* FROM ... ) JOIN other ON ...
#
sub _adjust_select_args_for_complex_prefetch {
my ($self, $from, $select, $where, $attrs) = @_;
$self->throw_exception ('Nothing to prefetch... how did we get here?!')
if not @{$attrs->{_prefetch_selector_range}};
$self->throw_exception ('Complex prefetches are not supported on resultsets with a custom from attribute')
if (ref $from ne 'ARRAY' || ref $from->[0] ne 'HASH' || ref $from->[1] ne 'ARRAY');
# generate inner/outer attribute lists, remove stuff that doesn't apply
my $outer_attrs = { %$attrs };
delete $outer_attrs->{$_} for qw/where bind rows offset group_by having/;
my $inner_attrs = { %$attrs };
delete $inner_attrs->{$_} for qw/for collapse _prefetch_selector_range _collapse_order_by select as/;
# bring over all non-collapse-induced order_by into the inner query (if any)
# the outer one will have to keep them all
delete $inner_attrs->{order_by};
if (my $ord_cnt = @{$outer_attrs->{order_by}} - @{$outer_attrs->{_collapse_order_by}} ) {
$inner_attrs->{order_by} = [
@{$outer_attrs->{order_by}}[ 0 .. $ord_cnt - 1]
];
}
# generate the inner/outer select lists
# for inside we consider only stuff *not* brought in by the prefetch
# on the outside we substitute any function for its alias
my $outer_select = [ @$select ];
my $inner_select = [];
my ($p_start, $p_end) = @{$outer_attrs->{_prefetch_selector_range}};
for my $i (0 .. $p_start - 1, $p_end + 1 .. $#$outer_select) {
my $sel = $outer_select->[$i];
if (ref $sel eq 'HASH' ) {
$sel->{-as} ||= $attrs->{as}[$i];
$outer_select->[$i] = join ('.', $attrs->{alias}, ($sel->{-as} || "inner_column_$i") );
}
push @$inner_select, $sel;
push @{$inner_attrs->{as}}, $attrs->{as}[$i];
}
# construct the inner $from and lock it in a subquery
# we need to prune first, because this will determine if we need a group_by below
# the fake group_by is so that the pruner throws away all non-selecting, non-restricting
# multijoins (since we def. do not care about those inside the subquery)
my $inner_subq = do {
# must use it here regardless of user requests
local $self->{_use_join_optimizer} = 1;
my $inner_from = $self->_prune_unused_joins ($from, $inner_select, $where, {
group_by => ['dummy'], %$inner_attrs,
});
my $inner_aliastypes =
$self->_resolve_aliastypes_from_select_args( $inner_from, $inner_select, $where, $inner_attrs );
# we need to simulate collapse in the subq if a multiplying join is pulled
# by being a non-selecting restrictor
if (
! $inner_attrs->{group_by}
and
first {
$inner_aliastypes->{restricting}{$_}
and
! $inner_aliastypes->{selecting}{$_}
} ( keys %{$inner_aliastypes->{multiplying}||{}} )
) {
my $unprocessed_order_chunks;
($inner_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection (
$inner_from, $inner_select, $inner_attrs->{order_by}
);
$self->throw_exception (
'A required group_by clause could not be constructed automatically due to a complex '
. 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
. 'group_by by hand'
) if $unprocessed_order_chunks;
}
# we already optimized $inner_from above
local $self->{_use_join_optimizer} = 0;
# generate the subquery
$self->_select_args_to_query (
$inner_from,
$inner_select,
$where,
$inner_attrs,
);
};
# Generate the outer from - this is relatively easy (really just replace
# the join slot with the subquery), with a major caveat - we can not
# join anything that is non-selecting (not part of the prefetch), but at
# the same time is a multi-type relationship, as it will explode the result.
#
# There are two possibilities here
# - either the join is non-restricting, in which case we simply throw it away
# - it is part of the restrictions, in which case we need to collapse the outer
# result by tackling yet another group_by to the outside of the query
$from = [ @$from ];
# so first generate the outer_from, up to the substitution point
my @outer_from;
while (my $j = shift @$from) {
$j = [ $j ] unless ref $j eq 'ARRAY'; # promote the head-from to an AoH
if ($j->[0]{-alias} eq $attrs->{alias}) { # time to swap
push @outer_from, [
{
-alias => $attrs->{alias},
-rsrc => $j->[0]{-rsrc},
$attrs->{alias} => $inner_subq,
},
@{$j}[1 .. $#$j],
];
last; # we'll take care of what's left in $from below
}
else {
push @outer_from, $j;
}
}
# scan the *remaining* from spec against different attributes, and see which joins are needed
# in what role
my $outer_aliastypes =
$self->_resolve_aliastypes_from_select_args( $from, $outer_select, $where, $outer_attrs );
# unroll parents
my ($outer_select_chain, $outer_restrict_chain) = map { +{
map { $_ => 1 } map { values %$_} map { @$_ } values %{ $outer_aliastypes->{$_} || {} }
} } qw/selecting restricting/;
# see what's left - throw away if not selecting/restricting
# also throw in a group_by if a non-selecting multiplier,
# to guard against cross-join explosions
my $need_outer_group_by;
while (my $j = shift @$from) {
my $alias = $j->[0]{-alias};
if (
$outer_select_chain->{$alias}
) {
push @outer_from, $j
}
elsif ($outer_restrict_chain->{$alias}) {
push @outer_from, $j;
$need_outer_group_by ||= $outer_aliastypes->{multiplying}{$alias} ? 1 : 0;
}
}
# demote the outer_from head
$outer_from[0] = $outer_from[0][0];
if ($need_outer_group_by and ! $outer_attrs->{group_by}) {
my $unprocessed_order_chunks;
($outer_attrs->{group_by}, $unprocessed_order_chunks) = $self->_group_over_selection (
\@outer_from, $outer_select, $outer_attrs->{order_by}
);
$self->throw_exception (
'A required group_by clause could not be constructed automatically due to a complex '
. 'order_by criteria. Either order_by columns only (no functions) or construct a suitable '
. 'group_by by hand'
) if $unprocessed_order_chunks;
}
# This is totally horrific - the $where ends up in both the inner and outer query
# Unfortunately not much can be done until SQLA2 introspection arrives, and even
# then if where conditions apply to the *right* side of the prefetch, you may have
# to both filter the inner select (e.g. to apply a limit) and then have to re-filter
# the outer select to exclude joins you didin't want in the first place
#
# OTOH it can be seen as a plus: <ash> (notes that this query would make a DBA cry ;)
return (\@outer_from, $outer_select, $where, $outer_attrs);
}
#
# I KNOW THIS SUCKS! GET SQLA2 OUT THE DOOR SO THIS CAN DIE!
#
# Due to a lack of SQLA2 we fall back to crude scans of all the
# select/where/order/group attributes, in order to determine what
# aliases are neded to fulfill the query. This information is used
# throughout the code to prune unnecessary JOINs from the queries
# in an attempt to reduce the execution time.
# Although the method is pretty horrific, the worst thing that can
# happen is for it to fail due to some scalar SQL, which in turn will
# result in a vocal exception.
sub _resolve_aliastypes_from_select_args {
my ( $self, $from, $select, $where, $attrs ) = @_;
$self->throw_exception ('Unable to analyze custom {from}')
if ref $from ne 'ARRAY';
# what we will return
my $aliases_by_type;
# see what aliases are there to work with
my $alias_list;
for (@$from) {
my $j = $_;
$j = $j->[0] if ref $j eq 'ARRAY';
my $al = $j->{-alias}
or next;
$alias_list->{$al} = $j;
$aliases_by_type->{multiplying}{$al} ||= $j->{-join_path}||[] if (
# not array == {from} head == can't be multiplying
( ref($_) eq 'ARRAY' and ! $j->{-is_single} )
or
# a parent of ours is already a multiplier
( grep { $aliases_by_type->{multiplying}{$_} } @{ $j->{-join_path}||[] } )
);
}
# get a column to source/alias map (including unqualified ones)
my $colinfo = $self->_resolve_column_info ($from);
# set up a botched SQLA
my $sql_maker = $self->sql_maker;
# these are throw away results, do not pollute the bind stack
local $sql_maker->{select_bind};
local $sql_maker->{where_bind};
local $sql_maker->{group_bind};
local $sql_maker->{having_bind};
# we can't scan properly without any quoting (\b doesn't cut it
# everywhere), so unless there is proper quoting set - use our
# own weird impossible character.
# Also in the case of no quoting, we need to explicitly disable
# name_sep, otherwise sorry nasty legacy syntax like
# { 'count(foo.id)' => { '>' => 3 } } will stop working >:(
local $sql_maker->{quote_char} = $sql_maker->{quote_char};
local $sql_maker->{name_sep} = $sql_maker->{name_sep};
unless (defined $sql_maker->{quote_char} and length $sql_maker->{quote_char}) {
$sql_maker->{quote_char} = ["\x00", "\xFF"];
# if we don't unset it we screw up retarded but unfortunately working
# 'MAX(foo.bar)' => { '>', 3 }
$sql_maker->{name_sep} = '';
}
my ($lquote, $rquote, $sep) = map { quotemeta $_ } ($sql_maker->_quote_chars, $sql_maker->name_sep);
# generate sql chunks
my $to_scan = {
restricting => [
$sql_maker->_recurse_where ($where),
$sql_maker->_parse_rs_attrs ({
map { $_ => $attrs->{$_} } (qw/group_by having/)
}),
],
selecting => [
$sql_maker->_recurse_fields ($select),
( map { $_->[0] } $self->_extract_order_criteria ($attrs->{order_by}, $sql_maker) ),
],
};
# throw away empty chunks
$_ = [ map { $_ || () } @$_ ] for values %$to_scan;
# first loop through all fully qualified columns and get the corresponding
# alias (should work even if they are in scalarrefs)
for my $alias (keys %$alias_list) {
my $al_re = qr/
$lquote $alias $rquote $sep
|
\b $alias \.
/x;
for my $type (keys %$to_scan) {
for my $piece (@{$to_scan->{$type}}) {
$aliases_by_type->{$type}{$alias} ||= $alias_list->{$alias}{-join_path}||[]
if ($piece =~ $al_re);
}
}
}
# now loop through unqualified column names, and try to locate them within
# the chunks
for my $col (keys %$colinfo) {
next if $col =~ / \. /x; # if column is qualified it was caught by the above
my $col_re = qr/ $lquote $col $rquote /x;
for my $type (keys %$to_scan) {
for my $piece (@{$to_scan->{$type}}) {
if ($piece =~ $col_re) {
my $alias = $colinfo->{$col}{-source_alias};
$aliases_by_type->{$type}{$alias} ||= $alias_list->{$alias}{-join_path}||[];
}
}
}
}
# Add any non-left joins to the restriction list (such joins are indeed restrictions)
for my $j (values %$alias_list) {
my $alias = $j->{-alias} or next;
$aliases_by_type->{restricting}{$alias} ||= $j->{-join_path}||[] if (
(not $j->{-join_type})
or
($j->{-join_type} !~ /^left (?: \s+ outer)? $/xi)
);
}
return $aliases_by_type;
}
# This is the engine behind { distinct => 1 }
sub _group_over_selection {
my ($self, $from, $select, $order_by) = @_;
my $rs_column_list = $self->_resolve_column_info ($from);
my (@group_by, %group_index);
# the logic is: if it is a { func => val } we assume an aggregate,
# otherwise if \'...' or \[...] we assume the user knows what is
# going on thus group over it
for (@$select) {
if (! ref($_) or ref ($_) ne 'HASH' ) {
push @group_by, $_;
$group_index{$_}++;
if ($rs_column_list->{$_} and $_ !~ /\./ ) {
# add a fully qualified version as well
$group_index{"$rs_column_list->{$_}{-source_alias}.$_"}++;
}
}
}
# add any order_by parts that are not already present in the group_by
# we need to be careful not to add any named functions/aggregates
# i.e. order_by => [ ... { count => 'foo' } ... ]
my @leftovers;
for ($self->_extract_order_criteria($order_by)) {
# only consider real columns (for functions the user got to do an explicit group_by)
if (@$_ != 1) {
push @leftovers, $_;
next;
}
my $chunk = $_->[0];
my $colinfo = $rs_column_list->{$chunk} or do {
push @leftovers, $_;
next;
};
$chunk = "$colinfo->{-source_alias}.$chunk" if $chunk !~ /\./;
push @group_by, $chunk unless $group_index{$chunk}++;
}
return wantarray
? (\@group_by, (@leftovers ? \@leftovers : undef) )
: \@group_by
;
}
sub _resolve_ident_sources {
my ($self, $ident) = @_;
my $alias2source = {};
my $rs_alias;
# the reason this is so contrived is that $ident may be a {from}
# structure, specifying multiple tables to join
if ( blessed $ident && $ident->isa("DBIx::Class::ResultSource") ) {
# this is compat mode for insert/update/delete which do not deal with aliases
$alias2source->{me} = $ident;
$rs_alias = 'me';
}
elsif (ref $ident eq 'ARRAY') {
for (@$ident) {
my $tabinfo;
if (ref $_ eq 'HASH') {
$tabinfo = $_;
$rs_alias = $tabinfo->{-alias};
}
if (ref $_ eq 'ARRAY' and ref $_->[0] eq 'HASH') {
$tabinfo = $_->[0];
}
$alias2source->{$tabinfo->{-alias}} = $tabinfo->{-rsrc}
if ($tabinfo->{-rsrc});
}
}
return ($alias2source, $rs_alias);
}
# Takes $ident, \@column_names
#
# returns { $column_name => \%column_info, ... }
# also note: this adds -result_source => $rsrc to the column info
#
# If no columns_names are supplied returns info about *all* columns
# for all sources
sub _resolve_column_info {
my ($self, $ident, $colnames) = @_;
my ($alias2src, $root_alias) = $self->_resolve_ident_sources($ident);
my (%seen_cols, @auto_colnames);
# compile a global list of column names, to be able to properly
# disambiguate unqualified column names (if at all possible)
for my $alias (keys %$alias2src) {
my $rsrc = $alias2src->{$alias};
for my $colname ($rsrc->columns) {
push @{$seen_cols{$colname}}, $alias;
push @auto_colnames, "$alias.$colname" unless $colnames;
}
}
$colnames ||= [
@auto_colnames,
grep { @{$seen_cols{$_}} == 1 } (keys %seen_cols),
];
my (%return, $colinfos);
foreach my $col (@$colnames) {
my ($source_alias, $colname) = $col =~ m/^ (?: ([^\.]+) \. )? (.+) $/x;
# if the column was seen exactly once - we know which rsrc it came from
$source_alias ||= $seen_cols{$colname}[0]
if ($seen_cols{$colname} and @{$seen_cols{$colname}} == 1);
next unless $source_alias;
my $rsrc = $alias2src->{$source_alias}
or next;
$return{$col} = {
%{
( $colinfos->{$source_alias} ||= $rsrc->columns_info )->{$colname}
||
$self->throw_exception(
"No such column '$colname' on source " . $rsrc->source_name
);
},
-result_source => $rsrc,
-source_alias => $source_alias,
};
}
return \%return;
}
# The DBIC relationship chaining implementation is pretty simple - every
# new related_relationship is pushed onto the {from} stack, and the {select}
# window simply slides further in. This means that when we count somewhere
# in the middle, we got to make sure that everything in the join chain is an
# actual inner join, otherwise the count will come back with unpredictable
# results (a resultset may be generated with _some_ rows regardless of if
# the relation which the $rs currently selects has rows or not). E.g.
# $artist_rs->cds->count - normally generates:
# SELECT COUNT( * ) FROM artist me LEFT JOIN cd cds ON cds.artist = me.artistid
# which actually returns the number of artists * (number of cds || 1)
#
# So what we do here is crawl {from}, determine if the current alias is at
# the top of the stack, and if not - make sure the chain is inner-joined down
# to the root.
#
sub _inner_join_to_node {
my ($self, $from, $alias) = @_;
# subqueries and other oddness are naturally not supported
return $from if (
ref $from ne 'ARRAY'
||
@$from <= 1
||
ref $from->[0] ne 'HASH'
||
! $from->[0]{-alias}
||
$from->[0]{-alias} eq $alias # this last bit means $alias is the head of $from - nothing to do
);
# find the current $alias in the $from structure
my $switch_branch;
JOINSCAN:
for my $j (@{$from}[1 .. $#$from]) {
if ($j->[0]{-alias} eq $alias) {
$switch_branch = $j->[0]{-join_path};
last JOINSCAN;
}
}
# something else went quite wrong
return $from unless $switch_branch;
# So it looks like we will have to switch some stuff around.
# local() is useless here as we will be leaving the scope
# anyway, and deep cloning is just too fucking expensive
# So replace the first hashref in the node arrayref manually
my @new_from = ($from->[0]);
my $sw_idx = { map { (values %$_), 1 } @$switch_branch }; #there's one k/v per join-path
for my $j (@{$from}[1 .. $#$from]) {
my $jalias = $j->[0]{-alias};
if ($sw_idx->{$jalias}) {
my %attrs = %{$j->[0]};
delete $attrs{-join_type};
push @new_from, [
\%attrs,
@{$j}[ 1 .. $#$j ],
];
}
else {
push @new_from, $j;
}
}
return \@new_from;
}
sub _extract_order_criteria {
my ($self, $order_by, $sql_maker) = @_;
my $parser = sub {
my ($sql_maker, $order_by) = @_;
return scalar $sql_maker->_order_by_chunks ($order_by)
unless wantarray;
my @chunks;
for ($sql_maker->_order_by_chunks ($order_by) ) {
my $chunk = ref $_ ? $_ : [ $_ ];
$chunk->[0] =~ s/\s+ (?: ASC|DESC ) \s* $//ix;
push @chunks, $chunk;
}
return @chunks;
};
if ($sql_maker) {
return $parser->($sql_maker, $order_by);
}
else {
$sql_maker = $self->sql_maker;
local $sql_maker->{quote_char};
return $parser->($sql_maker, $order_by);
}
}
1;