1 package DBIx::Class::Schema::Loader::Base;
5 use base qw/Class::Accessor::Fast/;
7 use Carp::Clan qw/^DBIx::Class/;
8 use UNIVERSAL::require;
9 use DBIx::Class::Schema::Loader::RelBuilder;
10 use Data::Dump qw/ dump /;
15 use Lingua::EN::Inflect::Number qw//;
20 our $VERSION = '0.04999_05';
22 __PACKAGE__->mk_ro_accessors(qw/
29 additional_base_classes
44 default_resultset_class
54 DBIx::Class::Schema::Loader::Base - Base DBIx::Class::Schema::Loader Implementation.
58 See L<DBIx::Class::Schema::Loader>
62 This is the base class for the storage-specific C<DBIx::Class::Schema::*>
63 classes, and implements the common functionality between them.
65 =head1 CONSTRUCTOR OPTIONS
67 These constructor options are the base options for
68 L<DBIx::Class::Schema::Loader/loader_options>. Available constructor options are:
70 =head2 skip_relationships
72 Skip setting up relationships. The default is to attempt the loading
77 If set to true, each constructive L<DBIx::Class> statement the loader
78 decides to execute will be C<warn>-ed before execution.
82 Set the name of the schema to load (schema in the sense that your database
83 vendor means it). Does not currently support loading more than one schema
88 Only load tables matching regex. Best specified as a qr// regex.
92 Exclude tables matching regex. Best specified as a qr// regex.
96 Overrides the default table name to moniker translation. Can be either
97 a hashref of table keys and moniker values, or a coderef for a translator
98 function taking a single scalar table name argument and returning
99 a scalar moniker. If the hash entry does not exist, or the function
100 returns a false value, the code falls back to default behavior
103 The default behavior is: C<join '', map ucfirst, split /[\W_]+/, lc $table>,
104 which is to say: lowercase everything, split up the table name into chunks
105 anywhere a non-alpha-numeric character occurs, change the case of first letter
106 of each chunk to upper case, and put the chunks back together. Examples:
108 Table Name | Moniker Name
109 ---------------------------
111 luser_group | LuserGroup
112 luser-opts | LuserOpts
114 =head2 inflect_plural
116 Just like L</moniker_map> above (can be hash/code-ref, falls back to default
117 if hash key does not exist or coderef returns false), but acts as a map
118 for pluralizing relationship names. The default behavior is to utilize
119 L<Lingua::EN::Inflect::Number/to_PL>.
121 =head2 inflect_singular
123 As L</inflect_plural> above, but for singularizing relationship names.
124 Default behavior is to utilize L<Lingua::EN::Inflect::Number/to_S>.
126 =head2 additional_base_classes
128 List of additional base classes all of your table classes will use.
130 =head2 left_base_classes
132 List of additional base classes all of your table classes will use
133 that need to be leftmost.
135 =head2 additional_classes
137 List of additional classes which all of your table classes will use.
141 List of additional components to be loaded into all of your table
142 classes. A good example would be C<ResultSetManager>.
144 =head2 resultset_components
146 List of additional ResultSet components to be loaded into your table
147 classes. A good example would be C<AlwaysRS>. Component
148 C<ResultSetManager> will be automatically added to the above
149 C<components> list if this option is set.
151 =head2 use_namespaces
153 Generate result class names suitable for
154 L<DBIx::Class::Schema/load_namespaces> and call that instead of
155 L<DBIx::Class::Schema/load_classes>. When using this option you can also
156 specify any of the options for C<load_namespaces> (i.e. C<result_namespace>,
157 C<resultset_namespace>, C<default_resultset_class>), and they will be added
158 to the call (and the generated result class names adjusted appropriately).
160 =head2 dump_directory
162 This option is designed to be a tool to help you transition from this
163 loader to a manually-defined schema when you decide it's time to do so.
165 The value of this option is a perl libdir pathname. Within
166 that directory this module will create a baseline manual
167 L<DBIx::Class::Schema> module set, based on what it creates at runtime
170 The created schema class will have the same classname as the one on
171 which you are setting this option (and the ResultSource classes will be
172 based on this name as well).
174 Normally you wouldn't hard-code this setting in your schema class, as it
175 is meant for one-time manual usage.
177 See L<DBIx::Class::Schema::Loader/dump_to_dir> for examples of the
178 recommended way to access this functionality.
180 =head2 dump_overwrite
182 Deprecated. See L</really_erase_my_files> below, which does *not* mean
183 the same thing as the old C<dump_overwrite> setting from previous releases.
185 =head2 really_erase_my_files
187 Default false. If true, Loader will unconditionally delete any existing
188 files before creating the new ones from scratch when dumping a schema to disk.
190 The default behavior is instead to only replace the top portion of the
191 file, up to and including the final stanza which contains
192 C<# DO NOT MODIFY THIS OR ANYTHING ABOVE!>
193 leaving any customizations you placed after that as they were.
195 When C<really_erase_my_files> is not set, if the output file already exists,
196 but the aforementioned final stanza is not found, or the checksum
197 contained there does not match the generated contents, Loader will
198 croak and not touch the file.
200 You should really be using version control on your schema classes (and all
201 of the rest of your code for that matter). Don't blame me if a bug in this
202 code wipes something out when it shouldn't have, you've been warned.
206 None of these methods are intended for direct invocation by regular
207 users of L<DBIx::Class::Schema::Loader>. Anything you can find here
208 can also be found via standard L<DBIx::Class::Schema> methods somehow.
212 # ensure that a peice of object data is a valid arrayref, creating
213 # an empty one or encapsulating whatever's there.
214 sub _ensure_arrayref {
219 $self->{$_} = [ $self->{$_} ]
220 unless ref $self->{$_} eq 'ARRAY';
226 Constructor for L<DBIx::Class::Schema::Loader::Base>, used internally
227 by L<DBIx::Class::Schema::Loader>.
232 my ( $class, %args ) = @_;
234 my $self = { %args };
236 bless $self => $class;
238 $self->_ensure_arrayref(qw/additional_classes
239 additional_base_classes
245 push(@{$self->{components}}, 'ResultSetManager')
246 if @{$self->{resultset_components}};
248 $self->{monikers} = {};
249 $self->{classes} = {};
251 $self->{schema_class} ||= ( ref $self->{schema} || $self->{schema} );
252 $self->{schema} ||= $self->{schema_class};
254 croak "dump_overwrite is deprecated. Please read the"
255 . " DBIx::Class::Schema::Loader::Base documentation"
256 if $self->{dump_overwrite};
258 $self->{dynamic} = ! $self->{dump_directory};
259 $self->{dump_directory} ||= File::Temp::tempdir( 'dbicXXXX',
264 $self->{relbuilder} = DBIx::Class::Schema::Loader::RelBuilder->new(
265 $self->schema_class, $self->inflect_plural, $self->inflect_singular
266 ) if !$self->{skip_relationships};
271 sub _find_file_in_inc {
272 my ($self, $file) = @_;
274 foreach my $prefix (@INC) {
275 my $fullpath = File::Spec->catfile($prefix, $file);
276 return $fullpath if -f $fullpath
277 and Cwd::abs_path($fullpath) ne
278 Cwd::abs_path(File::Spec->catfile($self->dump_directory, $file)) || '';
285 my ($self, $class) = @_;
287 my $class_path = $class;
288 $class_path =~ s{::}{/}g;
289 $class_path .= '.pm';
291 my $real_inc_path = $self->_find_file_in_inc($class_path);
293 return if !$real_inc_path;
295 # If we make it to here, we loaded an external definition
296 warn qq/# Loaded external class definition for '$class'\n/
299 croak 'Failed to locate actual external module file for '
302 open(my $fh, '<', $real_inc_path)
303 or croak "Failed to open '$real_inc_path' for reading: $!";
304 $self->_ext_stmt($class,
305 qq|# These lines were loaded from '$real_inc_path' found in \@INC.\n|
306 .qq|# They are now part of the custom portion of this file\n|
307 .qq|# for you to hand-edit. If you do not either delete\n|
308 .qq|# this section or remove that file from \@INC, this section\n|
309 .qq|# will be repeated redundantly when you re-create this\n|
310 .qq|# file again via Loader!\n|
314 $self->_ext_stmt($class, $_);
316 $self->_ext_stmt($class,
317 qq|# End of lines loaded from '$real_inc_path' |
320 or croak "Failed to close $real_inc_path: $!";
325 Does the actual schema-construction work.
332 $self->_load_tables($self->_tables_list);
339 Rescan the database for newly added tables. Does
340 not process drops or changes. Returns a list of
341 the newly added table monikers.
343 The schema argument should be the schema class
344 or object to be affected. It should probably
345 be derived from the original schema_class used
351 my ($self, $schema) = @_;
353 $self->{schema} = $schema;
356 my @current = $self->_tables_list;
357 foreach my $table ($self->_tables_list) {
358 if(!exists $self->{_tables}->{$table}) {
359 push(@created, $table);
363 my $loaded = $self->_load_tables(@created);
365 return map { $self->monikers->{$_} } @$loaded;
369 my ($self, @tables) = @_;
371 # First, use _tables_list with constraint and exclude
372 # to get a list of tables to operate on
374 my $constraint = $self->constraint;
375 my $exclude = $self->exclude;
377 @tables = grep { /$constraint/ } @tables if $constraint;
378 @tables = grep { ! /$exclude/ } @tables if $exclude;
380 # Save the new tables to the tables list
382 $self->{_tables}->{$_} = 1;
385 $self->_make_src_class($_) for @tables;
386 $self->_setup_src_meta($_) for @tables;
388 if(!$self->skip_relationships) {
389 # The relationship loader needs a working schema
391 $self->_reload_classes(@tables);
392 $self->_load_relationships($_) for @tables;
396 $self->_load_external($_)
397 for map { $self->classes->{$_} } @tables;
399 $self->_reload_classes(@tables);
401 # Drop temporary cache
402 delete $self->{_cache};
407 sub _reload_classes {
408 my ($self, @tables) = @_;
410 $self->_dump_to_dir(map { $self->classes->{$_} } @tables);
412 for my $table (@tables) {
413 my $moniker = $self->monikers->{$table};
414 my $class = $self->classes->{$table};
416 if ( Class::Unload->unload( $class ) ) {
417 my $resultset_class = ref $self->schema->resultset($moniker);
418 Class::Unload->unload( $resultset_class )
419 if $resultset_class ne 'DBIx::Class::ResultSet';
421 $class->require or die "Can't load $class: $@";
423 $self->schema_class->register_class($moniker, $class);
424 $self->schema->register_class($moniker, $class)
425 if $self->schema ne $self->schema_class;
429 sub _get_dump_filename {
430 my ($self, $class) = (@_);
433 return $self->dump_directory . q{/} . $class . q{.pm};
436 sub _ensure_dump_subdirs {
437 my ($self, $class) = (@_);
439 my @name_parts = split(/::/, $class);
440 pop @name_parts; # we don't care about the very last element,
441 # which is a filename
443 my $dir = $self->dump_directory;
446 mkdir($dir) or croak "mkdir('$dir') failed: $!";
448 last if !@name_parts;
449 $dir = File::Spec->catdir($dir, shift @name_parts);
454 my ($self, @classes) = @_;
456 my $target_dir = $self->dump_directory;
458 my $schema_class = $self->schema_class;
460 warn "Dumping manual schema for $schema_class to directory $target_dir ...\n"
461 unless $self->{dynamic} or $self->{quiet};
464 qq|package $schema_class;\n\n|
465 . qq|use strict;\nuse warnings;\n\n|
466 . qq|use base 'DBIx::Class::Schema';\n\n|;
469 if ($self->use_namespaces) {
470 $schema_text .= qq|__PACKAGE__->load_namespaces|;
471 my $namespace_options;
472 for my $attr (qw(result_namespace
474 default_resultset_class)) {
476 $namespace_options .= qq| $attr => '| . $self->$attr . qq|',\n|
479 $schema_text .= qq|(\n$namespace_options)| if $namespace_options;
480 $schema_text .= qq|;\n|;
483 $schema_text .= qq|__PACKAGE__->load_classes;\n|;
487 $self->_write_classfile($schema_class, $schema_text);
489 foreach my $src_class (@classes) {
491 qq|package $src_class;\n\n|
492 . qq|use strict;\nuse warnings;\n\n|
493 . qq|use base 'DBIx::Class';\n\n|;
495 $self->_write_classfile($src_class, $src_text);
498 warn "Schema dump completed.\n" unless $self->{dynamic} or $self->{quiet};
500 unshift @INC, $target_dir;
503 sub _write_classfile {
504 my ($self, $class, $text) = @_;
506 my $filename = $self->_get_dump_filename($class);
507 $self->_ensure_dump_subdirs($class);
509 if (-f $filename && $self->really_erase_my_files) {
510 warn "Deleting existing file '$filename' due to "
511 . "'really_erase_my_files' setting\n" unless $self->{quiet};
515 my $custom_content = $self->_get_custom_content($class, $filename);
517 $custom_content ||= qq|\n\n# You can replace this text with custom|
518 . qq| content, and it will be preserved on regeneration|
522 for @{$self->{_dump_storage}->{$class} || []};
524 $text .= qq|\n\n# Created by DBIx::Class::Schema::Loader|
525 . qq| v| . $DBIx::Class::Schema::Loader::VERSION
526 . q| @ | . POSIX::strftime('%Y-%m-%d %H:%M:%S', localtime)
527 . qq|\n# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:|;
529 open(my $fh, '>', $filename)
530 or croak "Cannot open '$filename' for writing: $!";
532 # Write the top half and its MD5 sum
533 print $fh $text . Digest::MD5::md5_base64($text) . "\n";
535 # Write out anything loaded via external partial class file in @INC
537 for @{$self->{_ext_storage}->{$class} || []};
539 print $fh $custom_content;
542 or croak "Cannot close '$filename': $!";
545 sub _get_custom_content {
546 my ($self, $class, $filename) = @_;
548 return if ! -f $filename;
549 open(my $fh, '<', $filename)
550 or croak "Cannot open '$filename' for reading: $!";
553 qr{^(# DO NOT MODIFY THIS OR ANYTHING ABOVE! md5sum:)([A-Za-z0-9/+]{22})\n};
558 if(!$found && /$mark_re/) {
561 croak "Checksum mismatch in '$filename'"
562 if Digest::MD5::md5_base64($buffer) ne $2;
571 croak "Cannot not overwrite '$filename' without 'really_erase_my_files',"
572 . " it does not appear to have been generated by Loader"
583 warn "$target: use $_;" if $self->debug;
584 $self->_raw_stmt($target, "use $_;");
591 my $schema_class = $self->schema_class;
593 my $blist = join(q{ }, @_);
594 warn "$target: use base qw/ $blist /;" if $self->debug && @_;
595 $self->_raw_stmt($target, "use base qw/ $blist /;") if @_;
598 # Create class with applicable bases, setup monikers, etc
599 sub _make_src_class {
600 my ($self, $table) = @_;
602 my $schema = $self->schema;
603 my $schema_class = $self->schema_class;
605 my $table_moniker = $self->_table2moniker($table);
606 my @result_namespace = ($schema_class);
607 if ($self->use_namespaces) {
608 my $result_namespace = $self->result_namespace || 'Result';
609 if ($result_namespace =~ /^\+(.*)/) {
610 # Fully qualified namespace
611 @result_namespace = ($1)
615 push @result_namespace, $result_namespace;
618 my $table_class = join(q{::}, @result_namespace, $table_moniker);
620 my $table_normalized = lc $table;
621 $self->classes->{$table} = $table_class;
622 $self->classes->{$table_normalized} = $table_class;
623 $self->monikers->{$table} = $table_moniker;
624 $self->monikers->{$table_normalized} = $table_moniker;
626 $self->_use ($table_class, @{$self->additional_classes});
627 $self->_inject($table_class, @{$self->left_base_classes});
629 $self->_dbic_stmt($table_class, 'load_components', @{$self->components}, 'Core');
631 $self->_dbic_stmt($table_class, 'load_resultset_components', @{$self->resultset_components})
632 if @{$self->resultset_components};
633 $self->_inject($table_class, @{$self->additional_base_classes});
636 # Set up metadata (cols, pks, etc)
637 sub _setup_src_meta {
638 my ($self, $table) = @_;
640 my $schema = $self->schema;
641 my $schema_class = $self->schema_class;
643 my $table_class = $self->classes->{$table};
644 my $table_moniker = $self->monikers->{$table};
646 $self->_dbic_stmt($table_class,'table',$table);
648 my $cols = $self->_table_columns($table);
650 eval { $col_info = $self->_columns_info_for($table) };
652 $self->_dbic_stmt($table_class,'add_columns',@$cols);
655 my %col_info_lc = map { lc($_), $col_info->{$_} } keys %$col_info;
656 my $fks = $self->_table_fk_info($table);
657 for my $fkdef (@$fks) {
658 for my $col (@{ $fkdef->{local_columns} }) {
659 $col_info_lc{$col}->{is_foreign_key} = 1;
665 map { $_, ($col_info_lc{$_}||{}) } @$cols
669 my $pks = $self->_table_pk_info($table) || [];
670 @$pks ? $self->_dbic_stmt($table_class,'set_primary_key',@$pks)
671 : carp("$table has no primary key");
673 my $uniqs = $self->_table_uniq_info($table) || [];
674 $self->_dbic_stmt($table_class,'add_unique_constraint',@$_) for (@$uniqs);
679 Returns a sorted list of loaded tables, using the original database table
687 return keys %{$self->_tables};
690 # Make a moniker from a table
692 my ( $self, $table ) = @_;
696 if( ref $self->moniker_map eq 'HASH' ) {
697 $moniker = $self->moniker_map->{$table};
699 elsif( ref $self->moniker_map eq 'CODE' ) {
700 $moniker = $self->moniker_map->($table);
703 $moniker ||= join '', map ucfirst, split /[\W_]+/,
704 Lingua::EN::Inflect::Number::to_S(lc $table);
709 sub _load_relationships {
710 my ($self, $table) = @_;
712 my $tbl_fk_info = $self->_table_fk_info($table);
713 foreach my $fkdef (@$tbl_fk_info) {
714 $fkdef->{remote_source} =
715 $self->monikers->{delete $fkdef->{remote_table}};
717 my $tbl_uniq_info = $self->_table_uniq_info($table);
719 my $local_moniker = $self->monikers->{$table};
720 my $rel_stmts = $self->{relbuilder}->generate_code($local_moniker, $tbl_fk_info, $tbl_uniq_info);
722 foreach my $src_class (sort keys %$rel_stmts) {
723 my $src_stmts = $rel_stmts->{$src_class};
724 foreach my $stmt (@$src_stmts) {
725 $self->_dbic_stmt($src_class,$stmt->{method},@{$stmt->{args}});
730 # Overload these in driver class:
732 # Returns an arrayref of column names
733 sub _table_columns { croak "ABSTRACT METHOD" }
735 # Returns arrayref of pk col names
736 sub _table_pk_info { croak "ABSTRACT METHOD" }
738 # Returns an arrayref of uniqs [ [ foo => [ col1, col2 ] ], [ bar => [ ... ] ] ]
739 sub _table_uniq_info { croak "ABSTRACT METHOD" }
741 # Returns an arrayref of foreign key constraints, each
742 # being a hashref with 3 keys:
743 # local_columns (arrayref), remote_columns (arrayref), remote_table
744 sub _table_fk_info { croak "ABSTRACT METHOD" }
746 # Returns an array of lower case table names
747 sub _tables_list { croak "ABSTRACT METHOD" }
749 # Execute a constructive DBIC class method, with debug/dump_to_dir hooks.
756 $args = '(' . $args . ')' if @_ < 2;
757 my $stmt = $method . $args . q{;};
759 warn qq|$class\->$stmt\n| if $self->debug;
760 $self->_raw_stmt($class, '__PACKAGE__->' . $stmt);
763 # Store a raw source line for a class (for dumping purposes)
765 my ($self, $class, $stmt) = @_;
766 push(@{$self->{_dump_storage}->{$class}}, $stmt);
769 # Like above, but separately for the externally loaded stuff
771 my ($self, $class, $stmt) = @_;
772 push(@{$self->{_ext_storage}->{$class}}, $stmt);
777 Returns a hashref of loaded table to moniker mappings. There will
778 be two entries for each table, the original name and the "normalized"
779 name, in the case that the two are different (such as databases
780 that like uppercase table names, or preserve your original mixed-case
781 definitions, or what-have-you).
785 Returns a hashref of table to class mappings. In some cases it will
786 contain multiple entries per table for the original and normalized table
787 names, as above in L</monikers>.
791 L<DBIx::Class::Schema::Loader>