1package DBIx::Class::Schema::Loader::RelBuilder; 2 3use strict; 4use warnings; 5use base 'Class::Accessor::Grouped'; 6use mro 'c3'; 7use Carp::Clan qw/^DBIx::Class/; 8use Scalar::Util 'weaken'; 9use DBIx::Class::Schema::Loader::Utils qw/split_name slurp_file array_eq/; 10use Try::Tiny; 11use List::Util 'first'; 12use List::MoreUtils qw/apply uniq any/; 13use namespace::clean; 14use Lingua::EN::Inflect::Phrase (); 15use Lingua::EN::Tagger (); 16use String::ToIdentifier::EN (); 17use String::ToIdentifier::EN::Unicode (); 18use Class::Unload (); 19use Class::Inspector (); 20 21our $VERSION = '0.07033'; 22 23# Glossary: 24# 25# remote_relname -- name of relationship from the local table referring to the remote table 26# local_relname -- name of relationship from the remote table referring to the local table 27# remote_method -- relationship type from remote table to local table, usually has_many 28 29=head1 NAME 30 31DBIx::Class::Schema::Loader::RelBuilder - Builds relationships for DBIx::Class::Schema::Loader 32 33=head1 SYNOPSIS 34 35See L<DBIx::Class::Schema::Loader> and L<DBIx::Class::Schema::Loader::Base>. 36 37=head1 DESCRIPTION 38 39This class builds relationships for L<DBIx::Class::Schema::Loader>. This 40is module is not (yet) for external use. 41 42=head1 METHODS 43 44=head2 new 45 46Arguments: $loader object 47 48=head2 generate_code 49 50Arguments: 51 52 [ 53 [ local_moniker1 (scalar), fk_info1 (arrayref), uniq_info1 (arrayref) ] 54 [ local_moniker2 (scalar), fk_info2 (arrayref), uniq_info2 (arrayref) ] 55 ... 56 ] 57 58This generates the code for the relationships of each table. 59 60C<local_moniker> is the moniker name of the table which had the REFERENCES 61statements. The fk_info arrayref's contents should take the form: 62 63 [ 64 { 65 local_table => 'some_table', 66 local_moniker => 'SomeTable', 67 local_columns => [ 'col2', 'col3' ], 68 remote_table => 'another_table_moniker', 69 remote_moniker => 'AnotherTableMoniker', 70 remote_columns => [ 'col5', 'col7' ], 71 }, 72 { 73 local_table => 'some_other_table', 74 local_moniker => 'SomeOtherTable', 75 local_columns => [ 'col1', 'col4' ], 76 remote_table => 'yet_another_table_moniker', 77 remote_moniker => 'YetAnotherTableMoniker', 78 remote_columns => [ 'col1', 'col2' ], 79 }, 80 # ... 81 ], 82 83The uniq_info arrayref's contents should take the form: 84 85 [ 86 [ 87 uniq_constraint_name => [ 'col1', 'col2' ], 88 ], 89 [ 90 another_uniq_constraint_name => [ 'col1', 'col2' ], 91 ], 92 ], 93 94This method will return the generated relationships as a hashref keyed on the 95class names. The values are arrayrefs of hashes containing method name and 96arguments, like so: 97 98 { 99 'Some::Source::Class' => [ 100 { method => 'belongs_to', arguments => [ 'col1', 'Another::Source::Class' ], 101 { method => 'has_many', arguments => [ 'anothers', 'Yet::Another::Source::Class', 'col15' ], 102 ], 103 'Another::Source::Class' => [ 104 # ... 105 ], 106 # ... 107 } 108 109=cut 110 111__PACKAGE__->mk_group_accessors('simple', qw/ 112 loader 113 schema 114 inflect_plural 115 inflect_singular 116 relationship_attrs 117 rel_collision_map 118 rel_name_map 119 _temp_classes 120 __tagger 121/); 122 123sub new { 124 my ($class, $loader) = @_; 125 126 # from old POD about this constructor: 127 # C<$schema_class> should be a schema class name, where the source 128 # classes have already been set up and registered. Column info, 129 # primary key, and unique constraints will be drawn from this 130 # schema for all of the existing source monikers. 131 132 # Options inflect_plural and inflect_singular are optional, and 133 # are better documented in L<DBIx::Class::Schema::Loader::Base>. 134 135 my $self = { 136 loader => $loader, 137 schema => $loader->schema, 138 inflect_plural => $loader->inflect_plural, 139 inflect_singular => $loader->inflect_singular, 140 relationship_attrs => $loader->relationship_attrs, 141 rel_collision_map => $loader->rel_collision_map, 142 rel_name_map => $loader->rel_name_map, 143 _temp_classes => [], 144 }; 145 146 weaken $self->{loader}; #< don't leak 147 148 bless $self => $class; 149 150 # validate the relationship_attrs arg 151 if( defined $self->relationship_attrs ) { 152 (ref $self->relationship_attrs eq 'HASH' || ref $self->relationship_attrs eq 'CODE') 153 or croak "relationship_attrs must be a hashref or coderef"; 154 } 155 156 return $self; 157} 158 159 160# pluralize a relationship name 161sub _inflect_plural { 162 my ($self, $relname) = @_; 163 164 return '' if !defined $relname || $relname eq ''; 165 166 my $result; 167 my $mapped = 0; 168 169 if( ref $self->inflect_plural eq 'HASH' ) { 170 if (exists $self->inflect_plural->{$relname}) { 171 $result = $self->inflect_plural->{$relname}; 172 $mapped = 1; 173 } 174 } 175 elsif( ref $self->inflect_plural eq 'CODE' ) { 176 my $inflected = $self->inflect_plural->($relname); 177 if ($inflected) { 178 $result = $inflected; 179 $mapped = 1; 180 } 181 } 182 183 return ($result, $mapped) if $mapped; 184 185 return ($self->_to_PL($relname), 0); 186} 187 188# Singularize a relationship name 189sub _inflect_singular { 190 my ($self, $relname) = @_; 191 192 return '' if !defined $relname || $relname eq ''; 193 194 my $result; 195 my $mapped = 0; 196 197 if( ref $self->inflect_singular eq 'HASH' ) { 198 if (exists $self->inflect_singular->{$relname}) { 199 $result = $self->inflect_singular->{$relname}; 200 $mapped = 1; 201 } 202 } 203 elsif( ref $self->inflect_singular eq 'CODE' ) { 204 my $inflected = $self->inflect_singular->($relname); 205 if ($inflected) { 206 $result = $inflected; 207 $mapped = 1; 208 } 209 } 210 211 return ($result, $mapped) if $mapped; 212 213 return ($self->_to_S($relname), 0); 214} 215 216sub _to_PL { 217 my ($self, $name) = @_; 218 219 $name =~ s/_/ /g; 220 my $plural = Lingua::EN::Inflect::Phrase::to_PL($name); 221 $plural =~ s/ /_/g; 222 223 return $plural; 224} 225 226sub _to_S { 227 my ($self, $name) = @_; 228 229 $name =~ s/_/ /g; 230 my $singular = Lingua::EN::Inflect::Phrase::to_S($name); 231 $singular =~ s/ /_/g; 232 233 return $singular; 234} 235 236sub _default_relationship_attrs { +{ 237 has_many => { 238 cascade_delete => 0, 239 cascade_copy => 0, 240 }, 241 might_have => { 242 cascade_delete => 0, 243 cascade_copy => 0, 244 }, 245 belongs_to => { 246 on_delete => 'CASCADE', 247 on_update => 'CASCADE', 248 is_deferrable => 1, 249 }, 250} } 251 252# Accessor for options to be passed to each generated relationship type. takes 253# the relationship type name and optionally any attributes from the database 254# (such as FK ON DELETE/UPDATE and DEFERRABLE clauses), and returns a 255# hashref or undef if nothing is set. 256# 257# The attributes from the database override the default attributes, which in 258# turn are overridden by user supplied attributes. 259sub _relationship_attrs { 260 my ( $self, $reltype, $db_attrs, $params ) = @_; 261 my $r = $self->relationship_attrs; 262 263 my %composite = ( 264 %{ $self->_default_relationship_attrs->{$reltype} || {} }, 265 %{ $db_attrs || {} }, 266 ( 267 ref $r eq 'HASH' ? ( 268 %{ $r->{all} || {} }, 269 %{ $r->{$reltype} || {} }, 270 ) 271 : 272 () 273 ), 274 ); 275 276 if (ref $r eq 'CODE') { 277 $params->{attrs} = \%composite; 278 279 my %ret = %{ $r->(%$params) || {} }; 280 281 %composite = %ret if %ret; 282 } 283 284 return %composite ? \%composite : undef; 285} 286 287sub _strip_id_postfix { 288 my ($self, $name) = @_; 289 290 $name =~ s/_?(?:id|ref|cd|code|num)\z//i; 291 292 return $name; 293} 294 295sub _remote_attrs { 296 my ($self, $local_moniker, $local_cols, $fk_attrs, $params) = @_; 297 298 # get our set of attrs from _relationship_attrs, which uses the FK attrs if available 299 my $attrs = $self->_relationship_attrs('belongs_to', $fk_attrs, $params) || {}; 300 301 # If any referring column is nullable, make 'belongs_to' an 302 # outer join, unless explicitly set by relationship_attrs 303 my $nullable = first { $self->schema->source($local_moniker)->column_info($_)->{is_nullable} } @$local_cols; 304 $attrs->{join_type} = 'LEFT' if $nullable && !defined $attrs->{join_type}; 305 306 return $attrs; 307} 308 309sub _sanitize_name { 310 my ($self, $name) = @_; 311 312 $name = $self->loader->_to_identifier('relationships', $name, '_'); 313 314 $name =~ s/\W+/_/g; # if naming >= 8 to_identifier takes care of it 315 316 return $name; 317} 318 319sub _normalize_name { 320 my ($self, $name) = @_; 321 322 $name = $self->_sanitize_name($name); 323 324 my @words = split_name $name, $self->loader->_get_naming_v('relationships'); 325 326 return join '_', map lc, @words; 327} 328 329sub _remote_relname { 330 my ($self, $remote_table, $cond) = @_; 331 332 my $remote_relname; 333 # for single-column case, set the remote relname to the column 334 # name, to make filter accessors work, but strip trailing _id 335 if(scalar keys %{$cond} == 1) { 336 my ($col) = values %{$cond}; 337 $col = $self->_strip_id_postfix($self->_normalize_name($col)); 338 ($remote_relname) = $self->_inflect_singular($col); 339 } 340 else { 341 ($remote_relname) = $self->_inflect_singular($self->_normalize_name($remote_table)); 342 } 343 344 return $remote_relname; 345} 346 347sub _resolve_relname_collision { 348 my ($self, $moniker, $cols, $relname) = @_; 349 350 return $relname if $relname eq 'id'; # this shouldn't happen, but just in case 351 352 my $table = $self->loader->moniker_to_table->{$moniker}; 353 354 if ($self->loader->_is_result_class_method($relname, $table)) { 355 if (my $map = $self->rel_collision_map) { 356 for my $re (keys %$map) { 357 if (my @matches = $relname =~ /$re/) { 358 return sprintf $map->{$re}, @matches; 359 } 360 } 361 } 362 363 my $new_relname = $relname; 364 while ($self->loader->_is_result_class_method($new_relname, $table)) { 365 $new_relname .= '_rel' 366 } 367 368 warn <<"EOF"; 369Relationship '$relname' in source '$moniker' for columns '@{[ join ',', @$cols ]}' collides with an inherited method. Renaming to '$new_relname'. 370See "RELATIONSHIP NAME COLLISIONS" in perldoc DBIx::Class::Schema::Loader::Base . 371EOF 372 373 return $new_relname; 374 } 375 376 return $relname; 377} 378 379sub generate_code { 380 my ($self, $tables) = @_; 381 382 # make a copy to destroy 383 my @tables = @$tables; 384 385 my $all_code = {}; 386 387 while (my ($local_moniker, $rels, $uniqs) = @{ shift @tables || [] }) { 388 my $local_class = $self->schema->class($local_moniker); 389 390 my %counters; 391 foreach my $rel (@$rels) { 392 next if !$rel->{remote_source}; 393 $counters{$rel->{remote_source}}++; 394 } 395 396 foreach my $rel (@$rels) { 397 my $remote_moniker = $rel->{remote_source} 398 or next; 399 400 my $remote_class = $self->schema->class($remote_moniker); 401 my $remote_obj = $self->schema->source($remote_moniker); 402 my $remote_cols = $rel->{remote_columns} || [ $remote_obj->primary_columns ]; 403 404 my $local_cols = $rel->{local_columns}; 405 406 if($#$local_cols != $#$remote_cols) { 407 croak "Column count mismatch: $local_moniker (@$local_cols) " 408 . "$remote_moniker (@$remote_cols)"; 409 } 410 411 my %cond; 412 foreach my $i (0 .. $#$local_cols) { 413 $cond{$remote_cols->[$i]} = $local_cols->[$i]; 414 } 415 416 my ( $local_relname, $remote_relname, $remote_method ) = 417 $self->_relnames_and_method( $local_moniker, $rel, \%cond, $uniqs, \%counters ); 418 my $local_method = 'belongs_to'; 419 420 ($remote_relname) = $self->_rel_name_map($remote_relname, $local_method, $local_class, $local_moniker, $local_cols, $remote_class, $remote_moniker, $remote_cols); 421 ($local_relname) = $self->_rel_name_map($local_relname, $remote_method, $remote_class, $remote_moniker, $remote_cols, $local_class, $local_moniker, $local_cols); 422 423 $remote_relname = $self->_resolve_relname_collision($local_moniker, $local_cols, $remote_relname); 424 $local_relname = $self->_resolve_relname_collision($remote_moniker, $remote_cols, $local_relname); 425 426 my $rel_attrs_params = { 427 rel_name => $remote_relname, 428 local_source => $self->schema->source($local_moniker), 429 remote_source => $self->schema->source($remote_moniker), 430 local_table => $rel->{local_table}, 431 local_cols => $local_cols, 432 remote_table => $rel->{remote_table}, 433 remote_cols => $remote_cols, 434 }; 435 436 push(@{$all_code->{$local_class}}, 437 { method => $local_method, 438 args => [ $remote_relname, 439 $remote_class, 440 \%cond, 441 $self->_remote_attrs($local_moniker, $local_cols, $rel->{attrs}, $rel_attrs_params), 442 ], 443 extra => { 444 local_class => $local_class, 445 local_moniker => $local_moniker, 446 remote_moniker => $remote_moniker, 447 }, 448 } 449 ); 450 451 my %rev_cond = reverse %cond; 452 for (keys %rev_cond) { 453 $rev_cond{"foreign.$_"} = "self.".$rev_cond{$_}; 454 delete $rev_cond{$_}; 455 } 456 457 $rel_attrs_params = { 458 rel_name => $local_relname, 459 local_source => $self->schema->source($remote_moniker), 460 remote_source => $self->schema->source($local_moniker), 461 local_table => $rel->{remote_table}, 462 local_cols => $remote_cols, 463 remote_table => $rel->{local_table}, 464 remote_cols => $local_cols, 465 }; 466 467 push(@{$all_code->{$remote_class}}, 468 { method => $remote_method, 469 args => [ $local_relname, 470 $local_class, 471 \%rev_cond, 472 $self->_relationship_attrs($remote_method, {}, $rel_attrs_params), 473 ], 474 extra => { 475 local_class => $remote_class, 476 local_moniker => $remote_moniker, 477 remote_moniker => $local_moniker, 478 }, 479 } 480 ); 481 } 482 } 483 484 $self->_generate_m2ms($all_code); 485 486 # disambiguate rels with the same name 487 foreach my $class (keys %$all_code) { 488 my $dups = $self->_duplicates($all_code->{$class}); 489 490 $self->_disambiguate($all_code, $class, $dups) if $dups; 491 } 492 493 $self->_cleanup; 494 495 return $all_code; 496} 497 498# Find classes with only 2 FKs which are the PK and make many_to_many bridges for them. 499sub _generate_m2ms { 500 my ($self, $all_code) = @_; 501 502 while (my ($class, $rels) = each %$all_code) { 503 next unless (grep $_->{method} eq 'belongs_to', @$rels) == 2; 504 505 my $class1_local_moniker = $rels->[0]{extra}{remote_moniker}; 506 my $class1_remote_moniker = $rels->[1]{extra}{remote_moniker}; 507 508 my $class2_local_moniker = $rels->[1]{extra}{remote_moniker}; 509 my $class2_remote_moniker = $rels->[0]{extra}{remote_moniker}; 510 511 my $class1 = $rels->[0]{args}[1]; 512 my $class2 = $rels->[1]{args}[1]; 513 514 my $class1_to_link_table_rel = first { 515 $_->{method} eq 'has_many' && $_->{args}[1] eq $class 516 } @{ $all_code->{$class1} }; 517 518 my $class1_to_link_table_rel_name = $class1_to_link_table_rel->{args}[0]; 519 520 my $class2_to_link_table_rel = first { 521 $_->{method} eq 'has_many' && $_->{args}[1] eq $class 522 } @{ $all_code->{$class2} }; 523 524 my $class2_to_link_table_rel_name = $class2_to_link_table_rel->{args}[0]; 525 526 my $class1_link_rel = $rels->[1]{args}[0]; 527 my $class2_link_rel = $rels->[0]{args}[0]; 528 529 my @class1_from_cols = apply { s/^self\.//i } values %{ 530 $class1_to_link_table_rel->{args}[2] 531 }; 532 533 my @class1_link_cols = apply { s/^self\.//i } values %{ $rels->[1]{args}[2] }; 534 535 my @class1_to_cols = apply { s/^foreign\.//i } keys %{ $rels->[1]{args}[2] }; 536 537 my @class2_from_cols = apply { s/^self\.//i } values %{ 538 $class2_to_link_table_rel->{args}[2] 539 }; 540 541 my @class2_link_cols = apply { s/^self\.//i } values %{ $rels->[0]{args}[2] }; 542 543 my @class2_to_cols = apply { s/^foreign\.//i } keys %{ $rels->[0]{args}[2] }; 544 545 my @link_table_cols = 546 @{[ $self->schema->source($rels->[0]{extra}{local_moniker})->columns ]}; 547 548 my @link_table_primary_cols = 549 @{[ $self->schema->source($rels->[0]{extra}{local_moniker})->primary_columns ]}; 550 551 next unless @class1_link_cols + @class2_link_cols == @link_table_cols 552 && @link_table_cols == @link_table_primary_cols; 553 554 my ($class1_to_class2_relname) = $self->_rel_name_map( 555 ($self->_inflect_plural($class1_link_rel))[0], 556 'many_to_many', 557 $class1, 558 $class1_local_moniker, 559 \@class1_from_cols, 560 $class2, 561 $class1_remote_moniker, 562 \@class1_to_cols, 563 ); 564 565 $class1_to_class2_relname = $self->_resolve_relname_collision( 566 $class1_local_moniker, 567 \@class1_from_cols, 568 $class1_to_class2_relname, 569 ); 570 571 my ($class2_to_class1_relname) = $self->_rel_name_map( 572 ($self->_inflect_plural($class2_link_rel))[0], 573 'many_to_many', 574 $class1, 575 $class2_local_moniker, 576 \@class2_from_cols, 577 $class2, 578 $class2_remote_moniker, 579 \@class2_to_cols, 580 ); 581 582 $class2_to_class1_relname = $self->_resolve_relname_collision( 583 $class2_local_moniker, 584 \@class2_from_cols, 585 $class2_to_class1_relname, 586 ); 587 588 push @{$all_code->{$class1}}, { 589 method => 'many_to_many', 590 args => [ 591 $class1_to_class2_relname, 592 $class1_to_link_table_rel_name, 593 $class1_link_rel, 594 ], 595 extra => { 596 local_class => $class1, 597 link_class => $class, 598 local_moniker => $class1_local_moniker, 599 remote_moniker => $class1_remote_moniker, 600 }, 601 }; 602 603 push @{$all_code->{$class2}}, { 604 method => 'many_to_many', 605 args => [ 606 $class2_to_class1_relname, 607 $class2_to_link_table_rel_name, 608 $class2_link_rel, 609 ], 610 extra => { 611 local_class => $class2, 612 link_class => $class, 613 local_moniker => $class2_local_moniker, 614 remote_moniker => $class2_remote_moniker, 615 }, 616 }; 617 } 618} 619 620sub _duplicates { 621 my ($self, $rels) = @_; 622 623 my @rels = map [ $_->{args}[0] => $_ ], @$rels; 624 my %rel_names; 625 $rel_names{$_}++ foreach map $_->[0], @rels; 626 627 my @dups = grep $rel_names{$_} > 1, keys %rel_names; 628 629 my %dups; 630 631 foreach my $dup (@dups) { 632 $dups{$dup} = [ map $_->[1], grep { $_->[0] eq $dup } @rels ]; 633 } 634 635 return if not %dups; 636 637 return \%dups; 638} 639 640sub _tagger { 641 my $self = shift; 642 643 $self->__tagger(Lingua::EN::Tagger->new) unless $self->__tagger; 644 645 return $self->__tagger; 646} 647 648sub _adjectives { 649 my ($self, @cols) = @_; 650 651 my @adjectives; 652 653 foreach my $col (@cols) { 654 my @words = split_name $col; 655 656 my $tagged = $self->_tagger->get_readable(join ' ', @words); 657 658 push @adjectives, $tagged =~ m{\G(\w+)/JJ\s+}g; 659 } 660 661 return @adjectives; 662} 663 664sub _name_to_identifier { 665 my ($self, $name) = @_; 666 667 my $to_identifier = $self->loader->naming->{force_ascii} ? 668 \&String::ToIdentifier::EN::to_identifier 669 : \&String::ToIdentifier::EN::Unicode::to_identifier; 670 671 return join '_', map lc, split_name $to_identifier->($name, '_'); 672} 673 674sub _disambiguate { 675 my ($self, $all_code, $in_class, $dups) = @_; 676 677 DUP: foreach my $dup (keys %$dups) { 678 my @rels = @{ $dups->{$dup} }; 679 680 # Check if there are rels to the same table name in different 681 # schemas/databases, if so qualify them. 682 my @tables = map $self->loader->moniker_to_table->{$_->{extra}{remote_moniker}}, 683 @rels; 684 685 # databases are different, prepend database 686 if ($tables[0]->can('database') && (uniq map $_->database||'', @tables) > 1) { 687 # If any rels are in the same database, we have to distinguish by 688 # both schema and database. 689 my %db_counts; 690 $db_counts{$_}++ for map $_->database, @tables; 691 my $use_schema = any { $_ > 1 } values %db_counts; 692 693 foreach my $i (0..$#rels) { 694 my $rel = $rels[$i]; 695 my $table = $tables[$i]; 696 697 $rel->{args}[0] = $self->_name_to_identifier($table->database) 698 . ($use_schema ? ('_' . $self->name_to_identifier($table->schema)) : '') 699 . '_' . $rel->{args}[0]; 700 } 701 next DUP; 702 } 703 # schemas are different, prepend schema 704 elsif ((uniq map $_->schema||'', @tables) > 1) { 705 foreach my $i (0..$#rels) { 706 my $rel = $rels[$i]; 707 my $table = $tables[$i]; 708 709 $rel->{args}[0] = $self->_name_to_identifier($table->schema) 710 . '_' . $rel->{args}[0]; 711 } 712 next DUP; 713 } 714 715 foreach my $rel (@rels) { 716 next if $rel->{method} =~ /^(?:belongs_to|many_to_many)\z/; 717 718 my @to_cols = apply { s/^foreign\.//i } 719 keys %{ $rel->{args}[2] }; 720 721 my @adjectives = $self->_adjectives(@to_cols); 722 723 # If there are no adjectives, and there is only one might_have 724 # rel to that class, we hardcode 'active'. 725 726 my $to_class = $rel->{args}[1]; 727 728 if ((not @adjectives) 729 && (grep { $_->{method} eq 'might_have' 730 && $_->{args}[1] eq $to_class } @{ $all_code->{$in_class} }) == 1) { 731 732 @adjectives = 'active'; 733 } 734 735 if (@adjectives) { 736 my $rel_name = join '_', sort(@adjectives), $rel->{args}[0]; 737 738 ($rel_name) = $rel->{method} eq 'might_have' ? 739 $self->_inflect_singular($rel_name) 740 : 741 $self->_inflect_plural($rel_name); 742 743 my ($local_class, $local_moniker, $remote_moniker) 744 = @{ $rel->{extra} } 745 {qw/local_class local_moniker remote_moniker/}; 746 747 my @from_cols = apply { s/^self\.//i } 748 values %{ $rel->{args}[2] }; 749 750 ($rel_name) = $self->_rel_name_map($rel_name, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols); 751 752 $rel_name = $self->_resolve_relname_collision($local_moniker, \@from_cols, $rel_name); 753 754 $rel->{args}[0] = $rel_name; 755 } 756 } 757 } 758 759 # Check again for duplicates, since the heuristics above may not have resolved them all. 760 761 if ($dups = $self->_duplicates($all_code->{$in_class})) { 762 foreach my $dup (keys %$dups) { 763 # sort by method 764 my @rels = map $_->[1], sort { $a->[0] <=> $b->[0] } map [ 765 { 766 belongs_to => 3, 767 has_many => 2, 768 might_have => 1, 769 many_to_many => 0, 770 }->{$_->{method}}, $_ 771 ], @{ $dups->{$dup} }; 772 773 my $rel_num = 2; 774 775 foreach my $rel (@rels[1 .. $#rels]) { 776 my $inflect_type = $rel->{method} =~ /^(?:many_to_many|has_many)\z/ ? 777 'inflect_plural' 778 : 779 'inflect_singular'; 780 781 my $inflect_method = "_$inflect_type"; 782 783 my $relname_new_uninflected = $rel->{args}[0] . "_$rel_num"; 784 785 $rel_num++; 786 787 my ($local_class, $local_moniker, $remote_moniker) 788 = @{ $rel->{extra} } 789 {qw/local_class local_moniker remote_moniker/}; 790 791 my (@from_cols, @to_cols, $to_class); 792 793 if ($rel->{method} eq 'many_to_many') { 794 @from_cols = apply { s/^self\.//i } values %{ 795 (first { $_->{args}[0] eq $rel->{args}[1] } @{ $all_code->{$local_class} }) 796 ->{args}[2] 797 }; 798 @to_cols = apply { s/^foreign\.//i } keys %{ 799 (first { $_->{args}[0] eq $rel->{args}[2] } 800 @{ $all_code->{ $rel->{extra}{link_class} } }) 801 ->{args}[2] 802 }; 803 $to_class = $self->schema->source($remote_moniker)->result_class; 804 } 805 else { 806 @from_cols = apply { s/^self\.//i } values %{ $rel->{args}[2] }; 807 @to_cols = apply { s/^foreign\.//i } keys %{ $rel->{args}[2] }; 808 $to_class = $rel->{args}[1]; 809 } 810 811 my ($relname_new, $inflect_mapped) = 812 $self->$inflect_method($relname_new_uninflected); 813 814 my $rel_name_mapped; 815 816 ($relname_new, $rel_name_mapped) = $self->_rel_name_map($relname_new, $rel->{method}, $local_class, $local_moniker, \@from_cols, $to_class, $remote_moniker, \@to_cols); 817 818 my $mapped = $inflect_mapped || $rel_name_mapped; 819 820 warn <<"EOF" unless $mapped; 821Could not find a proper name for relationship '$relname_new' in source 822'$local_moniker' for columns '@{[ join ',', @from_cols ]}'. Supply a value in 823'$inflect_type' for '$relname_new_uninflected' or 'rel_name_map' for 824'$relname_new' to name this relationship. 825EOF 826 827 $relname_new = $self->_resolve_relname_collision($local_moniker, \@from_cols, $relname_new); 828 829 $rel->{args}[0] = $relname_new; 830 } 831 } 832 } 833} 834 835sub _relnames_and_method { 836 my ( $self, $local_moniker, $rel, $cond, $uniqs, $counters ) = @_; 837 838 my $remote_moniker = $rel->{remote_source}; 839 my $remote_obj = $self->schema->source( $remote_moniker ); 840 my $remote_class = $self->schema->class( $remote_moniker ); 841 my $remote_relname = $self->_remote_relname( $rel->{remote_table}, $cond); 842 843 my $local_cols = $rel->{local_columns}; 844 my $local_table = $rel->{local_table}; 845 my $local_class = $self->schema->class($local_moniker); 846 my $local_source = $self->schema->source($local_moniker); 847 848 my $local_relname_uninflected = $self->_normalize_name($local_table); 849 my ($local_relname) = $self->_inflect_plural($self->_normalize_name($local_table)); 850 851 my $remote_method = 'has_many'; 852 853 # If the local columns have a UNIQUE constraint, this is a one-to-one rel 854 if (array_eq([ $local_source->primary_columns ], $local_cols) || 855 first { array_eq($_->[1], $local_cols) } @$uniqs) { 856 $remote_method = 'might_have'; 857 ($local_relname) = $self->_inflect_singular($local_relname_uninflected); 858 } 859 860 # If more than one rel between this pair of tables, use the local 861 # col names to distinguish, unless the rel was created previously. 862 if ($counters->{$remote_moniker} > 1) { 863 my $relationship_exists = 0; 864 865 if (-f (my $existing_remote_file = $self->loader->get_dump_filename($remote_class))) { 866 my $class = "${remote_class}Temporary"; 867 868 if (not Class::Inspector->loaded($class)) { 869 my $code = slurp_file $existing_remote_file; 870 871 $code =~ s/(?<=package $remote_class)/Temporary/g; 872 873 $code =~ s/__PACKAGE__->meta->make_immutable[^;]*;//g; 874 875 eval $code; 876 die $@ if $@; 877 878 push @{ $self->_temp_classes }, $class; 879 } 880 881 if ($class->has_relationship($local_relname)) { 882 my $rel_cols = [ sort { $a cmp $b } apply { s/^foreign\.//i } 883 (keys %{ $class->relationship_info($local_relname)->{cond} }) ]; 884 885 $relationship_exists = 1 if array_eq([ sort @$local_cols ], $rel_cols); 886 } 887 } 888 889 if (not $relationship_exists) { 890 my $colnames = q{_} . $self->_normalize_name(join '_', @$local_cols); 891 $remote_relname .= $colnames if keys %$cond > 1; 892 893 $local_relname = $self->_strip_id_postfix($self->_normalize_name($local_table . $colnames)); 894 895 $local_relname_uninflected = $local_relname; 896 ($local_relname) = $self->_inflect_plural($local_relname); 897 898 # if colnames were added and this is a might_have, re-inflect 899 if ($remote_method eq 'might_have') { 900 ($local_relname) = $self->_inflect_singular($local_relname_uninflected); 901 } 902 } 903 } 904 905 return ($local_relname, $remote_relname, $remote_method); 906} 907 908sub _rel_name_map { 909 my ($self, $relname, $method, $local_class, $local_moniker, $local_cols, 910 $remote_class, $remote_moniker, $remote_cols) = @_; 911 912 my $info = { 913 name => $relname, 914 type => $method, 915 local_class => $local_class, 916 local_moniker => $local_moniker, 917 local_columns => $local_cols, 918 remote_class => $remote_class, 919 remote_moniker => $remote_moniker, 920 remote_columns => $remote_cols, 921 }; 922 923 my $new_name = $relname; 924 925 my $map = $self->rel_name_map; 926 my $mapped = 0; 927 928 if ('HASH' eq ref($map)) { 929 my $name = $info->{name}; 930 my $moniker = $info->{local_moniker}; 931 if ($map->{$moniker} and 'HASH' eq ref($map->{$moniker}) 932 and $map->{$moniker}{$name} 933 ) { 934 $new_name = $map->{$moniker}{$name}; 935 $mapped = 1; 936 } 937 elsif ($map->{$name} and not 'HASH' eq ref($map->{$name})) { 938 $new_name = $map->{$name}; 939 $mapped = 1; 940 } 941 } 942 elsif ('CODE' eq ref($map)) { 943 my $name = $map->($info); 944 if ($name) { 945 $new_name = $name; 946 $mapped = 1; 947 } 948 } 949 950 return ($new_name, $mapped); 951} 952 953sub _cleanup { 954 my $self = shift; 955 956 for my $class (@{ $self->_temp_classes }) { 957 Class::Unload->unload($class); 958 } 959 960 $self->_temp_classes([]); 961} 962 963=head1 AUTHOR 964 965See L<DBIx::Class::Schema::Loader/AUTHOR> and L<DBIx::Class::Schema::Loader/CONTRIBUTORS>. 966 967=head1 LICENSE 968 969This library is free software; you can redistribute it and/or modify it under 970the same terms as Perl itself. 971 972=cut 973 9741; 975# vim:et sts=4 sw=4 tw=0: 976