use DBIx::Class::ResultSourceHandle;
use DBIx::Class::Carp;
-use DBIx::Class::_Util 'is_literal_value';
+use DBIx::Class::_Util 'UNRESOLVABLE_CONDITION';
use Devel::GlobalDestruction;
use Try::Tiny;
use List::Util 'first';
else {
$res_args[$_] ||= {};
+ # hate everywhere - have to pass in as a plain hash
+ # pretending to be an object at least for now
$self->throw_exception("Unsupported object-like structure encountered: $res_args[$_]")
unless ref $res_args[$_] eq 'HASH';
-
- # hate everywhere
- $res_args[$_] = $self->relationship_info($rel_name)->{source}->result_class->new($res_args[$_]);
}
}
my $args = {
condition => $cond,
- rel_name => $rel_name,
- $is_objlike[1] ? ( self_alias => $res_args[0], foreign_alias => 'me', self_resultobj => $res_args[1] )
- : $is_objlike[0] ? ( self_alias => 'me', foreign_alias => $res_args[1], foreign_resultobj => $res_args[0] )
- : ( self_alias => $res_args[1], foreign_alias => $res_args[0] )
+
+ # where-is-waldo block guesses relname, then further down we override it if available
+ (
+ $is_objlike[1] ? ( rel_name => $res_args[0], self_alias => $res_args[0], foreign_alias => 'me', self_resultobj => $res_args[1] )
+ : $is_objlike[0] ? ( rel_name => $res_args[1], self_alias => 'me', foreign_alias => $res_args[1], foreign_resultobj => $res_args[0] )
+ : ( rel_name => $res_args[0], self_alias => $res_args[1], foreign_alias => $res_args[0] )
+ ),
+
+ ( $rel_name ? ( rel_name => $rel_name ) : () ),
};
#######################
# now it's fucking easy isn't it?!
- my @res = $self->_resolve_relationship_condition( $args );
+ my $rc = $self->_resolve_relationship_condition( $args );
+
+ my @res = (
+ ( $rc->{join_free_condition} || $rc->{condition} ),
+ ! $rc->{join_free_condition},
+ );
- # FIXME - this is also insane, but just be consistent for now
- # _resolve_relationship_condition always returns qualified cols
- # even in the case of objects, but nothing downstream expects this
+ # _resolve_relationship_condition always returns qualified cols even in the
+ # case of join_free_condition, but nothing downstream expects this
if (ref $res[0] eq 'HASH' and ($is_objlike[0] or $is_objlike[1]) ) {
$res[0] = { map
{ ($_ =~ /\.(.+)/) => $res[0]{$_} }
};
}
- # more legacy
+ # and more legacy
return wantarray ? @res : $res[0];
}
-our $UNRESOLVABLE_CONDITION = \ '1 = 0';
-
-# Resolves the passed condition to a concrete query fragment and a flag
-# indicating whether this is a cross-table condition. Also an optional
-# list of non-trivial values (normally conditions) returned as a part
-# of a joinfree condition hash
+# Keep this indefinitely. There is evidence of both CPAN and
+# darkpan using it, and there isn't much harm in an extra var
+# anyway.
+our $UNRESOLVABLE_CONDITION = UNRESOLVABLE_CONDITION;
+# YES I KNOW THIS IS EVIL
+# it is there to save darkpan from themselves, since internally
+# we are moving to a constant
+Internals::SvREADONLY($UNRESOLVABLE_CONDITION => 1);
+
+# Resolves the passed condition to a concrete query fragment and extra
+# metadata
+#
+## self-explanatory API, modeled on the custom cond coderef:
+# rel_name
+# foreign_alias
+# foreign_resultobj
+# self_alias
+# self_resultobj
+# require_join_free_condition
+# infer_values_based_on (optional, mandatory hashref argument)
+# condition (optional, derived from $self->rel_info(rel_name))
+#
+## returns a hash
+# condition
+# join_free_condition (maybe undef)
+# inferred_values (maybe undef, always complete or empty)
+#
sub _resolve_relationship_condition {
my $self = shift;
- # self-explanatory API, modeled on the custom cond coderef:
- # condition
- # rel_name
- # foreign_alias
- # foreign_resultobj
- # self_alias
- # self_resultobj
my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ };
for ( qw( rel_name self_alias foreign_alias ) ) {
- $self->throw_exception("Mandatory attribute '$_' is not a plain string")
+ $self->throw_exception("Mandatory argument '$_' to _resolve_relationship_condition() is not a plain string")
if !defined $args->{$_} or length ref $args->{$_};
}
- $self->throw_exception('No practical way to resolve a relationship between two objects')
+ my $exception_rel_id = "relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}'";
+
+ my $rel_info = $self->relationship_info($args->{rel_name});
+ # or $self->throw_exception( "No such $exception_rel_id" );
+
+ $self->throw_exception("No practical way to resolve $exception_rel_id between two objects")
if defined $args->{self_resultobj} and defined $args->{foreign_resultobj};
- $args->{condition} ||= $self->relationship_info($args->{rel_name})->{cond};
+ $self->throw_exception( "Argument to infer_values_based_on must be a hash" )
+ if exists $args->{infer_values_based_on} and ref $args->{infer_values_based_on} ne 'HASH';
+
+ $args->{require_join_free_condition} ||= !!$args->{infer_values_based_on};
+
+ $args->{condition} ||= $rel_info->{cond};
+
+ if (exists $args->{self_resultobj}) {
+ if (defined blessed $args->{self_resultobj}) {
+# $self->throw_exception( "Object '$args->{self_resultobj}' must be of class '@{[ $self->result_class ]}'" )
+# unless $args->{self_resultobj}->isa($self->result_class);
+ }
+ else {
+ $args->{self_resultobj} = DBIx::Class::Core->new({
+ -result_source => $self,
+ %{ $args->{self_resultobj}||{} }
+ });
+ }
+ }
+
+ if (exists $args->{foreign_resultobj}) {
+ if (defined blessed $args->{foreign_resultobj}) {
+# $self->throw_exception( "Object '$args->{foreign_resultobj}' must be of class '$rel_info->{class}'" )
+# unless $args->{foreign_resultobj}->isa($rel_info->{class});
+ }
+ else {
+ $args->{foreign_resultobj} = DBIx::Class::Core->new({
+ -result_source => $self->related_source($args->{rel_name}),
+ %{ $args->{foreign_resultobj}||{} }
+ });
+ }
+ }
+
+ my $ret;
if (ref $args->{condition} eq 'CODE') {
self_resultsource => $self,
self_alias => $args->{self_alias},
foreign_alias => $args->{foreign_alias},
- self_resultobj => (defined $args->{self_resultobj} ? $args->{self_resultobj} : undef),
- foreign_resultobj => (defined $args->{foreign_resultobj} ? $args->{foreign_resultobj} : undef),
+ ( map
+ { (exists $args->{$_}) ? ( $_ => $args->{$_} ) : () }
+ qw( self_resultobj foreign_resultobj )
+ ),
};
# legacy - never remove these!!!
$cref_args->{foreign_relname} = $cref_args->{rel_name};
- $cref_args->{self_rowobj} = $cref_args->{self_resultobj};
- my ($crosstable_cond, $joinfree_cond, @extra) = $args->{condition}->($cref_args);
+ $cref_args->{self_rowobj} = $cref_args->{self_resultobj}
+ if exists $cref_args->{self_resultobj};
+
+ ($ret->{condition}, $ret->{join_free_condition}, my @extra) = $args->{condition}->($cref_args);
# FIXME sanity check
carp_unique('A custom condition coderef can return at most 2 conditions: extra return values discarded')
if @extra;
- my @nonvalue_cols;
- if ($joinfree_cond) {
+ if (my $jfc = $ret->{join_free_condition}) {
+
+ $self->throw_exception (
+ "The join-free condition returned for $exception_rel_id must be a hash reference"
+ ) unless ref $jfc eq 'HASH';
my ($joinfree_alias, $joinfree_source);
if (defined $args->{self_resultobj}) {
# FIXME sanity check until things stabilize, remove at some point
$self->throw_exception (
- "A join-free condition returned for relationship '$args->{rel_name}' without a result object to chain from"
+ "A join-free condition returned for $exception_rel_id without a result object to chain from"
) unless $joinfree_alias;
- my $fq_col_list = { map { ( "$joinfree_alias.$_" => 1 ) } $joinfree_source->columns };
-
- # FIXME another sanity check
- if (
- ref $joinfree_cond ne 'HASH'
- or
- grep { ! $fq_col_list->{$_} } keys %$joinfree_cond
- ) {
- $self->throw_exception (
- "The join-free condition returned for relationship '$args->{rel_name}' must be a hash "
- .'reference with all keys being fully qualified column names of the corresponding source'
- );
- }
-
- # see which parts of the joinfree cond are *NOT* foreign-source-column equalities
- my $joinfree_cond_equality_columns = { map
- {( $_ => 1 )}
- @{ $self->schema->storage->_extract_fixed_condition_columns($joinfree_cond) }
+ my $fq_col_list = { map
+ { ( "$joinfree_alias.$_" => 1 ) }
+ $joinfree_source->columns
};
- @nonvalue_cols = map
- { $_ =~ /^\Q$joinfree_alias.\E(.+)/ }
- grep
- { ! $joinfree_cond_equality_columns->{$_} }
- keys %$joinfree_cond;
- return ($joinfree_cond, 0, (@nonvalue_cols ? \@nonvalue_cols : undef));
- }
- else {
- return ($crosstable_cond, 1);
+ $fq_col_list->{$_} or $self->throw_exception (
+ "The join-free condition returned for $exception_rel_id may only "
+ . 'contain keys that are fully qualified column names of the corresponding source'
+ ) for keys %$jfc;
+
}
}
elsif (ref $args->{condition} eq 'HASH') {
push @l_cols, $lc;
}
- # plain values
- if (! defined $args->{self_resultobj} and ! defined $args->{foreign_resultobj}) {
- return ( { map
- {( "$args->{foreign_alias}.$f_cols[$_]" => { -ident => "$args->{self_alias}.$l_cols[$_]" } )}
- (0..$#f_cols)
- }, 1 ); # is crosstable
- }
- else {
+ # construct the crosstable condition
+ $ret->{condition} = { map
+ {( "$args->{foreign_alias}.$f_cols[$_]" => { -ident => "$args->{self_alias}.$l_cols[$_]" } )}
+ (0..$#f_cols)
+ };
- my $cond;
+ if (exists $args->{self_resultobj} or exists $args->{foreign_resultobj}) {
my ($obj, $obj_alias, $plain_alias, $obj_cols, $plain_cols) = defined $args->{self_resultobj}
? ( @{$args}{qw( self_resultobj self_alias foreign_alias )}, \@l_cols, \@f_cols )
;
for my $i (0..$#$obj_cols) {
- if (defined $args->{self_resultobj} and ! $obj->has_column_loaded($obj_cols->[$i])) {
+
+ if (
+ defined $args->{self_resultobj}
+ and
+ ! $obj->has_column_loaded($obj_cols->[$i])
+ ) {
$self->throw_exception(sprintf
"Unable to resolve relationship '%s' from object '%s': column '%s' not "
$obj_cols->[$i],
) if $obj->in_storage;
- return $UNRESOLVABLE_CONDITION;
+ # FIXME - temporarly force-override
+ delete $args->{require_join_free_condition};
+ $ret->{join_free_condition} = UNRESOLVABLE_CONDITION;
+ last;
}
else {
- $cond->{"$plain_alias.$plain_cols->[$i]"} = $obj->get_column($obj_cols->[$i]);
+ $ret->{join_free_condition}{"$plain_alias.$plain_cols->[$i]"} = $obj->get_column($obj_cols->[$i]);
}
}
-
- return ($cond, 0); # joinfree
}
}
elsif (ref $args->{condition} eq 'ARRAY') {
if (@{$args->{condition}} == 0) {
- return $UNRESOLVABLE_CONDITION;
+ $ret = {
+ condition => UNRESOLVABLE_CONDITION,
+ join_free_condition => UNRESOLVABLE_CONDITION,
+ };
}
elsif (@{$args->{condition}} == 1) {
- return $self->_resolve_relationship_condition({
+ $ret = $self->_resolve_relationship_condition({
%$args,
condition => $args->{condition}[0],
});
}
else {
- # FIXME - we are discarding nonvalues here... likely incorrect...
- # then again - the entire thing is an OR, so we *can't* use
- # the values anyway
- # Return a hard crosstable => 1 to ensure nothing tries to use
- # the result in such manner
- my @ret;
- for (@{$args->{condition}}) {
- my ($cond) = $self->_resolve_relationship_condition({
- %$args,
- condition => $_,
- });
- push @ret, $cond;
+ # we are discarding inferred values here... likely incorrect...
+ # then again - the entire thing is an OR, so we *can't* use them anyway
+ for my $subcond ( map
+ { $self->_resolve_relationship_condition({ %$args, condition => $_ }) }
+ @{$args->{condition}}
+ ) {
+ $self->throw_exception('Either all or none of the OR-condition members can resolve to a join-free condition')
+ if $ret->{join_free_condition} and ! $subcond->{join_free_condition};
+
+ $subcond->{$_} and push @{$ret->{$_}}, $subcond->{$_} for (qw(condition join_free_condition));
}
- return (\@ret, 1); # forced cross-tab
}
}
else {
- $self->throw_exception ("Can't handle condition $args->{condition} for relationship '$args->{rel_name}' yet :(");
+ $self->throw_exception ("Can't handle condition $args->{condition} for $exception_rel_id yet :(");
+ }
+
+ $self->throw_exception(ucfirst "$exception_rel_id does not resolve to a join-free condition fragment") if (
+ $args->{require_join_free_condition}
+ and
+ ( ! $ret->{join_free_condition} or $ret->{join_free_condition} eq UNRESOLVABLE_CONDITION )
+ );
+
+ # we got something back - sanity check and infer values if we can
+ my @nonvalues;
+ if ( my $jfc = $ret->{join_free_condition} and $ret->{join_free_condition} ne UNRESOLVABLE_CONDITION ) {
+
+ my $jfc_eqs = $self->schema->storage->_extract_fixed_condition_columns($jfc, 'consider_nulls');
+
+ if (keys %$jfc_eqs) {
+
+ for (keys %$jfc) {
+ # $jfc is fully qualified by definition
+ my ($col) = $_ =~ /\.(.+)/;
+
+ if (exists $jfc_eqs->{$_} and ($jfc_eqs->{$_}||'') ne UNRESOLVABLE_CONDITION) {
+ $ret->{inferred_values}{$col} = $jfc_eqs->{$_};
+ }
+ elsif ( !$args->{infer_values_based_on} or ! exists $args->{infer_values_based_on}{$col} ) {
+ push @nonvalues, $col;
+ }
+ }
+
+ # all or nothing
+ delete $ret->{inferred_values} if @nonvalues;
+ }
+ }
+
+ # did the user explicitly ask
+ if ($args->{infer_values_based_on}) {
+
+ $self->throw_exception(sprintf (
+ "Unable to complete value inferrence - custom $exception_rel_id returns conditions instead of values for column(s): %s",
+ map { "'$_'" } @nonvalues
+ )) if @nonvalues;
+
+
+ $ret->{inferred_values} ||= {};
+
+ $ret->{inferred_values}{$_} = $args->{infer_values_based_on}{$_}
+ for keys %{$args->{infer_values_based_on}};
}
- die "not supposed to get here - missing return()";
+ $ret
}
=head2 related_source