X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSource.pm;h=d2cc10f6a615ee9e54d9afdaba923853daf76484;hb=d009cb7d393292037eff527a9f8bab93860224fb;hp=b4dc288dedd8922f6b95217e5d546f07f03238a0;hpb=908aa1bb761ec1da5c061fe9f687598e3f1934bc;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSource.pm b/lib/DBIx/Class/ResultSource.pm index b4dc288..d2cc10f 100644 --- a/lib/DBIx/Class/ResultSource.pm +++ b/lib/DBIx/Class/ResultSource.pm @@ -4,17 +4,15 @@ use strict; use warnings; use base 'DBIx::Class'; +__PACKAGE__->load_components(qw( + ResultSource::RowParser +)); -use DBIx::Class::ResultSet; -use DBIx::Class::ResultSourceHandle; - -use DBIx::Class::Exception; use DBIx::Class::Carp; -use DBIx::Class::GlobalDestruction; -use Try::Tiny; -use List::Util 'first'; +use DBIx::Class::_Util qw( UNRESOLVABLE_CONDITION dbic_internal_try ); +use SQL::Abstract 'is_literal_value'; +use Devel::GlobalDestruction; use Scalar::Util qw/blessed weaken isweak/; -use B 'perlstring'; use namespace::clean; @@ -77,7 +75,7 @@ More specifically, the L base class pulls in the L component, which defines the L method. When called, C creates and stores an instance of -L. Luckily, to use tables as result +L. Luckily, to use tables as result sources, you don't need to remember any of this. Result sources representing select queries, or views, can also be @@ -86,7 +84,8 @@ created, see L for full details. =head2 Finding result source objects As mentioned above, a result source instance is created and stored for -you when you define a L. +you when you define a +L. You can retrieve the result source at runtime in the following ways: @@ -96,9 +95,9 @@ You can retrieve the result source at runtime in the following ways: $schema->source($source_name); -=item From a Row object: +=item From a Result object: - $row->result_source; + $result->result_source; =item From a ResultSet object: @@ -108,7 +107,13 @@ You can retrieve the result source at runtime in the following ways: =head1 METHODS -=pod +=head2 new + + $class->new(); + + $class->new({attribute_name => value}); + +Creates a new ResultSource object. Not normally called directly by end users. =cut @@ -135,7 +140,7 @@ sub new { =item Arguments: @columns -=item Return value: The ResultSource object +=item Return Value: L<$result_source|/new> =back @@ -143,12 +148,17 @@ 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. The column names given will be created as accessor methods on your -L objects. You can change the name of the accessor +L objects. You can change the name of the accessor by supplying an L in the column_info hash. If a column name beginning with a plus sign ('+col1') is provided, the @@ -199,11 +209,17 @@ The length of your column, if it is a column type that can have a size restriction. This is currently only used to create tables from your schema, see L. + { size => [ 9, 6 ] } + +For decimal or float values you can specify an ArrayRef in order to +control precision, assuming your database's +L supports it. + =item is_nullable { is_nullable => 1 } -Set this to a true value for a columns that is allowed to contain NULL +Set this to a true value for a column that is allowed to contain NULL values, default is false. This is currently only used to create tables from your schema, see L. @@ -301,7 +317,7 @@ L. =item Arguments: $colname, \%columninfo? -=item Return value: 1/0 (true/false) +=item Return Value: 1/0 (true/false) =back @@ -345,7 +361,7 @@ sub add_column { shift->add_columns(@_); } # DO NOT CHANGE THIS TO GLOB =item Arguments: $colname -=item Return value: 1/0 (true/false) +=item Return Value: 1/0 (true/false) =back @@ -366,7 +382,7 @@ sub has_column { =item Arguments: $colname -=item Return value: Hashref of info +=item Return Value: Hashref of info =back @@ -386,12 +402,12 @@ sub column_info { if ( ! $self->_columns->{$column}{data_type} and ! $self->{_columns_info_loaded} and $self->column_info_from_storage - and my $stor = try { $self->storage } ) + and my $stor = dbic_internal_try { $self->storage } ) { $self->{_columns_info_loaded}++; # try for the case of storage without table - try { + dbic_internal_try { my $info = $stor->columns_info_for( $self->from ); my $lc_info = { map { (lc $_) => $info->{$_} } @@ -414,9 +430,9 @@ sub column_info { =over -=item Arguments: None +=item Arguments: none -=item Return value: Ordered list of column names +=item Return Value: Ordered list of column names =back @@ -440,7 +456,7 @@ sub columns { =item Arguments: \@colnames ? -=item Return value: Hashref of column name/info pairs +=item Return Value: Hashref of column name/info pairs =back @@ -458,18 +474,18 @@ sub columns_info { my $colinfo = $self->_columns; if ( - first { ! $_->{data_type} } values %$colinfo - and ! $self->{_columns_info_loaded} and $self->column_info_from_storage and - my $stor = try { $self->storage } + grep { ! $_->{data_type} } values %$colinfo + and + my $stor = dbic_internal_try { $self->storage } ) { $self->{_columns_info_loaded}++; # try for the case of storage without table - try { + dbic_internal_try { my $info = $stor->columns_info_for( $self->from ); my $lc_info = { map { (lc $_) => $info->{$_} } @@ -494,9 +510,9 @@ sub columns_info { } else { $self->throw_exception( sprintf ( - "No such column '%s' on source %s", + "No such column '%s' on source '%s'", $_, - $self->source_name, + $self->source_name || $self->name || 'Unknown source...?', )); } } @@ -514,7 +530,7 @@ sub columns_info { =item Arguments: @colnames -=item Return value: undefined +=item Return Value: not defined =back @@ -532,7 +548,7 @@ broken result source. =item Arguments: $colname -=item Return value: undefined +=item Return Value: not defined =back @@ -570,14 +586,14 @@ sub remove_column { shift->remove_columns(@_); } # DO NOT CHANGE THIS TO GLOB =item Arguments: @cols -=item Return value: undefined +=item Return Value: not defined =back Defines one or more columns as primary key for this source. Must be called after L. -Additionally, defines a L +Additionally, defines a L named C. Note: you normally do want to define a primary key on your sources @@ -590,11 +606,18 @@ for more info. sub set_primary_key { my ($self, @cols) = @_; - # check if primary key columns are valid columns - foreach my $col (@cols) { - $self->throw_exception("No such column $col on table " . $self->name) - unless $self->has_column($col); + + my $colinfo = $self->columns_info(\@cols); + for my $col (@cols) { + carp_unique(sprintf ( + "Primary key of source '%s' includes the column '%s' which has its " + . "'is_nullable' attribute set to true. This is a mistake and will cause " + . 'various Result-object operations to fail', + $self->source_name || $self->name || 'Unknown source...?', + $col, + )) if $colinfo->{$col}{is_nullable}; } + $self->_primaries(\@cols); $self->add_unique_constraint(primary => \@cols); @@ -604,9 +627,9 @@ sub set_primary_key { =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: Ordered list of primary column names +=item Return Value: Ordered list of primary column names =back @@ -622,7 +645,7 @@ sub primary_columns { # a helper method that will automatically die with a descriptive message if # no pk is defined on the source in question. For internal use to save # on if @pks... boilerplate -sub _pri_cols { +sub _pri_cols_or_die { my $self = shift; my @pcols = $self->primary_columns or $self->throw_exception (sprintf( @@ -633,6 +656,20 @@ sub _pri_cols { return @pcols; } +# same as above but mandating single-column PK (used by relationship condition +# inference) +sub _single_pri_col_or_die { + my $self = shift; + my ($pri, @too_many) = $self->_pri_cols_or_die; + + $self->throw_exception( sprintf( + "Operation requires a single-column primary key declared on '%s'", + $self->source_name || $self->result_class || $self->name || 'Unknown source...?', + )) if @too_many; + return $pri; +} + + =head2 sequence Manually define the correct sequence for your table, to avoid the overhead @@ -643,7 +680,7 @@ will be applied to the L of each L =item Arguments: $sequence_name -=item Return value: undefined +=item Return Value: not defined =back @@ -666,7 +703,7 @@ sub sequence { =item Arguments: $name?, \@colnames -=item Return value: undefined +=item Return Value: not defined =back @@ -732,7 +769,7 @@ sub add_unique_constraint { =item Arguments: @constraints -=item Return value: undefined +=item Return Value: not defined =back @@ -764,7 +801,7 @@ sub add_unique_constraints { my $self = shift; my @constraints = @_; - if ( !(@constraints % 2) && first { ref $_ ne 'ARRAY' } @constraints ) { + if ( !(@constraints % 2) && grep { ref $_ ne 'ARRAY' } @constraints ) { # with constraint name while (my ($name, $constraint) = splice @constraints, 0, 2) { $self->add_unique_constraint($name => $constraint); @@ -784,7 +821,7 @@ sub add_unique_constraints { =item Arguments: \@colnames -=item Return value: Constraint name +=item Return Value: Constraint name =back @@ -810,6 +847,7 @@ sub name_unique_constraint { my $name = $self->name; $name = $$name if (ref $name eq 'SCALAR'); + $name =~ s/ ^ [^\.]+ \. //x; # strip possible schema qualifier return join '_', $name, @$cols; } @@ -818,9 +856,9 @@ sub name_unique_constraint { =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: Hash of unique constraint data +=item Return Value: Hash of unique constraint data =back @@ -842,9 +880,9 @@ sub unique_constraints { =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: Unique constraint names +=item Return Value: Unique constraint names =back @@ -868,7 +906,7 @@ sub unique_constraint_names { =item Arguments: $constraintname -=item Return value: List of constraint columns +=item Return Value: List of constraint columns =back @@ -896,7 +934,7 @@ sub unique_constraint_columns { =item Arguments: $callback_name | \&callback_code -=item Return value: $callback_name | \&callback_code +=item Return Value: $callback_name | \&callback_code =back @@ -963,13 +1001,39 @@ sub _invoke_sqlt_deploy_hook { } } +=head2 result_class + +=over 4 + +=item Arguments: $classname + +=item Return Value: $classname + +=back + + use My::Schema::ResultClass::Inflator; + ... + + use My::Schema::Artist; + ... + __PACKAGE__->result_class('My::Schema::ResultClass::Inflator'); + +Set the default result class for this source. You can use this to create +and use your own result inflator. See L +for more details. + +Please note that setting this to something like +L will make every result unblessed +and make life more difficult. Inflators like those are better suited to +temporary usage via L. + =head2 resultset =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: $resultset +=item Return Value: L<$resultset|DBIx::Class::ResultSet> =back @@ -986,7 +1050,7 @@ but is cached from then on unless resultset_class changes. =item Arguments: $classname -=item Return value: $classname +=item Return Value: $classname =back @@ -1010,9 +1074,9 @@ exists. =over 4 -=item Arguments: \%attrs +=item Arguments: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES> -=item Return value: \%attrs +=item Return Value: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES> =back @@ -1023,8 +1087,35 @@ exists. $source->resultset_attributes({ order_by => [ 'id' ] }); Store a collection of resultset attributes, that will be set on every -L produced from this result source. For a full -list see L. +L produced from this result source. + +B: C comes with its own set of issues and +bugs! While C isn't deprecated per se, its usage is +not recommended! + +Since relationships use attributes to link tables together, the "default" +attributes you set may cause unpredictable and undesired behavior. Furthermore, +the defaults cannot be turned off, so you are stuck with them. + +In most cases, what you should actually be using are project-specific methods: + + package My::Schema::ResultSet::Artist; + use base 'DBIx::Class::ResultSet'; + ... + + # BAD IDEA! + #__PACKAGE__->resultset_attributes({ prefetch => 'tracks' }); + + # GOOD IDEA! + sub with_tracks { shift->search({}, { prefetch => 'tracks' }) } + + # in your code + $schema->resultset('Artist')->with_tracks->... + +This gives you the flexibility of not using it when you don't need it. + +For more complex situations, another solution would be to use a virtual view +via L. =cut @@ -1038,7 +1129,7 @@ sub resultset { $self->resultset_class->new( $self, { - try { %{$self->schema->default_resultset_attributes} }, + ( dbic_internal_try { %{$self->schema->default_resultset_attributes} } ), %{$self->{resultset_attributes}}, }, ); @@ -1048,7 +1139,7 @@ sub resultset { =over 4 -=item Arguments: None +=item Arguments: none =item Result value: $name @@ -1084,9 +1175,9 @@ its class name. =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: FROM clause +=item Return Value: FROM clause =back @@ -1100,13 +1191,24 @@ clause contents. sub from { die 'Virtual method!' } +=head2 source_info + +Stores a hashref of per-source metadata. No specific key names +have yet been standardized, the examples below are purely hypothetical +and don't actually accomplish anything on their own: + + __PACKAGE__->source_info({ + "_tablespace" => 'fast_disk_array_3', + "_engine" => 'InnoDB', + }); + =head2 schema =over 4 -=item Arguments: $schema +=item Arguments: L<$schema?|DBIx::Class::Schema> -=item Return value: A schema object +=item Return Value: L<$schema|DBIx::Class::Schema> =back @@ -1140,17 +1242,15 @@ sub schema { =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: A Storage object +=item Return Value: L<$storage|DBIx::Class::Storage> =back $source->storage->debug(1); -Returns the storage handle for the current schema. - -See also: L +Returns the L for the current schema. =cut @@ -1160,13 +1260,13 @@ sub storage { shift->schema->storage; } =over 4 -=item Arguments: $relname, $related_source_name, \%cond, [ \%attrs ] +=item Arguments: $rel_name, $related_source_name, \%cond, \%attrs? -=item Return value: 1/true if it succeeded +=item Return Value: 1/true if it succeeded =back - $source->add_relationship('relname', 'related_source', $cond, $attrs); + $source->add_relationship('rel_name', 'related_source', $cond, $attrs); L describes a series of methods which create pre-defined useful types of relationships. Look there first @@ -1243,10 +1343,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 }; @@ -1257,42 +1358,19 @@ sub add_relationship { $self->_relationships(\%rels); return $self; - -# XXX disabled. doesn't work properly currently. skip in tests. - - my $f_source = $self->schema->source($f_source_name); - unless ($f_source) { - $self->ensure_class_loaded($f_source_name); - $f_source = $f_source_name->result_source; - #my $s_class = ref($self->schema); - #$f_source_name =~ m/^${s_class}::(.*)$/; - #$self->schema->register_class(($1 || $f_source_name), $f_source_name); - #$f_source = $self->schema->source($f_source_name); - } - return unless $f_source; # Can't test rel without f_source - - try { $self->_resolve_join($rel, 'me', {}, []) } - catch { - # If the resolve failed, back out and re-throw the error - delete $rels{$rel}; - $self->_relationships(\%rels); - $self->throw_exception("Error creating relationship $rel: $_"); - }; - - 1; } =head2 relationships =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: List of relationship names +=item Return Value: L<@rel_names|DBIx::Class::Relationship> =back - my @relnames = $source->relationships(); + my @rel_names = $source->relationships(); Returns all relationship names for this source. @@ -1306,29 +1384,29 @@ sub relationships { =over 4 -=item Arguments: $relname +=item Arguments: L<$rel_name|DBIx::Class::Relationship> -=item Return value: Hashref of relation data, +=item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship> =back Returns a hash of relationship information for the specified relationship -name. The keys/values are as specified for L. +name. The keys/values are as specified for L. =cut sub relationship_info { - my ($self, $rel) = @_; - return $self->_relationships->{$rel}; + #my ($self, $rel) = @_; + return shift->_relationships->{+shift}; } =head2 has_relationship =over 4 -=item Arguments: $rel +=item Arguments: L<$rel_name|DBIx::Class::Relationship> -=item Return value: 1/0 (true/false) +=item Return Value: 1/0 (true/false) =back @@ -1337,17 +1415,17 @@ Returns true if the source has a relationship of this name, false otherwise. =cut sub has_relationship { - my ($self, $rel) = @_; - return exists $self->_relationships->{$rel}; + #my ($self, $rel) = @_; + return exists shift->_relationships->{+shift}; } =head2 reverse_relationship_info =over 4 -=item Arguments: $relname +=item Arguments: L<$rel_name|DBIx::Class::Relationship> -=item Return value: Hashref of relationship data +=item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship> =back @@ -1377,12 +1455,10 @@ sub reverse_relationship_info { my $stripped_cond = $self->__strip_relcond ($rel_info->{cond}); - my $rsrc_schema_moniker = $self->source_name - if try { $self->schema }; + my $registered_source_name = $self->source_name; # this may be a partial schema or something else equally esoteric - my $other_rsrc = try { $self->related_source($rel) } - or return $ret; + my $other_rsrc = $self->related_source($rel); # Get all the relationships for that source that related to this source # whose foreign column set are our self columns on $rel and whose self @@ -1394,14 +1470,14 @@ sub reverse_relationship_info { # to use the source_names, otherwise we will use the actual classes # the schema may be partial - my $roundtrip_rsrc = try { $other_rsrc->related_source($other_rel) } + my $roundtrip_rsrc = dbic_internal_try { $other_rsrc->related_source($other_rel) } or next; - if ($rsrc_schema_moniker and try { $roundtrip_rsrc->schema } ) { - next unless $rsrc_schema_moniker eq $roundtrip_rsrc->source_name; + if ($registered_source_name) { + next if $registered_source_name ne ($roundtrip_rsrc->source_name || '') } else { - next unless $self->result_class eq $roundtrip_rsrc->result_class; + next if $self->result_class ne $roundtrip_rsrc->result_class; } my $other_rel_info = $other_rsrc->relationship_info($other_rel); @@ -1477,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} or ( $vals->{$col}||'' ) eq UNRESOLVABLE_CONDITION ) { + $cols->{missing}{$col} = undef; + } + elsif( ! defined $vals->{$col} ) { + $cols->{$args->{carp_on_nulls} ? 'undefined' : 'missing'}{$col} = undef; + } + else { + # we need to inject back the '=' as _extract_fixed_condition_columns + # will strip it from literals and values alike, resulting in an invalid + # condition in the end + $cols->{present}{$col} = { '=' => $vals->{$col} }; + } + + $cols->{fc}{$col} = 1 if ( + ( ! $cols->{missing} or ! exists $cols->{missing}{$col} ) + and + keys %{ $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 { %{ $cols->{$_}||{} } } qw(present undefined) }; +} + # Returns the {from} structure used to express JOIN conditions sub _resolve_join { my ($self, $join, $alias, $seen, $jpath, $parent_force_left) = @_; @@ -1546,14 +1683,20 @@ sub _resolve_join { , -join_path => [@$jpath, { $join => $as } ], -is_single => ( - (! $rel_info->{attrs}{accessor}) + ! $rel_info->{attrs}{accessor} or - first { $rel_info->{attrs}{accessor} eq $_ } (qw/single filter/) + $rel_info->{attrs}{accessor} eq 'single' + or + $rel_info->{attrs}{accessor} eq 'filter' ), -alias => $as, - -relation_chain_depth => $seen->{-relation_chain_depth} || 0, + -relation_chain_depth => ( $seen->{-relation_chain_depth} || 0 ) + 1, }, - scalar $self->_resolve_condition($rel_info->{cond}, $as, $alias, $join) + $self->_resolve_relationship_condition( + rel_name => $join, + self_alias => $alias, + foreign_alias => $as, + )->{condition}, ]; } } @@ -1568,9 +1711,9 @@ sub pk_depends_on { # having already been inserted. Takes the name of the relationship and a # hashref of columns of the related object. sub _pk_depends_on { - my ($self, $relname, $rel_data) = @_; + my ($self, $rel_name, $rel_data) = @_; - my $relinfo = $self->relationship_info($relname); + my $relinfo = $self->relationship_info($rel_name); # don't assume things if the relationship direction is specified return $relinfo->{attrs}{is_foreign_key_constraint} @@ -1585,7 +1728,7 @@ sub _pk_depends_on { # assume anything that references our PK probably is dependent on us # rather than vice versa, unless the far side is (a) defined or (b) # auto-increment - my $rel_source = $self->related_source($relname); + my $rel_source = $self->related_source($rel_name); foreach my $p ($self->primary_columns) { if (exists $keyhash->{$p}) { @@ -1602,812 +1745,513 @@ sub _pk_depends_on { sub resolve_condition { carp 'resolve_condition is a private method, stop calling it'; - my $self = shift; - $self->_resolve_condition (@_); + shift->_resolve_condition (@_); } -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-triviail values (notmally conditions) returned as a part -# of a joinfree condition hash sub _resolve_condition { - my ($self, $cond, $as, $for, $relname) = @_; +# carp_unique sprintf +# '_resolve_condition is a private method, and moreover is about to go ' +# . 'away. Please contact the development team at %s if you believe you ' +# . 'have a genuine use for this method, in order to discuss alternatives.', +# DBIx::Class::_ENV_::HELP_URL, +# ; - my $obj_rel = !!blessed $for; +####################### +### API Design? What's that...? (a backwards compatible shim, kill me now) - if (ref $cond eq 'CODE') { - my $relalias = $obj_rel ? 'me' : $as; + my ($self, $cond, @res_args, $rel_name); - my ($crosstable_cond, $joinfree_cond) = $cond->({ - self_alias => $obj_rel ? $as : $for, - foreign_alias => $relalias, - self_resultsource => $self, - foreign_relname => $relname || ($obj_rel ? $as : $for), - self_rowobj => $obj_rel ? $for : undef - }); + # we *SIMPLY DON'T KNOW YET* which arg is which, yay + ($self, $cond, $res_args[0], $res_args[1], $rel_name) = @_; - my $cond_cols; - if ($joinfree_cond) { + # assume that an undef is an object-like unset (set_from_related(undef)) + my @is_objlike = map { ! defined $_ or length ref $_ } (@res_args); - # FIXME sanity check until things stabilize, remove at some point - $self->throw_exception ( - "A join-free condition returned for relationship '$relname' without a row-object to chain from" - ) unless $obj_rel; - - # FIXME another sanity check - if ( - ref $joinfree_cond ne 'HASH' - or - first { $_ !~ /^\Q$relalias.\E.+/ } keys %$joinfree_cond - ) { - $self->throw_exception ( - "The join-free condition returned for relationship '$relname' must be a hash " - .'reference with all keys being valid columns on the related result source' - ); - } - - # normalize - for (values %$joinfree_cond) { - $_ = $_->{'='} if ( - ref $_ eq 'HASH' - and - keys %$_ == 1 - and - exists $_->{'='} - ); - } + # turn objlike into proper objects for saner code further down + for (0,1) { + next unless $is_objlike[$_]; - # see which parts of the joinfree cond are conditionals - my $relcol_list = { map { $_ => 1 } $self->related_source($relname)->columns }; + if ( defined blessed $res_args[$_] ) { - for my $c (keys %$joinfree_cond) { - my ($colname) = $c =~ /^ (?: \Q$relalias.\E )? (.+)/x; - - unless ($relcol_list->{$colname}) { - push @$cond_cols, $colname; - next; - } - - if ( - ref $joinfree_cond->{$c} - and - ref $joinfree_cond->{$c} ne 'SCALAR' - and - ref $joinfree_cond->{$c} ne 'REF' - ) { - push @$cond_cols, $colname; - next; - } + # but wait - there is more!!! WHAT THE FUCK?!?!?!?! + if ($res_args[$_]->isa('DBIx::Class::ResultSet')) { + carp('Passing a resultset for relationship resolution makes no sense - invoking __gremlins__'); + $is_objlike[$_] = 0; + $res_args[$_] = '__gremlins__'; } - - return wantarray ? ($joinfree_cond, 0, $cond_cols) : $joinfree_cond; } else { - return wantarray ? ($crosstable_cond, 1) : $crosstable_cond; - } - } - elsif (ref $cond eq 'HASH') { - my %ret; - foreach my $k (keys %{$cond}) { - my $v = $cond->{$k}; - # XXX should probably check these are valid columns - $k =~ s/^foreign\.// || - $self->throw_exception("Invalid rel cond key ${k}"); - $v =~ s/^self\.// || - $self->throw_exception("Invalid rel cond val ${v}"); - if (ref $for) { # Object - #warn "$self $k $for $v"; - unless ($for->has_column_loaded($v)) { - if ($for->in_storage) { - $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.', - $as, - $for, - $v, - ); - } - return $UNRESOLVABLE_CONDITION; - } - $ret{$k} = $for->get_column($v); - #$ret{$k} = $for->get_column($v) if $for->has_column_loaded($v); - #warn %ret; - } elsif (!defined $for) { # undef, i.e. "no object" - $ret{$k} = undef; - } elsif (ref $as eq 'HASH') { # reverse hashref - $ret{$v} = $as->{$k}; - } elsif (ref $as) { # reverse object - $ret{$v} = $as->get_column($k); - } elsif (!defined $as) { # undef, i.e. "no reverse object" - $ret{$v} = undef; - } else { - $ret{"${as}.${k}"} = { -ident => "${for}.${v}" }; - } - } + $res_args[$_] ||= {}; - return wantarray - ? ( \%ret, ($obj_rel || !defined $as || ref $as) ? 0 : 1 ) - : \%ret - ; - } - elsif (ref $cond eq 'ARRAY') { - my (@ret, $crosstable); - for (@$cond) { - my ($cond, $crosstab) = $self->_resolve_condition($_, $as, $for, $relname); - push @ret, $cond; - $crosstable ||= $crosstab; + # 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'; } - return wantarray ? (\@ret, $crosstable) : \@ret; - } - else { - $self->throw_exception ("Can't handle condition $cond for relationship '$relname' yet :("); } -} -# Accepts one or more relationships for the current source and returns an -# array of column names for each of those relationships. Column names are -# prefixed relative to the current source, in accordance with where they appear -# in the supplied relationships. -sub _resolve_prefetch { - my ($self, $pre, $alias, $alias_map, $order, $pref_path) = @_; - $pref_path ||= []; + my $args = { + # 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_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] ) + ), - if (not defined $pre or not length $pre) { - return (); - } - elsif( ref $pre eq 'ARRAY' ) { - return - map { $self->_resolve_prefetch( $_, $alias, $alias_map, $order, [ @$pref_path ] ) } - @$pre; - } - elsif( ref $pre eq 'HASH' ) { - my @ret = - map { - $self->_resolve_prefetch($_, $alias, $alias_map, $order, [ @$pref_path ] ), - $self->related_source($_)->_resolve_prefetch( - $pre->{$_}, "${alias}.$_", $alias_map, $order, [ @$pref_path, $_] ) - } keys %$pre; - return @ret; - } - elsif( ref $pre ) { - $self->throw_exception( - "don't know how to resolve prefetch reftype ".ref($pre)); - } - else { - my $p = $alias_map; - $p = $p->{$_} for (@$pref_path, $pre); + ( $rel_name ? ( rel_name => $rel_name ) : () ), + }; - $self->throw_exception ( - "Unable to resolve prefetch '$pre' - join alias map does not contain an entry for path: " - . join (' -> ', @$pref_path, $pre) - ) if (ref $p->{-join_aliases} ne 'ARRAY' or not @{$p->{-join_aliases}} ); + # Allowing passing relconds different than the relationshup itself is cute, + # but likely dangerous. Remove that from the (still unofficial) API of + # _resolve_relationship_condition, and instead make it "hard on purpose" + local $self->relationship_info( $args->{rel_name} )->{cond} = $cond if defined $cond; - my $as = shift @{$p->{-join_aliases}}; +####################### - my $rel_info = $self->relationship_info( $pre ); - $self->throw_exception( $self->source_name . " has no such relationship '$pre'" ) - unless $rel_info; + # now it's fucking easy isn't it?! + my $rc = $self->_resolve_relationship_condition( $args ); - my $as_prefix = ($alias =~ /^.*?\.(.+)$/ ? $1.'.' : ''); - my $rel_source = $self->related_source($pre); + my @res = ( + ( $rc->{join_free_condition} || $rc->{condition} ), + ! $rc->{join_free_condition}, + ); - if ($rel_info->{attrs}{accessor} && $rel_info->{attrs}{accessor} eq 'multi') { - $self->throw_exception( - "Can't prefetch has_many ${pre} (join cond too complex)") - unless ref($rel_info->{cond}) eq 'HASH'; - my $dots = @{[$as_prefix =~ m/\./g]} + 1; # +1 to match the ".${as_prefix}" + # _resolve_relationship_condition always returns qualified cols even in the + # case of join_free_condition, but nothing downstream expects this + if ($rc->{join_free_condition} and ref $res[0] eq 'HASH') { + $res[0] = { map + { ($_ =~ /\.(.+)/) => $res[0]{$_} } + keys %{$res[0]} + }; + } - #my @col = map { (/^self\.(.+)$/ ? ("${as_prefix}.$1") : ()); } - # values %{$rel_info->{cond}}; - my @key = map { (/^foreign\.(.+)$/ ? ($1) : ()); } - keys %{$rel_info->{cond}}; + # and more legacy + return wantarray ? @res : $res[0]; +} - push @$order, map { "${as}.$_" } @key; +# 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 => (scalar) +# foreign_alias => (scalar) +# foreign_values => (either not supplied, or a hashref, or a foreign ResultObject (to be ->get_columns()ed), or plain undef ) +# self_alias => (scalar) +# self_result_object => (either not supplied or a result object) +# require_join_free_condition => (boolean, throws on failure to construct a JF-cond) +# infer_values_based_on => (either not supplied or a hashref, implies require_join_free_condition) +# +## returns a hash +# condition => (a valid *likely fully qualified* sqla cond structure) +# identity_map => (a hashref of foreign-to-self *unqualified* column equality names) +# join_free_condition => (a valid *fully qualified* sqla cond structure, maybe unset) +# inferred_values => (in case of an available join_free condition, this is a hashref of +# *unqualified* column/value *EQUALITY* pairs, representing an amalgamation +# of the JF-cond parse and infer_values_based_on +# always either complete or unset) +# +sub _resolve_relationship_condition { + my $self = shift; - if (my $rel_order = $rel_info->{attrs}{order_by}) { - # this is kludgy and incomplete, I am well aware - # but the parent method is going away entirely anyway - # so sod it - my $sql_maker = $self->storage->sql_maker; - my ($orig_ql, $orig_qr) = $sql_maker->_quote_chars; - my $sep = $sql_maker->name_sep; + my $args = { ref $_[0] eq 'HASH' ? %{ $_[0] } : @_ }; - # install our own quoter, so we can catch unqualified stuff - local $sql_maker->{quote_char} = ["\x00", "\xFF"]; + for ( qw( rel_name self_alias foreign_alias ) ) { + $self->throw_exception("Mandatory argument '$_' to _resolve_relationship_condition() is not a plain string") + if !defined $args->{$_} or length ref $args->{$_}; + } - my $quoted_prefix = "\x00${as}\xFF"; + $self->throw_exception("Arguments 'self_alias' and 'foreign_alias' may not be identical") + if $args->{self_alias} eq $args->{foreign_alias}; - for my $chunk ( $sql_maker->_order_by_chunks ($rel_order) ) { - my @bind; - ($chunk, @bind) = @$chunk if ref $chunk; +# TEMP + my $exception_rel_id = "relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}'"; - $chunk = "${quoted_prefix}${sep}${chunk}" - unless $chunk =~ /\Q$sep/; + my $rel_info = $self->relationship_info($args->{rel_name}) +# TEMP +# or $self->throw_exception( "No such $exception_rel_id" ); + or carp_unique("Requesting resolution on non-existent relationship '$args->{rel_name}' on source '@{[ $self->source_name ]}': fix your code *soon*, as it will break with the next major version"); - $chunk =~ s/\x00/$orig_ql/g; - $chunk =~ s/\xFF/$orig_qr/g; - push @$order, \[$chunk, @bind]; - } - } - } +# TEMP + $exception_rel_id = "relationship '$rel_info->{_original_name}' on source '@{[ $self->source_name ]}'" + if $rel_info and exists $rel_info->{_original_name}; - return map { [ "${as}.$_", "${as_prefix}${pre}.$_", ] } - $rel_source->columns; - } -} + $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}; -# adding a dep on MoreUtils *just* for this is retarded -my $unique_numlist = sub { [ sort { $a <=> $b } keys %{ {map { $_ => 1 } @_ }} ] }; - -# This error must be thrown from two distinct codepaths, joining them is -# rather hard. Go for this hack instead. -my $get_related_source = sub { - my ($rsrc, $rel, $relcols) = @_; - try { - $rsrc->related_source ($rel) - } catch { - $rsrc->throw_exception(sprintf( - "Can't inflate prefetch into non-existent relationship '%s' from '%s', " - . "check the inflation specification (columns/as) ending in '...%s.%s'.", - $rel, - $rsrc->source_name, - $rel, - (sort { length($a) <=> length ($b) } keys %$relcols)[0], - ))}; -}; - -# Takes a selection list and generates a collapse-map representing -# row-object fold-points. Every relationship is assigned a set of unique, -# non-nullable columns (which may *not even be* from the same resultset) -# and the collapser will use this information to correctly distinguish -# data of individual to-be-row-objects. -sub _resolve_collapse { - my ($self, $as, $as_fq_idx, $rel_chain, $parent_info, $node_idx_ref) = @_; - - # for comprehensible error messages put ourselves at the head of the relationship chain - $rel_chain ||= [ $self->source_name ]; - - # record top-level fully-qualified column index - $as_fq_idx ||= { %$as }; - - my ($my_cols, $rel_cols); - for (keys %$as) { - if ($_ =~ /^ ([^\.]+) \. (.+) /x) { - $rel_cols->{$1}{$2} = 1; - } - else { - $my_cols->{$_} = {}; # important for ||= below - } - } + $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'; - my $relinfo; - # run through relationships, collect metadata, inject non-left fk-bridges from - # *INNER-JOINED* children (if any) - for my $rel (keys %$rel_cols) { - my $rel_src = $get_related_source->($self, $rel, $rel_cols->{$rel}); + $args->{require_join_free_condition} ||= !!$args->{infer_values_based_on}; - my $inf = $self->relationship_info ($rel); + $self->throw_exception( "Argument 'self_result_object' must be an object inheriting from DBIx::Class::Row" ) + if ( + exists $args->{self_result_object} + and + ( ! defined blessed $args->{self_result_object} or ! $args->{self_result_object}->isa('DBIx::Class::Row') ) + ) + ; - $relinfo->{$rel}{is_single} = $inf->{attrs}{accessor} && $inf->{attrs}{accessor} ne 'multi'; - $relinfo->{$rel}{is_inner} = ( $inf->{attrs}{join_type} || '' ) !~ /^left/i; - $relinfo->{$rel}{rsrc} = $rel_src; + my $rel_rsrc = $self->related_source($args->{rel_name}); + my $storage = $self->schema->storage; - my $cond = $inf->{cond}; + if (exists $args->{foreign_values}) { - if ( - ref $cond eq 'HASH' - and - keys %$cond - and - ! first { $_ !~ /^foreign\./ } (keys %$cond) - and - ! first { $_ !~ /^self\./ } (values %$cond) - ) { - for my $f (keys %$cond) { - my $s = $cond->{$f}; - $_ =~ s/^ (?: foreign | self ) \.//x for ($f, $s); - $relinfo->{$rel}{fk_map}{$s} = $f; - - # need to know source from *our* pov, hnce $rel. - $my_cols->{$s} ||= { via_fk => "$rel.$f" } if ( - defined $rel_cols->{$rel}{$f} # in fact selected - and - (! $node_idx_ref or $relinfo->{$rel}{is_inner}) # either top-level or an inner join - ); - } + if (! defined $args->{foreign_values} ) { + # fallback: undef => {} + $args->{foreign_values} = {}; } - } + elsif (defined blessed $args->{foreign_values}) { - # if the parent is already defined, assume all of its related FKs are selected - # (even if they in fact are NOT in the select list). Keep a record of what we - # assumed, and if any such phantom-column becomes part of our own collapser, - # throw everything assumed-from-parent away and replace with the collapser of - # the parent (whatever it may be) - my $assumed_from_parent; - unless ($parent_info->{underdefined}) { - $assumed_from_parent->{columns} = { map - # only add to the list if we do not already select said columns - { ! exists $my_cols->{$_} ? ( $_ => 1 ) : () } - values %{$parent_info->{rel_condition} || {}} - }; + $self->throw_exception( "Objects supplied as 'foreign_values' ($args->{foreign_values}) must inherit from DBIx::Class::Row" ) + unless $args->{foreign_values}->isa('DBIx::Class::Row'); - $my_cols->{$_} = { via_collapse => $parent_info->{collapse_on} } - for keys %{$assumed_from_parent->{columns}}; - } + carp_unique( + "Objects supplied as 'foreign_values' ($args->{foreign_values}) " + . "usually should inherit from the related ResultClass ('@{[ $rel_rsrc->result_class ]}'), " + . "perhaps you've made a mistake invoking the condition resolver?" + ) unless $args->{foreign_values}->isa($rel_rsrc->result_class); - # get colinfo for everything - if ($my_cols) { - my $ci = $self->columns_info; - $my_cols->{$_}{colinfo} = $ci->{$_} for keys %$my_cols; - } + $args->{foreign_values} = { $args->{foreign_values}->get_columns }; + } + elsif ( ref $args->{foreign_values} eq 'HASH' ) { - my $collapse_map; + # re-build {foreign_values} excluding identically named rels + if( keys %{$args->{foreign_values}} ) { - # try to resolve based on our columns (plus already inserted FK bridges) - if ( - $my_cols - and - my $uset = $self->_unique_column_set ($my_cols) - ) { - # see if the resulting collapser relies on any implied columns, - # and fix stuff up if this is the case - - my $parent_collapser_used = defined delete @{$uset}{keys %{$assumed_from_parent->{columns}}}; - $collapse_map->{-node_id} = $unique_numlist->( - $parent_collapser_used ? @{$parent_info->{collapse_on}} : (), - (map - { - my $fqc = join ('.', - @{$rel_chain}[1 .. $#$rel_chain], - ( $my_cols->{$_}{via_fk} || $_ ), - ); - - $as_fq_idx->{$fqc}; - } - keys %$uset - ), - ); - } + my ($col_idx, $rel_idx) = map + { { map { $_ => 1 } $rel_rsrc->$_ } } + qw( columns relationships ) + ; - # Stil don't know how to collapse - keep descending down 1:1 chains - if - # a related non-LEFT 1:1 is resolvable - its condition will collapse us - # too - unless ($collapse_map->{-node_id}) { - my @candidates; - - for my $rel (keys %$relinfo) { - next unless ($relinfo->{$rel}{is_single} && $relinfo->{$rel}{is_inner}); - - if ( my $rel_collapse = $relinfo->{$rel}{rsrc}->_resolve_collapse ( - $rel_cols->{$rel}, - $as_fq_idx, - [ @$rel_chain, $rel ], - { underdefined => 1 } - )) { - push @candidates, $rel_collapse->{-node_id}; + my $equivalencies = $storage->_extract_fixed_condition_columns( + $args->{foreign_values}, + 'consider nulls', + ); + + $args->{foreign_values} = { map { + # skip if relationship *and* a non-literal ref + # this means a multicreate stub was passed in + ( + $rel_idx->{$_} + and + length ref $args->{foreign_values}{$_} + and + ! is_literal_value($args->{foreign_values}{$_}) + ) + ? () + : ( $_ => ( + ! $col_idx->{$_} + ? $self->throw_exception( "Key '$_' supplied as 'foreign_values' is not a column on related source '@{[ $rel_rsrc->source_name ]}'" ) + : ( !exists $equivalencies->{$_} or ($equivalencies->{$_}||'') eq UNRESOLVABLE_CONDITION ) + ? $self->throw_exception( "Value supplied for '...{foreign_values}{$_}' is not a direct equivalence expression" ) + : $args->{foreign_values}{$_} + )) + } keys %{$args->{foreign_values}} }; } } - - # get the set with least amount of columns - # FIXME - maybe need to implement a data type order as well (i.e. prefer several ints - # to a single varchar) - if (@candidates) { - ($collapse_map->{-node_id}) = sort { scalar @$a <=> scalar @$b } (@candidates); + else { + $self->throw_exception( + "Argument 'foreign_values' must be either an object inheriting from '@{[ $rel_rsrc->result_class ]}', " + . "or a hash reference, or undef" + ); } } - # Still dont know how to collapse - see if the parent passed us anything - # (i.e. reuse collapser over 1:1) - unless ($collapse_map->{-node_id}) { - $collapse_map->{-node_id} = $parent_info->{collapse_on} - if $parent_info->{collapser_reusable}; - } + my $ret; - # stop descending into children if we were called by a parent for first-pass - # and don't despair if nothing was found (there may be other parallel branches - # to dive into) - if ($parent_info->{underdefined}) { - return $collapse_map->{-node_id} ? $collapse_map : undef - } - # nothing down the chain resolved - can't calculate a collapse-map - elsif (! $collapse_map->{-node_id}) { - $self->throw_exception ( sprintf - "Unable to calculate a definitive collapse column set for %s%s: fetch more unique non-nullable columns", - $self->source_name, - @$rel_chain > 1 - ? sprintf (' (last member of the %s chain)', join ' -> ', @$rel_chain ) - : '' - , - ); - } + if (ref $rel_info->{cond} eq 'CODE') { - # If we got that far - we are collapsable - GREAT! Now go down all children - # a second time, and fill in the rest + my $cref_args = { + rel_name => $args->{rel_name}, + self_resultsource => $self, + self_alias => $args->{self_alias}, + foreign_alias => $args->{foreign_alias}, + ( map + { (exists $args->{$_}) ? ( $_ => $args->{$_} ) : () } + qw( self_result_object foreign_values ) + ), + }; - $collapse_map->{-is_optional} = 1 if $parent_info->{is_optional}; - $collapse_map->{-node_index} = ${ $node_idx_ref ||= \do { my $x = 1 } }++; # this is *deliberately* not 0-based + # legacy - never remove these!!! + $cref_args->{foreign_relname} = $cref_args->{rel_name}; - my (@id_sets, $multis_in_chain); - for my $rel (sort keys %$relinfo) { + $cref_args->{self_rowobj} = $cref_args->{self_result_object} + if exists $cref_args->{self_result_object}; - $collapse_map->{$rel} = $relinfo->{$rel}{rsrc}->_resolve_collapse ( - { map { $_ => 1 } ( keys %{$rel_cols->{$rel}} ) }, + ($ret->{condition}, $ret->{join_free_condition}, my @extra) = $rel_info->{cond}->($cref_args); - $as_fq_idx, + # 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; - [ @$rel_chain, $rel], + if (my $jfc = $ret->{join_free_condition}) { - { - collapse_on => [ @{$collapse_map->{-node_id}} ], + $self->throw_exception ( + "The join-free condition returned for $exception_rel_id must be a hash reference" + ) unless ref $jfc eq 'HASH'; - rel_condition => $relinfo->{$rel}{fk_map}, + my ($joinfree_alias, $joinfree_source); + if (defined $args->{self_result_object}) { + $joinfree_alias = $args->{foreign_alias}; + $joinfree_source = $rel_rsrc; + } + elsif (defined $args->{foreign_values}) { + $joinfree_alias = $args->{self_alias}; + $joinfree_source = $self; + } - is_optional => $collapse_map->{-is_optional}, + # FIXME sanity check until things stabilize, remove at some point + $self->throw_exception ( + "A join-free condition returned for $exception_rel_id without a result object to chain from" + ) unless $joinfree_alias; - # if this is a 1:1 our own collapser can be used as a collapse-map - # (regardless of left or not) - collapser_reusable => $relinfo->{$rel}{is_single}, - }, + my $fq_col_list = { map + { ( "$joinfree_alias.$_" => 1 ) } + $joinfree_source->columns + }; - $node_idx_ref, - ); + exists $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 ' + . "'$joinfree_alias' (instead it returned '$_')" + ) for keys %$jfc; + + ( + length ref $_ + and + defined blessed($_) + and + $_->isa('DBIx::Class::Row') + and + $self->throw_exception ( + "The join-free condition returned for $exception_rel_id may not " + . 'contain result objects as values - perhaps instead of invoking ' + . '->$something you meant to return ->get_column($something)' + ) + ) for values %$jfc; - $collapse_map->{$rel}{-is_single} = 1 if $relinfo->{$rel}{is_single}; - $collapse_map->{$rel}{-is_optional} ||= 1 unless $relinfo->{$rel}{is_inner}; - push @id_sets, @{ $collapse_map->{$rel}{-branch_id} }; + } } + elsif (ref $rel_info->{cond} eq 'HASH') { - $collapse_map->{-branch_id} = $unique_numlist->( @id_sets, @{$collapse_map->{-node_id}} ); + # the condition is static - use parallel arrays + # for a "pivot" depending on which side of the + # rel did we get as an object + my (@f_cols, @l_cols); + for my $fc (keys %{ $rel_info->{cond} }) { + my $lc = $rel_info->{cond}{$fc}; - return $collapse_map; -} + # FIXME STRICTMODE should probably check these are valid columns + $fc =~ s/^foreign\.// || + $self->throw_exception("Invalid rel cond key '$fc'"); -sub _unique_column_set { - my ($self, $cols) = @_; + $lc =~ s/^self\.// || + $self->throw_exception("Invalid rel cond val '$lc'"); - my %unique = $self->unique_constraints; + push @f_cols, $fc; + push @l_cols, $lc; + } - # always prefer the PK first, and then shortest constraints first - USET: - for my $set (delete $unique{primary}, sort { @$a <=> @$b } (values %unique) ) { - next unless $set && @$set; + # 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 (@$set) { - next USET unless ($cols->{$_} && $cols->{$_}{colinfo} && !$cols->{$_}{colinfo}{is_nullable} ); + 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}) { - return { map { $_ => 1 } @$set }; + 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]); + } + 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}, + $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; + } + } + } } + elsif (ref $rel_info->{cond} eq 'ARRAY') { + if (@{ $rel_info->{cond} } == 0) { + $ret = { + condition => UNRESOLVABLE_CONDITION, + join_free_condition => UNRESOLVABLE_CONDITION, + }; + } + else { + my @subconds = map { + local $rel_info->{cond} = $_; + $self->_resolve_relationship_condition( $args ); + } @{ $rel_info->{cond} }; - return undef; -} - -# Takes an arrayref of {as} dbic column aliases and the collapse and select -# attributes from the same $rs (the slector requirement is a temporary -# workaround), and returns a coderef capable of: -# my $me_pref_clps = $coderef->([$rs->cursor->next]) -# Where the $me_pref_clps arrayref is the future argument to -# ::ResultSet::_collapse_result. -# -# $me_pref_clps->[0] is always returned (even if as an empty hash with no -# rowdata), however branches of related data in $me_pref_clps->[1] may be -# pruned short of what was originally requested based on {as}, depending -# on: -# -# * If collapse is requested, a definitive collapse map is calculated for -# every relationship "fold-point", consisting of a set of values (which -# may not even be contained in the future 'me' of said relationship -# (for example a cd.artist_id defines the related inner-joined artist)). -# Thus a definedness check is carried on all collapse-condition values -# and if at least one is undef it is assumed that we are dealing with a -# NULLed right-side of a left-join, so we don't return a related data -# container at all, which implies no related objects -# -# * If we are not collapsing, there is no constraint on having a selector -# uniquely identifying all possible objects, and the user might have very -# well requested a column that just *happens* to be all NULLs. What we do -# in this case is fallback to the old behavior (which is a potential FIXME) -# by always returning a data container, but only filling it with columns -# IFF at least one of them is defined. This way we do not get an object -# with a bunch of has_column_loaded to undef, but at the same time do not -# further relationships based off this "null" object (e.g. in case the user -# deliberately skipped link-table values). I am pretty sure there are some -# tests that codify this behavior, need to find the exact testname. -# -# For an example of this coderef in action (and to see its guts) look at -# t/prefetch/_internals.t -# -# This is a huge performance win, as we call the same code for -# every row returned from the db, thus avoiding repeated method -# lookups when traversing relationships -# -# Also since the coderef is completely stateless (the returned structure is -# always fresh on every new invocation) this is a very good opportunity for -# memoization if further speed improvements are needed -# -# The way we construct this coderef is somewhat fugly, although I am not -# sure if the string eval is *that* bad of an idea. The alternative is to -# have a *very* large number of anon coderefs calling each other in a twisty -# maze, whereas the current result is a nice, smooth, single-pass function. -# In any case - the output of this thing is meticulously micro-tested, so -# any sort of rewrite should be relatively easy -# -sub _mk_row_parser { - my ($self, $args) = @_; - - my $inflate_index = { map - { $args->{inflate_map}[$_] => $_ } - ( 0 .. $#{$args->{inflate_map}} ) - }; - - my ($parser_src); - if ($args->{collapse}) { - # FIXME - deal with unorderedness - # unordered => $unordered - - my $collapse_map = $self->_resolve_collapse ( - # FIXME - # only consider real columns (not functions) during collapse resolution - # this check shouldn't really be here, as fucktards are not supposed to - # alias random crap to existing column names anyway, but still - just in - # case - # FIXME !!!! - this does not yet deal with unbalanced selectors correctly - # (it is now trivial as the attrs specify where things go out of sync) - { map - { ref $args->{selection}[$inflate_index->{$_}] ? () : ( $_ => $inflate_index->{$_} ) } - keys %$inflate_index + if( @{ $rel_info->{cond} } == 1 ) { + $ret = $subconds[0]; } - ); - - my $unrolled_top_branch_id_indexes = join (', ', @{$collapse_map->{-branch_id}}); + else { + # 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 ( @subconds ) { + $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} ) ); - my ($sequenced_top_branch_id, $sequenced_top_node_id) = map - { join ('', map { "{'\xFF__IDVALPOS__${_}__\xFF'}" } @$_ ) } - $collapse_map->{-branch_id}, $collapse_map->{-node_id} - ; + $subcond->{$_} and push @{$ret->{$_}}, $subcond->{$_} for (qw(condition join_free_condition)); + } + } + } + } + else { + $self->throw_exception ("Can't handle condition $rel_info->{cond} for $exception_rel_id yet :("); + } - my $rolled_out_assemblers = __visit_infmap_collapse ( - $inflate_index, $collapse_map + if ( + $args->{require_join_free_condition} + and + ( ! $ret->{join_free_condition} or $ret->{join_free_condition} eq UNRESOLVABLE_CONDITION ) + ) { + $self->throw_exception( + ucfirst sprintf "$exception_rel_id does not resolve to a %sjoin-free condition fragment", + exists $args->{foreign_values} + ? "'foreign_values'-based reversed-" + : '' ); + } - my @sprintf_args = ( - $unrolled_top_branch_id_indexes, - $sequenced_top_branch_id, - $sequenced_top_node_id, - $rolled_out_assemblers, - $sequenced_top_node_id, - ); - $parser_src = sprintf (<<'EOS', @sprintf_args); - -### BEGIN STRING EVAL - my ($rows_pos, $result_pos, $cur_row, @cur_row_id_values, $is_new_res, @collapse_idx) = (0,0); - - # this loop is a bit arcane - the rationale is that the passed in - # $_[0] will either have only one row (->next) or will have all - # rows already pulled in (->all and/or unordered). Given that the - # result can be rather large - we reuse the same already allocated - # array, since the collapsed prefetch is smaller by definition. - # At the end we cut the leftovers away and move on. - while ($cur_row = - ($rows_pos >= 0 and $_[0][$rows_pos++] or do { $rows_pos = -1; 0 } ) - || - ($_[1] and $_[1]->()) + # we got something back - sanity check and infer values if we can + my @nonvalues; + if ( + $ret->{join_free_condition} + and + $ret->{join_free_condition} ne UNRESOLVABLE_CONDITION + and + my $jfc = $storage->_collapse_cond( $ret->{join_free_condition} ) ) { - # FIXME - # optimize this away when we know we have no undefs in the collapse map - $cur_row_id_values[$_] = defined $cur_row->[$_] ? $cur_row->[$_] : "\xFF\xFFN\xFFU\xFFL\xFFL\xFF\xFF" - for (%s); # the top branch_id includes all id values + my $jfc_eqs = $storage->_extract_fixed_condition_columns($jfc, 'consider_nulls'); - # check top branch for doubling via a has_many non-selecting join or something - # 0 is reserved for this (node indexes start from 1) - next if $collapse_idx[0]%s++; + if (keys %$jfc_eqs) { - $is_new_res = ! $collapse_idx[1]%s; + for (keys %$jfc) { + # $jfc is fully qualified by definition + my ($col) = $_ =~ /\.(.+)/; - # lazify - # fire on ordered only -# if ($is_new_res = ! $collapse_idx[1]{$cur_row_id_values[2]}) { -# } - - %s + 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; + } + } - $_[0][$result_pos++] = $collapse_idx[1]%s - if $is_new_res; + # all or nothing + delete $ret->{inferred_values} if @nonvalues; + } } - splice @{$_[0]}, $result_pos; # truncate the passed in array for cases of collapsing ->all() + # did the user explicitly ask + if ($args->{infer_values_based_on}) { -### END STRING EVAL -EOS + $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; - # change the quoted placeholders to unquoted alias-references - $parser_src =~ s/ \' \xFF__VALPOS__(\d+)__\xFF \' /sprintf ('$cur_row->[%d]', $1)/gex; - $parser_src =~ s/ \' \xFF__IDVALPOS__(\d+)__\xFF \' /sprintf ('$cur_row_id_values[%d]', $1)/gex; - } - else { - $parser_src = sprintf( - '$_ = %s for @{$_[0]}', - __visit_infmap_simple($inflate_index, { rsrc => $self }), # need the $rsrc to determine left-ness - ); + $ret->{inferred_values} ||= {}; - # change the quoted placeholders to unquoted alias-references - $parser_src =~ s/ \' \xFF__VALPOS__(\d+)__\xFF \' /sprintf ('$_->[%d]', $1)/gex; + $ret->{inferred_values}{$_} = $args->{infer_values_based_on}{$_} + for keys %{$args->{infer_values_based_on}}; } - eval "sub { no strict; no warnings; $parser_src }" or die "$@\n\n$parser_src"; -} + # 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} ) { -{ - # keep our own DD object around so we don't have to fitz with quoting - my $dumper_obj; - my $visit_dump = sub { - # we actually will be producing functional perl code here, - # thus no second-guessing of what these globals might have - # been set to. DO NOT CHANGE! - ($dumper_obj ||= do { - require Data::Dumper; - Data::Dumper->new([]) - ->Purity (1) - ->Pad ('') - ->Useqq (0) - ->Terse (1) - ->Quotekeys (1) - ->Deepcopy (1) - ->Deparse (0) - ->Maxdepth (0) - ->Indent (0) - })->Values ([shift])->Dump, - }; + my $col_eqs = $storage->_extract_fixed_condition_columns($ret->{condition}); - sub __visit_infmap_simple { - my ($val_idx, $args) = @_; + my $colinfos; + for my $lhs (keys %$col_eqs) { - my $my_cols = {}; - my $rel_cols; - for (keys %$val_idx) { - if ($_ =~ /^ ([^\.]+) \. (.+) /x) { - $rel_cols->{$1}{$2} = $val_idx->{$_}; - } - else { - $my_cols->{$_} = $val_idx->{$_}; - } - } - my @relperl; - for my $rel (sort keys %$rel_cols) { - - my $rel_rsrc = $get_related_source->($args->{rsrc}, $rel, $rel_cols->{$rel}); - - #my $optional = $args->{is_optional}; - #$optional ||= ($args->{rsrc}->relationship_info($rel)->{attrs}{join_type} || '') =~ /^left/i; - - push @relperl, join ' => ', perlstring($rel), __visit_infmap_simple($rel_cols->{$rel}, { - non_top => 1, - #is_optional => $optional, - rsrc => $rel_rsrc, - }); - - # FIXME SUBOPTIMAL - disabled to satisfy t/resultset/inflate_result_api.t - #if ($optional and my @branch_null_checks = map - # { "(! defined '\xFF__VALPOS__${_}__\xFF')" } - # sort { $a <=> $b } values %{$rel_cols->{$rel}} - #) { - # $relperl[-1] = sprintf ( '(%s) ? ( %s => [] ) : ( %s )', - # join (' && ', @branch_null_checks ), - # perlstring($rel), - # $relperl[-1], - # ); - #} - } + next if $col_eqs->{$lhs} eq UNRESOLVABLE_CONDITION; - my $me_struct = keys %$my_cols - ? $visit_dump->({ map { $_ => "\xFF__VALPOS__$my_cols->{$_}__\xFF" } (keys %$my_cols) }) - : 'undef' - ; + # there is no way to know who is right and who is left in a cref + # therefore a full blown resolution call, and figure out the + # direction a bit further below + $colinfos ||= $storage->_resolve_column_info([ + { -alias => $args->{self_alias}, -rsrc => $self }, + { -alias => $args->{foreign_alias}, -rsrc => $rel_rsrc }, + ]); - return sprintf '[%s]', join (',', - $me_struct, - @relperl ? sprintf ('{ %s }', join (',', @relperl)) : (), - ); - } + next unless $colinfos->{$lhs}; # someone is engaging in witchcraft - sub __visit_infmap_collapse { - my ($val_idx, $collapse_map, $parent_info) = @_; + if ( my $rhs_ref = is_literal_value( $col_eqs->{$lhs} ) ) { - my $my_cols = {}; - my $rel_cols; - for (keys %$val_idx) { - if ($_ =~ /^ ([^\.]+) \. (.+) /x) { - $rel_cols->{$1}{$2} = $val_idx->{$_}; + if ( + $colinfos->{$rhs_ref->[0]} + and + $colinfos->{$lhs}{-source_alias} ne $colinfos->{$rhs_ref->[0]}{-source_alias} + ) { + ( $colinfos->{$lhs}{-source_alias} eq $args->{self_alias} ) + ? ( $ret->{identity_map}{$colinfos->{$lhs}{-colname}} = $colinfos->{$rhs_ref->[0]}{-colname} ) + : ( $ret->{identity_map}{$colinfos->{$rhs_ref->[0]}{-colname}} = $colinfos->{$lhs}{-colname} ) + ; + } } - else { - $my_cols->{$_} = $val_idx->{$_}; + elsif ( + $col_eqs->{$lhs} =~ /^ ( \Q$args->{self_alias}\E \. .+ ) /x + and + ($colinfos->{$1}||{})->{-result_source} == $rel_rsrc + ) { + my ($lcol, $rcol) = map + { $colinfos->{$_}{-colname} } + ( $lhs, $1 ) + ; + carp_unique( + "The $exception_rel_id specifies equality of column '$lcol' and the " + . "*VALUE* '$rcol' (you did not use the { -ident => ... } operator)" + ); } } + } - my $sequenced_node_id = join ('', map - { "{'\xFF__IDVALPOS__${_}__\xFF'}" } - @{$collapse_map->{-node_id}} - ); - - my $me_struct = keys %$my_cols - ? $visit_dump->([{ map { $_ => "\xFF__VALPOS__$my_cols->{$_}__\xFF" } (keys %$my_cols) }]) - : 'undef' - ; - my $node_idx_ref = sprintf '$collapse_idx[%d]%s', $collapse_map->{-node_index}, $sequenced_node_id; - - my $parent_idx_ref = sprintf( '$collapse_idx[%d]%s[1]{%s}', - @{$parent_info}{qw/node_idx sequenced_node_id/}, - perlstring($parent_info->{relname}), - ) if $parent_info; - - my @src; - if ($collapse_map->{-node_index} == 1) { - push @src, sprintf( '%s ||= %s;', - $node_idx_ref, - $me_struct, - ); - } - elsif ($collapse_map->{-is_single}) { - push @src, sprintf ( '%s = %s ||= %s;', - $parent_idx_ref, - $node_idx_ref, - $me_struct, - ); - } - else { - push @src, sprintf('push @{%s}, %s = %s if !%s;', - $parent_idx_ref, - $node_idx_ref, - $me_struct, - $node_idx_ref, - ); - } - - #my $known_defined = { %{ $parent_info->{known_defined} || {} } }; - #$known_defined->{$_}++ for @{$collapse_map->{-node_id}}; - - for my $rel (sort keys %$rel_cols) { - - push @src, sprintf( '%s[1]{%s} ||= [];', $node_idx_ref, perlstring($rel) ); - - push @src, __visit_infmap_collapse($rel_cols->{$rel}, $collapse_map->{$rel}, { - node_idx => $collapse_map->{-node_index}, - sequenced_node_id => $sequenced_node_id, - relname => $rel, - #known_defined => $known_defined, - }); - - # FIXME SUBOPTIMAL - disabled to satisfy t/resultset/inflate_result_api.t - #if ($collapse_map->{$rel}{-is_optional} and my @null_checks = map - # { "(! defined '\xFF__VALPOS__${_}__\xFF')" } - # sort { $a <=> $b } grep - # { ! $known_defined->{$_} } - # @{$collapse_map->{$rel}{-node_id}} - #) { - # $src[-1] = sprintf( '(%s) or %s', - # join (' || ', @null_checks ), - # $src[-1], - # ); - #} - } + # FIXME - temporary, to fool the idiotic check in SQLMaker::_join_condition + $ret->{condition} = { -and => [ $ret->{condition} ] } + unless $ret->{condition} eq UNRESOLVABLE_CONDITION; - join "\n", @src; - } + $ret; } =head2 related_source =over 4 -=item Arguments: $relname +=item Arguments: $rel_name -=item Return value: $source +=item Return Value: $source =back @@ -2424,7 +2268,7 @@ sub related_source { # if we are not registered with a schema - just use the prototype # however if we do have a schema - ask for the source by name (and # throw in the process if all fails) - if (my $schema = try { $self->schema }) { + if (my $schema = dbic_internal_try { $self->schema }) { $schema->source($self->relationship_info($rel)->{source}); } else { @@ -2438,9 +2282,9 @@ sub related_source { =over 4 -=item Arguments: $relname +=item Arguments: $rel_name -=item Return value: $classname +=item Return Value: $classname =back @@ -2460,9 +2304,9 @@ sub related_class { =over 4 -=item Arguments: None +=item Arguments: none -=item Return value: $source_handle +=item Return Value: L<$source_handle|DBIx::Class::ResultSourceHandle> =back @@ -2474,6 +2318,7 @@ relationship definitions. =cut sub handle { + require DBIx::Class::ResultSourceHandle; return DBIx::Class::ResultSourceHandle->new({ source_moniker => $_[0]->source_name, @@ -2487,6 +2332,9 @@ sub handle { my $global_phase_destroy; sub DESTROY { + ### NO detected_reinvoked_destructor check + ### This code very much relies on being called multuple times + return if $global_phase_destroy ||= in_global_destruction; ###### @@ -2511,6 +2359,7 @@ sub DESTROY { # which will serve as a signal to not try doing anything else # however beware - on older perls the exception seems randomly untrappable # due to some weird race condition during thread joining :((( + local $SIG{__DIE__} if $SIG{__DIE__}; local $@; eval { weaken $_[0]->{schema}; @@ -2518,10 +2367,15 @@ sub DESTROY { # if schema is still there reintroduce ourselves with strong refs back to us if ($_[0]->{schema}) { my $srcregs = $_[0]->{schema}->source_registrations; - for (keys %$srcregs) { - next unless $srcregs->{$_}; - $srcregs->{$_} = $_[0] if $srcregs->{$_} == $_[0]; - } + + defined $srcregs->{$_} + and + $srcregs->{$_} == $_[0] + and + $srcregs->{$_} = $_[0] + and + last + for keys %$srcregs; } 1; @@ -2529,7 +2383,10 @@ sub DESTROY { $global_phase_destroy = 1; }; - return; + # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage + # collected before leaving this scope. Depending on the code above, this + # may very well be just a preventive measure guarding future modifications + undef; } sub STORABLE_freeze { Storable::nfreeze($_[0]->handle) } @@ -2554,32 +2411,13 @@ sub throw_exception { ; } -=head2 source_info - -Stores a hashref of per-source metadata. No specific key names -have yet been standardized, the examples below are purely hypothetical -and don't actually accomplish anything on their own: - - __PACKAGE__->source_info({ - "_tablespace" => 'fast_disk_array_3', - "_engine" => 'InnoDB', - }); - -=head2 new - - $class->new(); - - $class->new({attribute_name => value}); - -Creates a new ResultSource object. Not normally called directly by end users. - =head2 column_info_from_storage =over =item Arguments: 1/0 (default: 0) -=item Return value: 1/0 +=item Return Value: 1/0 =back @@ -2589,14 +2427,16 @@ Enables the on-demand automatic loading of the above column metadata from storage as necessary. This is *deprecated*, and should not be used. It will be removed before 1.0. +=head1 FURTHER QUESTIONS? -=head1 AUTHORS - -Matt S. Trout +Check the list of L. -=head1 LICENSE +=head1 COPYRIGHT AND LICENSE -You may distribute this code under the same terms as Perl itself. +This module is free software L +by the L. You can +redistribute it and/or modify it under the same terms as the +L. =cut