X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource.pm;h=482990419d1b7c98872f9d20358dd2a2acfd7e12;hb=6909ab3ccc795859d538010083cdafe77e225980;hp=ce88cbb898a75a2fdb30908ebc2add8313dfe78a;hpb=5592d633292c0fecf45b554ab6d4b235b140dc15;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index ce88cbb..4829904 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -9,7 +9,8 @@ use DBIx::Class::ResultSet; use DBIx::Class::ResultSourceHandle; use DBIx::Class::Carp; -use DBIx::Class::_Util 'is_literal_value'; +use DBIx::Class::_Util 'UNRESOLVABLE_CONDITION'; +use SQL::Abstract 'is_literal_value'; use Devel::GlobalDestruction; use Try::Tiny; use List::Util 'first'; @@ -142,6 +143,11 @@ sub new { $source->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...); + $source->add_columns( + 'col1' => { data_type => 'integer', is_nullable => 1, ... }, + 'col2' => { data_type => 'text', is_auto_increment => 1, ... }, + ); + Adds columns to the result source. If supplied colname => hashref pairs, uses the hashref as the L for that column. Repeated calls of this method will add more columns, not replace them. @@ -1314,10 +1320,11 @@ sub add_relationship { # Check foreign and self are right in cond if ( (ref $cond ||'') eq 'HASH') { - for (keys %$cond) { - $self->throw_exception("Keys of condition should be of form 'foreign.col', not '$_'") - if /\./ && !/^foreign\./; - } + $_ =~ /^foreign\./ or $self->throw_exception("Malformed relationship condition key '$_': must be prefixed with 'foreign.'") + for keys %$cond; + + $_ =~ /^self\./ or $self->throw_exception("Malformed relationship condition value '$_': must be prefixed with 'self.'") + for values %$cond; } my %rels = %{ $self->_relationships }; @@ -1546,6 +1553,67 @@ sub _identifying_column_set { return undef; } +sub _minimal_valueset_satisfying_constraint { + my $self = shift; + my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ }; + + $args->{columns_info} ||= $self->columns_info; + + my $vals = $self->storage->_extract_fixed_condition_columns( + $args->{values}, + ($args->{carp_on_nulls} ? 'consider_nulls' : undef ), + ); + + my $cols; + for my $col ($self->unique_constraint_columns($args->{constraint_name}) ) { + if( ! exists $vals->{$col} ) { + $cols->{missing}{$col} = 1; + } + elsif( ! defined $vals->{$col} ) { + $cols->{$args->{carp_on_nulls} ? 'undefined' : 'missing'}{$col} = 1; + } + else { + $cols->{present}{$col} = 1; + } + + $cols->{fc}{$col} = 1 if ( + ! ( $cols->{missing} || {})->{$col} + and + $args->{columns_info}{$col}{_filter_info} + ); + } + + $self->throw_exception( sprintf ( "Unable to satisfy requested constraint '%s', missing values for column(s): %s", + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{missing}} ), + ) ) if $cols->{missing}; + + $self->throw_exception( sprintf ( + "Unable to satisfy requested constraint '%s', FilterColumn values not usable for column(s): %s", + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{fc}}), + )) if $cols->{fc}; + + if ( + $cols->{undefined} + and + !$ENV{DBIC_NULLABLE_KEY_NOWARN} + ) { + carp_unique ( sprintf ( + "NULL/undef values supplied for requested unique constraint '%s' (NULL " + . 'values in column(s): %s). This is almost certainly not what you wanted, ' + . 'though you can set DBIC_NULLABLE_KEY_NOWARN to disable this warning.', + $args->{constraint_name}, + join (', ', map { "'$_'" } sort keys %{$cols->{undefined}}), + )); + } + + return { map + { $_ => $vals->{$_} } + ( keys %{$cols->{present}}, keys %{$cols->{undefined}} ) + }; +} + # Returns the {from} structure used to express JOIN conditions sub _resolve_join { my ($self, $join, $alias, $seen, $jpath, $parent_force_left) = @_; @@ -1669,6 +1737,11 @@ sub _pk_depends_on { return 1; } +sub resolve_condition { + carp 'resolve_condition is a private method, stop calling it'; + shift->_resolve_condition (@_); +} + sub _resolve_condition { # carp_unique sprintf # '_resolve_condition is a private method, and moreover is about to go ' @@ -1711,17 +1784,14 @@ sub _resolve_condition { } } - $self->throw_exception('No practical way to resolve a relationship between two structures') - if $is_objlike[0] and $is_objlike[1]; - my $args = { condition => $cond, # 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] ) + $is_objlike[1] ? ( rel_name => $res_args[0], self_alias => $res_args[0], foreign_alias => 'me', self_result_object => $res_args[1] ) + : $is_objlike[0] ? ( rel_name => $res_args[1], self_alias => 'me', foreign_alias => $res_args[1], foreign_values => $res_args[0] ) + : ( rel_name => $res_args[0], self_alias => $res_args[1], foreign_alias => $res_args[0] ) ), ( $rel_name ? ( rel_name => $rel_name ) : () ), @@ -1729,11 +1799,15 @@ sub _resolve_condition { ####################### # now it's fucking easy isn't it?! - my @res = $self->_resolve_relationship_condition( $args ); + my $rc = $self->_resolve_relationship_condition( $args ); - # 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 + my @res = ( + ( $rc->{join_free_condition} || $rc->{condition} ), + ! $rc->{join_free_condition}, + ); + + # _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]{$_} } @@ -1741,37 +1815,95 @@ sub _resolve_condition { }; } - # 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_values +# self_alias +# self_result_object +# require_join_free_condition +# infer_values_based_on (either not supplied or a hashref, implies require_join_free_condition) +# condition (optional, derived from $self->rel_info(rel_name)) +# +## returns a hash +# condition +# identity_map +# join_free_condition (maybe unset) +# inferred_values (always either complete or unset) +# 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') - if defined $args->{self_resultobj} and defined $args->{foreign_resultobj}; + $self->throw_exception("Arguments 'self_alias' and 'foreign_alias' may not be identical") + if $args->{self_alias} eq $args->{foreign_alias}; + + 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 data structures") + if exists $args->{self_result_object} and exists $args->{foreign_values}; + + $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} ||= $self->relationship_info($args->{rel_name})->{cond}; + $args->{condition} ||= $rel_info->{cond}; + + my $rel_rsrc = $self->related_source($args->{rel_name}); + + if (exists $args->{self_result_object}) { + $self->throw_exception( "Argument 'self_result_object' must be an object of class '@{[ $self->result_class ]}'" ) + unless defined blessed $args->{self_result_object}; + + $self->throw_exception( "Object '$args->{self_result_object}' must be of class '@{[ $self->result_class ]}'" ) + unless $args->{self_result_object}->isa($self->result_class); + } + + if (exists $args->{foreign_values}) { + if (defined blessed $args->{foreign_values}) { + $self->throw_exception( "Object supplied as 'foreign_values' ($args->{foreign_values}) must be of class '$rel_info->{class}'" ) + unless $args->{foreign_values}->isa($rel_info->{class}); + + $args->{foreign_values} = { $args->{foreign_values}->get_columns }; + } + elsif (! defined $args->{foreign_values} or ref $args->{foreign_values} eq 'HASH') { + my $ci = $rel_rsrc->columns_info; + ! exists $ci->{$_} and $self->throw_exception( + "Key '$_' supplied as 'foreign_values' is not a column on related source '@{[ $rel_rsrc->source_name ]}'" + ) for keys %{ $args->{foreign_values} ||= {} }; + } + else { + $self->throw_exception( "Argument 'foreign_values' must be either an object inheriting from '$rel_info->{class}' or a hash reference or undef" ); + } + } + + my $ret; if (ref $args->{condition} eq 'CODE') { @@ -1780,67 +1912,55 @@ sub _resolve_relationship_condition { self_resultsource => $self, self_alias => $args->{self_alias}, foreign_alias => $args->{foreign_alias}, - self_resultobj => $args->{self_resultobj}, - foreign_resultobj => $args->{foreign_resultobj}, + ( map + { (exists $args->{$_}) ? ( $_ => $args->{$_} ) : () } + qw( self_result_object foreign_values ) + ), }; # 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_result_object} + if exists $cref_args->{self_result_object}; + + ($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') + # sanity check + $self->throw_exception("A custom condition coderef can return at most 2 conditions, but $exception_rel_id returned extra values: @extra") 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}) { + if (defined $args->{self_result_object}) { $joinfree_alias = $args->{foreign_alias}; - $joinfree_source = $self->related_source($args->{rel_name}); + $joinfree_source = $rel_rsrc; } - elsif (defined $args->{foreign_resultobj}) { + elsif (defined $args->{foreign_values}) { $joinfree_alias = $args->{self_alias}; $joinfree_source = $self; } # 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') { @@ -1863,86 +1983,159 @@ sub _resolve_relationship_condition { 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 { - - my $cond; - - 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 ) - : ( @{$args}{qw( foreign_resultobj foreign_alias self_alias )}, \@f_cols, \@l_cols ) - ; + # construct the crosstable condition and the identity map + for (0..$#f_cols) { + $ret->{condition}{"$args->{foreign_alias}.$f_cols[$_]"} = { -ident => "$args->{self_alias}.$l_cols[$_]" }; + $ret->{identity_map}{$l_cols[$_]} = $f_cols[$_]; + }; - for my $i (0..$#$obj_cols) { + if ($args->{foreign_values}) { + $ret->{join_free_condition}{"$args->{self_alias}.$l_cols[$_]"} = $args->{foreign_values}{$f_cols[$_]} + for 0..$#f_cols; + } + elsif (defined $args->{self_result_object}) { - # FIXME - temp shim - if (! blessed $obj) { - $cond->{"$plain_alias.$plain_cols->[$i]"} = $obj->{$obj_cols->[$i]}; + for my $i (0..$#l_cols) { + if ( $args->{self_result_object}->has_column_loaded($l_cols[$i]) ) { + $ret->{join_free_condition}{"$args->{foreign_alias}.$f_cols[$i]"} = $args->{self_result_object}->get_column($l_cols[$i]); } - elsif ( - defined $args->{self_resultobj} - and - ! $obj->has_column_loaded($obj_cols->[$i]) - ) { - + else { $self->throw_exception(sprintf "Unable to resolve relationship '%s' from object '%s': column '%s' not " . 'loaded from storage (or not passed to new() prior to insert()). You ' . 'probably need to call ->discard_changes to get the server-side defaults ' . 'from the database.', $args->{rel_name}, - $obj, - $obj_cols->[$i], - ) if $obj->in_storage; - - return $UNRESOLVABLE_CONDITION; - } - else { - $cond->{"$plain_alias.$plain_cols->[$i]"} = $obj->get_column($obj_cols->[$i]); + $args->{self_result_object}, + $l_cols[$i], + ) if $args->{self_result_object}->in_storage; + + # FIXME - temporarly force-override + delete $args->{require_join_free_condition}; + $ret->{join_free_condition} = UNRESOLVABLE_CONDITION; + last; } } - - 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 must resolve to a join-free condition') + if ( $ret and ( $ret->{join_free_condition} xor $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 ) + ); + + my $storage = $self->schema->storage; + + # 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 = $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}}; + } + + # add the identities based on the main condition + # (may already be there, since easy to calculate on the fly in the HASH case) + if ( ! $ret->{identity_map} ) { + + my $col_eqs = $storage->_extract_fixed_condition_columns($ret->{condition}); + + my $colinfos; + for my $lhs (keys %$col_eqs) { + + next if $col_eqs->{$lhs} eq UNRESOLVABLE_CONDITION; + my ($rhs) = @{ is_literal_value( $ret->{condition}{$lhs} ) || next }; + + # there is no way to know who is right and who is left + # therefore the ugly scan below + $colinfos ||= $storage->_resolve_column_info([ + { -alias => $args->{self_alias}, -rsrc => $self }, + { -alias => $args->{foreign_alias}, -rsrc => $rel_rsrc }, + ]); + + my ($l_col, $l_alias, $r_col, $r_alias) = map { + ( reverse $_ =~ / ^ (?: ([^\.]+) $ | ([^\.]+) \. (.+) ) /x )[0,1] + } ($lhs, $rhs); + + if ( + $colinfos->{$l_col} + and + $colinfos->{$r_col} + and + $colinfos->{$l_col}{-source_alias} ne $colinfos->{$r_col}{-source_alias} + ) { + ( $colinfos->{$l_col}{-source_alias} eq $args->{self_alias} ) + ? ( $ret->{identity_map}{$l_col} = $r_col ) + : ( $ret->{identity_map}{$r_col} = $l_col ) + ; + } + } } - die "not supposed to get here - missing return()"; + $ret } =head2 related_source