4 package DBIx
::Class
::ResultSet
::RecursiveUpdate
;
6 our $VERSION = '0.013';
8 use base
qw(DBIx::Class::ResultSet);
10 sub recursive_update
{
11 my ( $self, $updates, $fixed_fields ) = @_;
13 DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
::recursive_update
(
16 fixed_fields
=> $fixed_fields
20 package DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
;
22 use Scalar
::Util
qw( blessed );
23 use List
::MoreUtils qw
/ any /;
25 sub recursive_update
{
27 my ( $self, $updates, $fixed_fields, $object, $resolved,
30 qw
/resultset updates fixed_fields object resolved if_not_submitted/};
33 # warn 'entering: ' . $self->result_source->from();
34 carp
'fixed fields needs to be an array ref'
35 if $fixed_fields && ref($fixed_fields) ne 'ARRAY';
37 %fixed_fields = map { $_ => 1 } @$fixed_fields if $fixed_fields;
38 if ( blessed
($updates) && $updates->isa('DBIx::Class::Row') ) {
41 if ( $updates->{id
} ) {
42 $object = $self->find( $updates->{id
}, { key
=> 'primary' } );
45 grep { !exists $updates->{$_} && !exists $fixed_fields{$_} }
46 $self->result_source->primary_columns;
47 if ( !$object && !scalar @missing ) {
49 # warn 'finding by: ' . Dumper( $updates ); use Data::Dumper;
50 $object = $self->find( $updates, { key
=> 'primary' } );
52 $updates = { %$updates, %$resolved };
54 grep { !exists $resolved->{$_} } @missing;
55 if ( !$object && !scalar @missing ) {
57 # warn 'finding by +resolved: ' . Dumper( $updates ); use Data::Dumper;
58 $object = $self->find( $updates, { key
=> 'primary' } );
60 $object ||= $self->new( {} );
62 # warn Dumper( $updates ); use Data::Dumper;
63 # direct column accessors
66 # relations that that should be done before the row is inserted into the
67 # database like belongs_to
70 # relations that that should be done after the row is inserted into the
71 # database like has_many, might_have and has_one
74 my %columns_by_accessor = _get_columns_by_accessor
($self);
76 # warn 'resolved: ' . Dumper( $resolved );
77 # warn 'updates: ' . Dumper( $updates ); use Data::Dumper;
78 # warn 'columns: ' . Dumper( \%columns_by_accessor );
79 for my $name ( keys %$updates ) {
80 my $source = $self->result_source;
83 if ( exists $columns_by_accessor{$name}
84 && !( $source->has_relationship($name)
85 && ref( $updates->{$name} ) ) )
88 #warn "$name is a column\n";
89 $columns{$name} = $updates->{$name};
94 if ( $source->has_relationship($name) ) {
95 if ( _master_relation_cond
( $self, $name ) ) {
97 #warn "$name is a pre-update rel\n";
98 $pre_updates{$name} = $updates->{$name};
103 #warn "$name is a post-update rel\n";
104 $post_updates{$name} = $updates->{$name};
109 # many-to-many helper accessors
110 if ( is_m2m
( $self, $name ) ) {
112 #warn "$name is a many-to-many helper accessor\n";
113 $other_methods{$name} = $updates->{$name};
118 if ( $object->can($name) && not $source->has_relationship($name) ) {
120 #warn "$name is an accessor";
121 $other_methods{$name} = $updates->{$name};
126 # TODO: don't throw a warning instead of an exception to give users
127 # time to adapt to the new API
128 $self->throw_exception(
129 "No such column, relationship, many-to-many helper accessor or generic accessor '$name'"
133 # warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper;
135 # first update columns and other accessors
136 # so that later related records can be found
137 for my $name ( keys %columns ) {
139 #warn "update col $name\n";
140 $object->$name( $columns{$name} );
142 for my $name ( keys %other_methods ) {
144 #warn "update other $name\n";
145 $object->$name( $updates->{$name} );
147 for my $name ( keys %pre_updates ) {
149 #warn "pre_update $name\n";
150 _update_relation
( $self, $name, $pre_updates{$name}, $object,
154 # $self->_delete_empty_auto_increment($object);
155 # don't allow insert to recurse to related objects
156 # do the recursion ourselves
157 # $object->{_rel_in_storage} = 1;
158 #warn "CHANGED: " . $object->is_changed . "\n":
159 #warn "IN STOR: " . $object->in_storage . "\n";
160 $object->update_or_insert if $object->is_changed;
161 $object->discard_changes;
163 # updating many_to_many
164 for my $name ( keys %$updates ) {
165 next if exists $columns{$name};
166 my $value = $updates->{$name};
168 if ( is_m2m
( $self, $name ) ) {
170 #warn "update m2m $name\n";
171 my ($pk) = _get_pk_for_related
( $self, $name );
173 my $result_source = $object->$name->result_source;
175 if ( !defined $value ) {
178 elsif ( ref $value ) {
179 @updates = @{$value};
184 for my $elem (@updates) {
188 resultset
=> $result_source->resultset,
194 $result_source->resultset->find( { $pk => $elem } );
197 my $set_meth = 'set_' . $name;
198 $object->$set_meth( \
@rows );
201 for my $name ( keys %post_updates ) {
203 #warn "post_update $name\n";
204 _update_relation
( $self, $name, $post_updates{$name}, $object,
210 # returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
211 sub _get_columns_by_accessor
{
213 my $source = $self->result_source;
215 for my $name ( $source->columns ) {
216 my $info = $source->column_info($name);
217 $info->{name
} = $name;
218 $columns{ $info->{accessor
} || $name } = $info;
223 # Arguments: $rs, $name, $updates, $row, $if_not_submitted
224 sub _update_relation
{
225 my ( $self, $name, $updates, $object, $if_not_submitted ) = @_;
227 # this should never happen because we're checking the paramters passed to
228 # recursive_update, but just to be sure...
229 $object->throw_exception("No such relationship '$name'")
230 unless $object->has_relationship($name);
232 #warn "_update_relation $name: OBJ: " . ref($object) . "\n";
234 my $info = $object->result_source->relationship_info($name);
236 # get a related resultset without a condition
237 my $related_resultset =
238 $self->related_resultset($name)->result_source->resultset;
240 if ( $self->result_source->can('_resolve_condition') ) {
242 $self->result_source->_resolve_condition( $info->{cond
}, $name,
246 $self->throw_exception(
247 "result_source must support _resolve_condition");
250 # warn "$name resolved: " . Dumper( $resolved ); use Data::Dumper;
252 if defined $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
253 && $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
256 my @rel_cols = keys %{ $info->{cond
} };
257 map {s/^foreign\.//} @rel_cols;
259 #warn "REL_COLS: " . Dumper(@rel_cols); use Data::Dumper;
260 my $rel_col_cnt = scalar @rel_cols;
262 # find out if all related columns are nullable
263 my $all_fks_nullable = 1;
264 for my $rel_col (@rel_cols) {
265 $all_fks_nullable = 0
266 unless $related_resultset->result_source->column_info($rel_col)
270 #warn "\tNULLABLE: $all_fks_nullable\n";
271 $if_not_submitted = $all_fks_nullable ? 'nullify' : 'delete'
272 unless defined $if_not_submitted;
275 #if (not defined $updates && $if_not_submitted eq 'delete') {
276 # warn "$name " . ref $object;
277 # $object->related_resultset($name)->delete;
281 #warn "RELINFO for $name: " . Dumper($info); use Data::Dumper;
283 # the only valid datatype for a has_many rels is an arrayref
284 if ( $info->{attrs
}{accessor
} eq 'multi' ) {
285 $self->throw_exception(
286 "data for has_many relationship '$name' must be an arrayref")
287 unless ref $updates eq 'ARRAY';
291 #warn "\tupdating has_many rel '$name' ($rel_col_cnt columns cols)\n";
292 for my $sub_updates ( @{$updates} ) {
293 my $sub_object = recursive_update
(
294 resultset
=> $related_resultset,
295 updates
=> $sub_updates,
296 resolved
=> $resolved
299 push @updated_objs, $sub_object;
302 #warn "\tcreated and updated related rows\n";
305 my @related_pks = $related_resultset->result_source->primary_columns;
306 for my $obj (@updated_objs) {
308 for my $col (@related_pks) {
309 $cond_for_obj{$col} = $obj->get_column($col);
311 push @cond, \
%cond_for_obj;
313 my %cond = ( -not => [@cond] );
315 #warn "\tCOND: " . Dumper(\%cond);
316 my $rs_rel_delist = $object->$name->search_rs( \
%cond );
318 #my $rel_delist_cnt = $rs_rel_delist->count;
319 my @foo = $rs_rel_delist->all;
320 if ( $if_not_submitted eq 'delete' ) {
322 #warn "\tdeleting related rows: $rel_delist_cnt\n";
323 $rs_rel_delist->delete;
325 # # only handles related result classes with single primary keys
326 # if ( 1 == $rel_col_cnt ) {
327 # $object->$name->search(
329 # { -not_in => [ map ( $_->id, @updated_objs ) ] }
334 # warn "multi-column relationships aren't supported\n";
337 elsif ( $if_not_submitted eq 'set_to_null' ) {
339 #warn "\tnullifying related rows: $rel_delist_cnt\n";
340 my %update = map { $_ => undef } @rel_cols;
341 $rs_rel_delist->update( \
%update );
343 # # only handles related result classes with single primary keys
344 # if ( 1 == $rel_col_cnt ) {
345 # $object->$name->search(
347 # { -not_in => [ map ( $_->id, @updated_objs ) ] }
349 # )->update( { $rel_cols[0] => undef } );
352 # warn "multi-column relationships aren't supported\n";
356 elsif ($info->{attrs
}{accessor
} eq 'single'
357 || $info->{attrs
}{accessor
} eq 'filter' )
360 #warn "\tupdating rel '$name': $if_not_submitted\n";
362 if ( ref $updates ) {
364 # for might_have relationship
365 if ( $info->{attrs
}{accessor
} eq 'single'
366 && defined $object->$name )
368 $sub_object = recursive_update
(
369 resultset
=> $related_resultset,
371 object
=> $object->$name
375 $sub_object = recursive_update
(
376 resultset
=> $related_resultset,
378 resolved
=> $resolved
383 $sub_object = $related_resultset->find($updates)
386 && ( exists $info->{attrs
}{join_type
}
387 && $info->{attrs
}{join_type
} eq 'LEFT' )
390 $object->set_from_related( $name, $sub_object )
394 && ( exists $info->{attrs
}{join_type
}
395 && $info->{attrs
}{join_type
} eq 'LEFT' )
399 $self->throw_exception(
400 "recursive_update doesn't now how to handle relationship '$name' with accessor "
401 . $info->{attrs
}{accessor
} );
406 my ( $self, $relation ) = @_;
407 my $rclass = $self->result_class;
409 # DBIx::Class::IntrospectableM2M
410 if ( $rclass->can('_m2m_metadata') ) {
411 return $rclass->_m2m_metadata->{$relation};
413 my $object = $self->new( {} );
414 if ( $object->can($relation)
415 and !$self->result_source->has_relationship($relation)
416 and $object->can( 'set_' . $relation ) )
424 my ( $self, $relation ) = @_;
425 my $rclass = $self->result_class;
427 # DBIx::Class::IntrospectableM2M
428 if ( $rclass->can('_m2m_metadata') ) {
429 return $self->result_source->related_source(
430 $rclass->_m2m_metadata->{$relation}{relation
} )
432 $rclass->_m2m_metadata->{$relation}{foreign_relation
} );
434 my $object = $self->new( {} );
435 my $r = $object->$relation;
436 return $r->result_source;
439 sub _delete_empty_auto_increment
{
440 my ( $self, $object ) = @_;
441 for my $col ( keys %{ $object->{_column_data
} } ) {
442 if ($object->result_source->column_info($col)->{is_auto_increment
}
443 and ( !defined $object->{_column_data
}{$col}
444 or $object->{_column_data
}{$col} eq '' )
447 delete $object->{_column_data
}{$col};
452 sub _get_pk_for_related
{
453 my ( $self, $relation ) = @_;
455 if ( $self->result_source->has_relationship($relation) ) {
456 $result_source = $self->result_source->related_source($relation);
460 if ( is_m2m
( $self, $relation ) ) {
461 $result_source = get_m2m_source
( $self, $relation );
463 return $result_source->primary_columns;
466 # This function determines wheter a relationship should be done before or
467 # after the row is inserted into the database
468 # relationships before: belongs_to
469 # relationships after: has_many, might_have and has_one
470 # true means before, false after
471 sub _master_relation_cond
{
472 my ( $self, $name ) = @_;
474 my $source = $self->result_source;
475 my $info = $source->relationship_info($name);
477 #warn "INFO: " . Dumper($info) . "\n";
479 # has_many rels are always after
481 if $info->{attrs
}->{accessor
} eq 'multi';
483 my @foreign_ids = _get_pk_for_related
( $self, $name );
485 #warn "IDS: " . join(', ', @foreign_ids) . "\n";
487 my $cond = $info->{cond
};
490 my ( $source, $cond, @foreign_ids ) = @_;
492 while ( my ( $f_key, $col ) = each %{$cond} ) {
494 # might_have is not master
496 $f_key =~ s/^foreign\.//;
497 if ( $source->column_info($col)->{is_auto_increment
} ) {
500 if ( any
{ $_ eq $f_key } @foreign_ids ) {
507 if ( ref $cond eq 'HASH' ) {
508 return _inner
( $source, $cond, @foreign_ids );
511 # arrayref of hashrefs
512 elsif ( ref $cond eq 'ARRAY' ) {
513 for my $new_cond (@$cond) {
514 return _inner
( $source, $new_cond, @foreign_ids );
518 $source->throw_exception(
519 "unhandled relation condition " . ref($cond) );
524 1; # Magic true value required at end of module
529 DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
533 The functional interface:
535 my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({
536 resultset => $schema->resultset( 'Dvd' ),
541 title => 'One Flew Over the Cuckoo's Nest'
548 As ResultSet subclass:
550 __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
552 in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes.
556 my $user = $user_rs->recursive_update( {
560 title => 'One Flew Over the Cuckoo's Nest'
569 This is still experimental. I've added a functional interface so that it can be used
570 in Form Processors and not require modification of the model.
572 You can feed the ->create method with a recursive datastructure and have the related records
573 created. Unfortunately you cannot do a similar thing with update_or_create - this module
574 tries to fill that void.
576 It is a base class for ResultSets providing just one method: recursive_update
577 which works just like update_or_create but can recursively update or create
578 data objects composed of multiple rows. All rows need to be identified by primary keys
579 - so you need to provide them in the update structure (unless they can be deduced from
580 the parent row - for example when you have a belongs_to relationship).
581 If not all colums comprising the primary key are specified - then a new row will be created,
582 with the expectation that the missing columns will be filled by it (as in the case of auto_increment
586 If the resultset itself stores an assignement for the primary key,
589 my $restricted_rs = $user_rs->search( { id => 1 } );
591 then you need to inform recursive_update about additional predicate with a second argument:
593 my $user = $restricted_rs->recursive_update( {
596 title => 'One Flew Over the Cuckoo's Nest'
603 This will work with a new DBIC release.
605 For a many_to_many (pseudo) relation you can supply a list of primary keys
606 from the other table - and it will link the record at hand to those and
607 only those records identified by them. This is convenient for handling web
608 forms with check boxes (or a SELECT box with multiple choice) that let you
609 update such (pseudo) relations.
611 For a description how to set up base classes for ResultSets see load_namespaces
612 in DBIx::Class::Schema.
614 =head1 DESIGN CHOICES
616 Columns and relationships which are excluded from the updates hashref aren't
619 =head2 Treatment of belongs_to relations
621 In case the relationship is included but undefined in the updates hashref,
622 all columns forming the relationship will be set to null.
623 If not all of them are nullable, DBIx::Class will throw an error.
625 Updating the relationship:
627 my $dvd = $dvd_rs->recursive_update( {
632 Clearing the relationship (only works if cols are nullable!):
634 my $dvd = $dvd_rs->recursive_update( {
639 =head2 Treatment of might_have relationships
641 In case the relationship is included but undefined in the updates hashref,
642 all columns forming the relationship will be set to null.
644 Updating the relationship:
646 my $user = $user_rs->recursive_update( {
649 street => "101 Main Street",
655 Clearing the relationship:
657 my $user = $user_rs->recursive_update( {
662 =head2 Treatment of has_many relations
664 If a relationship key is included in the data structure with a value of undef
665 or an empty array, all existing related rows will be deleted, or their foreign
666 key columns will be set to null.
668 The exact behaviour depends on the nullability of the foreign key columns and
669 the value of the "if_not_submitted" parameter. The parameter defaults to
670 undefined which neither nullifies nor deletes.
672 When the array contains elements they are updated if they exist, created when
673 not and deleted if not included.
675 =head3 All foreign table columns are nullable
677 In this case recursive_update defaults to nullifying the foreign columns.
679 =head3 Not all foreign table columns are nullable
681 In this case recursive_update deletes the foreign rows.
683 Updating the relationship:
687 my $dvd = $dvd_rs->recursive_update( {
694 my $dvd = $dvd_rs->recursive_update( {
712 You can even mix them:
714 my $dvd = $dvd_rs->recursive_update( {
716 tags => [ '2', { id => '3' } ],
719 Clearing the relationship:
721 my $dvd = $dvd_rs->recursive_update( {
726 This is the same as passing an empty array:
728 my $dvd = $dvd_rs->recursive_update( {
733 =head2 Treatment of many-to-many pseudo relations
735 The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
736 If it isn't loaded in the ResultSource classes the code relies on the fact that:
738 if($object->can($name) and
739 !$object->result_source->has_relationship($name) and
740 $object->can( 'set_' . $name )
743 Then $name must be a many to many pseudo relation.
744 And that in a similarly ugly was I find out what is the ResultSource of
745 objects from that many to many pseudo relation.
752 =head2 recursive_update
754 The method that does the work here.
758 $self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many
759 (pseudo) relation on $self.
761 =head2 get_m2m_source
763 $self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many
764 to many (pseudo) relation 'name' from $self.
770 =head1 CONFIGURATION AND ENVIRONMENT
772 DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
778 =head1 INCOMPATIBILITIES
783 =head1 BUGS AND LIMITATIONS
785 No bugs have been reported.
787 Please report any bugs or feature requests to
788 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
789 L<http://rt.cpan.org>.
794 Zbigniew Lukasiak C<< <zby@cpan.org> >>
795 Influenced by code by Pedro Melo.
797 =head1 LICENCE AND COPYRIGHT
799 Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
801 This module is free software; you can redistribute it and/or
802 modify it under the same terms as Perl itself. See L<perlartistic>.
805 =head1 DISCLAIMER OF WARRANTY
807 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
808 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
809 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
810 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
811 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
812 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
813 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
814 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
815 NECESSARY SERVICING, REPAIR, OR CORRECTION.
817 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
818 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
819 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
820 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
821 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
822 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
823 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
824 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
825 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF