1 package Maypole::Model::CDBI;
6 Maypole::Model::CDBI - Model class based on Class::DBI
10 This is a master model class which uses L<Class::DBI> to do all the hard
11 work of fetching rows and representing them as objects. It is a good
12 model to copy if you're replacing it with other database abstraction
15 It implements a base set of methods required for a Maypole Data Model.
17 It inherits accessor and helper methods from L<Maypole::Model::Base>.
19 When specified as the application model, it will use Class::DBI::Loader
20 to generate the model classes from the provided database. If you do not
21 wish to use this functionality, use L<Maypole::Model::CDBI::Plain> which
22 will instead use Class::DBI classes provided.
26 use base qw(Maypole::Model::Base Class::DBI);
27 #use Class::DBI::Plugin::Type;
28 use Class::DBI::Loader;
29 use Class::DBI::AbstractSearch;
30 use Class::DBI::Plugin::RetrieveAll;
31 use Class::DBI::Pager;
32 use Lingua::EN::Inflect::Number qw(to_PL);
35 use Maypole::Model::CDBI::AsForm;
36 use Maypole::Model::CDBI::FromCGI;
37 use CGI::Untaint::Maypole;
41 Set the class you use to untaint and validate form data
42 Note it must be of type CGI::Untaint::Maypole (takes $r arg) or CGI::Untaint
45 sub Untainter { 'CGI::Untaint::Maypole' };
49 #use Class::DBI::FromCGI;
51 #sub Untainter { 'CGI::Untaint' };
54 __PACKAGE__->mk_classdata($_) for (qw/COLUMN_INFO/);
58 Action methods are methods that are accessed through web (or other public) interface.
62 If there is an object in C<$r-E<gt>objects>, then it should be edited
63 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
64 be created with those parameters, and put back into C<$r-E<gt>objects>.
65 The template should be changed to C<view>, or C<edit> if there were any
66 errors. A hash of errors will be passed to the template.
70 sub do_edit : Exported {
71 my ($self, $r, $obj) = @_;
73 my $config = $r->config;
74 my $table = $r->table;
76 # handle cancel button hit
77 if ( $r->{params}->{cancel} ) {
79 $r->objects( [$self->retrieve_all] );
83 my $required_cols = $config->{$table}->{required_cols} || [];
84 my $ignored_cols = $r->{config}{ $r->{table} }{ignore_cols} || [];
86 ($obj, my $fatal, my $creating) = $self->_do_update_or_create($r, $obj, $required_cols, $ignored_cols);
88 # handle errors, if none, proceed to view the newly created/updated object
89 my %errors = $fatal ? (FATAL => $fatal) : $obj->cgi_update_errors;
92 # Set it up as it was:
93 $r->template_args->{cgi_params} = $r->params;
95 # replace user unfriendly error messages with something nicer
97 foreach (@{$config->{$table}->{required_cols}}) {
98 next unless ($errors{$_});
101 $r->template_args->{errors}{ucfirst($_)} = 'This field is required, please provide a valid value';
102 $r->template_args->{errors}{$key} = 'This field is required, please provide a valid value';
103 delete $errors{$key};
106 foreach (keys %errors) {
109 $r->template_args->{errors}{ucfirst($_)} = 'Please provide a valid value for this field';
110 $r->template_args->{errors}{$key} = 'Please provide a valid value for this field';
113 undef $obj if $creating;
115 die "do_update failed with error : $fatal" if ($fatal);
116 $r->template("edit");
118 $r->template("view");
123 $r->objects( $obj ? [$obj] : []);
126 # split out from do_edit to be reported by Mp::P::Trace
127 sub _do_update_or_create {
128 my ($self, $r, $obj, $required_cols, $ignored_cols) = @_;
133 my $h = $self->Untainter->new( %{$r->params} );
137 # We have something to edit
138 eval { $obj->update_from_cgi( $h => {
139 required => $required_cols,
140 ignore => $ignored_cols,
142 $obj->update(); # pos fix for bug 17132 'autoupdate required by do_edit'
147 $obj = $self->create_from_cgi( $h => {
148 required => $required_cols,
149 ignore => $ignored_cols,
156 return $obj, $fatal, $creating;
162 Deprecated method that calls do_delete or a given classes delete method, please
163 use do_delete instead
167 Unsuprisingly, this command causes a database record to be forever lost.
169 This method replaces the, now deprecated, delete method provided in prior versions
173 sub delete : Exported {
175 my ($sub) = (caller(1))[3];
176 # So subclasses can still send delete down ...
177 $sub =~ /^(.+)::([^:]+)$/;
178 if ($1 ne "Maypole::Model::Base" && $2 ne "delete") {
179 $self->SUPER::delete(@_);
181 warn "Maypole::Model::CDBI delete method is deprecated\n";
182 $self->do_delete(@_);
187 my ( $self, $r ) = @_;
188 # FIXME: handle fatal error with exception
189 $_->SUPER::delete for @{ $r->objects || [] };
191 $r->objects( [ $self->retrieve_all ] );
192 $r->{template} = "list";
198 Deprecated searching method - use do_search instead.
202 This action method searches for database records, it replaces
203 the, now deprecated, search method previously provided.
207 sub search : Exported {
209 my ($sub) = (caller(1))[3];
210 $sub =~ /^(.+)::([^:]+)$/;
211 # So subclasses can still send search down ...
212 return ($1 ne "Maypole::Model::Base" && $2 ne "search") ?
213 $self->SUPER::search(@_) : $self->do_search(@_);
216 sub do_search : Exported {
217 my ( $self, $r ) = @_;
218 my %fields = map { $_ => 1 } $self->columns;
219 my $oper = "like"; # For now
220 my %params = %{ $r->{params} };
221 my %values = map { $_ => { $oper, $params{$_} } }
222 grep { defined $params{$_} && length ($params{$_}) && $fields{$_} }
225 $r->template("list");
226 if ( !%values ) { return $self->list($r) }
227 my $order = $self->order($r);
228 $self = $self->do_pager($r);
232 \%values, ( $order ? { order_by => $order } : () )
236 $r->{template_args}{search} = 1;
241 The C<list> method fills C<$r-E<gt>objects> with all of the
242 objects in the class. The results are paged using a pager.
246 sub list : Exported {
247 my ( $self, $r ) = @_;
248 my $order = $self->order($r);
249 $self = $self->do_pager($r);
251 $r->objects( [ $self->retrieve_all_sorted_by($order) ] );
254 $r->objects( [ $self->retrieve_all ] );
258 ###############################################################################
261 =head1 Helper Methods
266 This class method is passed the name of a model class that represensts a table
267 and allows the master model class to do any set-up required.
272 my ( $self, $child ) = @_;
273 $child->autoupdate(1);
274 if ( my $col = $child->stringify_column ) {
275 $child->columns( Stringify => $col );
282 This method returns a list of has-many accessors. A brewery has many
283 beers, so C<BeerDB::Brewery> needs to return C<beers>.
288 my ( $self, $r ) = @_;
289 return keys %{ $self->meta_info('has_many') || {} };
295 Given an accessor name as a method, this function returns the class this accessor returns.
300 my ( $self, $r, $accessor ) = @_;
301 my $meta = $self->meta_info;
302 my @rels = keys %$meta;
305 $related = $meta->{$_}{$accessor};
308 return unless $related;
310 my $mapping = $related->{args}->{mapping};
311 if ( $mapping and @$mapping ) {
312 return $related->{foreign_class}->meta_info('has_a')->{$$mapping[0]}->{foreign_class};
315 return $related->{foreign_class};
321 $class->related_meta($col);
323 Given a column associated with a relationship it will return the relatation
324 ship type and the meta info for the relationship on the column.
329 my ($self,$r, $accssr) = @_;
330 $self->_croak("You forgot to put the place holder for 'r' or forgot the accssr parameter") unless $accssr;
331 my $class_meta = $self->meta_info;
332 if (my ($rel_type) = grep { defined $class_meta->{$_}->{$accssr} }
334 { return $rel_type, $class_meta->{$rel_type}->{$accssr} };
339 =head2 stringify_column
341 Returns the name of the column to use when stringifying
346 sub stringify_column {
349 $class->columns("Stringify"),
350 ( grep { /^(name|title)$/i } $class->columns ),
351 ( grep { /(name|title)/i } $class->columns ),
352 ( grep { !/id$/i } $class->primary_columns ),
358 Sets the pager template argument ($r->{template_args}{pager})
359 to a Class::DBI::Pager object based on the rows_per_page
360 value set in the configuration of the application.
362 This pager is used via the pager macro in TT Templates, and
363 is also accessible via Mason.
368 my ( $self, $r ) = @_;
369 if ( my $rows = $r->config->rows_per_page ) {
370 return $r->{template_args}{pager} =
371 $self->pager( $rows, $r->query->{page} );
373 else { return $self }
379 Returns the SQL order syntax based on the order parameter passed
380 to the request, and the valid columns.. i.e. 'title ASC' or 'date_created DESC'.
382 $sql .= $self->order($r);
384 If the order column is not a column of this table,
385 or an order argument is not passed, then the return value is undefined.
387 Note: the returned value does not start with a space.
392 my ( $self, $r ) = @_;
393 my %ok_columns = map { $_ => 1 } $self->columns;
395 my $order = $q->{order};
396 return unless $order and $ok_columns{$order};
397 $order .= ' DESC' if $q->{o2} and $q->{o2} eq 'desc';
403 This method is inherited from Maypole::Model::Base and calls setup_database,
404 which uses Class::DBI::Loader to create and load Class::DBI classes from
405 the given database schema.
409 =head2 setup_database
411 The $opts argument is a hashref of options. The "options" key is a hashref of
412 Database connection options . Other keys may be various Loader arguments or
413 flags. It has this form:
415 # DB connection options
416 options { AutoCommit => 1 , ... },
425 my ( $class, $config, $namespace, $dsn, $u, $p, $opts ) = @_;
426 $dsn ||= $config->dsn;
427 $u ||= $config->user;
428 $p ||= $config->pass;
429 $opts ||= $config->opts;
431 warn "No DSN set in config" unless $dsn;
432 $config->loader || $config->loader(
433 Class::DBI::Loader->new(
434 namespace => $namespace,
441 $config->{classes} = [ $config->{loader}->classes ];
442 $config->{tables} = [ $config->{loader}->tables ];
444 my @table_class = map { $_ . " => " . $config->{loader}->_table2class($_) } @{ $config->{tables} };
445 warn( 'Loaded tables to classes: ' . join ', ', @table_class )
446 if $namespace->debug;
451 returns class for given table
456 my ( $self, $r, $table ) = @_;
457 return $r->config->loader->_table2class($table); # why not find_class ?
462 Returns 1 or more objects of the given class when provided with the request
468 my @pcs = $class->primary_columns;
471 @pks{@pcs}=(@{$r->{args}});
472 return $class->retrieve( %pks );
474 return $class->retrieve( $r->{args}->[0] );
483 Private method to return the class a column
484 belongs to that was inherited by an is_a relationship.
485 This should probably be public but need to think of API
490 my ($class, $col) = @_;
491 $class->_croak( "Need a column for _isa_class." ) unless $col;
493 my $isa = $class->meta_info("is_a") || {};
494 foreach ( keys %$isa ) {
495 $isaclass = $isa->{$_}->foreign_class;
496 return $isaclass if ($isaclass->find_column($col));
498 return; # col not in a is_a class
503 # Thanks to dave baird -- form builder for these private functions
506 my $dbh = $self->db_Main;
507 return $self->COLUMN_INFO if ref $self->COLUMN_INFO;
509 my $meta; # The info we are after
510 my ($catalog, $schema) = (undef, undef);
511 # Dave is suspicious this (above undefs) could
512 # break things if driver useses this info
514 # '%' is a search pattern for columns - matches all columns
515 if ( my $sth = $dbh->column_info( $catalog, $schema, $self->table, '%' ) )
517 $dbh->errstr && die "Error getting column info sth: " . $dbh->errstr;
518 $self->COLUMN_INFO( $self->_hash_type_meta( $sth ) );
519 # use Data::Dumper; warn "col info for typed is " . Dumper($self->COLUMN_INFO);
523 $self->COLUMN_INFO( $self->_hash_typeless_meta( ) );
524 # use Data::Dumper; warn "col info TYPELESS is " . Dumper($self->COLUMN_INFO);
526 return $self->COLUMN_INFO;
531 my ($self, $sth) = @_;
533 while ( my $row = $sth->fetchrow_hashref )
536 my ($col_meta, $col_name);
538 foreach my $key ( keys %$row)
540 my $value = $row->{$key} || $row->{ uc $key };
541 $col_meta->{$key} = $value;
542 $col_name = $row->{COLUMN_NAME} || $row->{column_name};
545 $meta->{$col_name} = $col_meta;
550 # typeless db e.g. sqlite
551 sub _hash_typeless_meta
555 $self->set_sql( fb_meta_dummy => 'SELECT * FROM __TABLE__ WHERE 1=0' )
556 unless $self->can( 'sql_fb_meta_dummy' );
558 my $sth = $self->sql_fb_meta_dummy;
560 $sth->execute or die "Error executing column info: " . $sth->errstr;;
562 # see 'Statement Handle Attributes' in the DBI docs for a list of available attributes
563 my $cols = $sth->{NAME};
564 my $types = $sth->{TYPE};
565 # my $sizes = $sth->{PRECISION}; # empty
566 # my $nulls = $sth->{NULLABLE}; # empty
568 # we haven't actually fetched anything from the sth, so need to tell DBI we're not going to
573 foreach my $col ( @$cols )
577 $col_meta->{NULLABLE} = 1;
579 # in my limited testing, the columns are returned in the same order as they were defined in the schema
580 $col_meta->{ORDINAL_POSITION} = $order++;
582 # type_name is taken literally from the schema, but is not actually used by sqlite,
583 # so it can be anything, e.g. varchar or varchar(xxx) or VARCHAR etc.
584 my $type = shift( @$types );
585 $type =~ /(\w+)\((\w+)\)/;
586 $col_meta->{type} = $type;
587 $col_meta->{TYPE_NAME} = $1;
589 $col_meta->{COLUMN_SIZE} = $size if $type =~ /(CHAR|INT)/i;
590 $meta->{$col} = $col_meta;
599 my $type = $class->column_type('column_name');
601 This returns the 'type' of this column (VARCHAR(20), BIGINT, etc.)
602 For now, it returns "BOOL" for tinyints.
604 TODO :: TEST with enums and postgres
609 my $col = shift or die "Need a column for column_type";
610 my $info = $class->_column_info->{$col} ||
611 eval { $class->_isa_class($col)->_column_info($col) } ||
614 my $type = $info->{mysql_type_name} || $info->{type};
616 $type = $info->{TYPE_NAME};
617 if ($info->{COLUMN_SIZE}) { $type .= "($info->{COLUMN_SIZE})"; }
620 if ($type and $type =~ /^tinyint/i and $info->{COLUMN_SIZE} == 1) {
626 =head2 column_nullable
628 Returns true if a column can be NULL and false if not.
632 sub column_nullable {
634 my $col = shift or $class->_croak( "Need a column for column_nullable" );
635 my $info = $class->_column_info->{$col} ||
636 eval { $class->_isa_class($col)->_column_info($col) } ||
638 return $info->{NULLABLE};
641 =head2 column_default
643 Returns default value for column or the empyty string.
644 Columns with NULL, CURRENT_TIMESTAMP, or Zeros( 0000-00...) for dates and times
651 my $col = shift or $class->_croak( "Need a column for column_default");
652 #return unless $class->find_column($col); # not a real column
654 my $info = $class->_column_info->{$col} ||
655 eval { $class->_isa_class($col)->_column_info($col) } ||
658 my $def = $info->{COLUMN_DEF};
659 $def = '' unless defined $def;
661 # exclude defaults we don't want to display-- may need some additions here
662 if ( $class->column_type($col) =~ /^BOOL/i ) {
663 $def = $def ? 1 : 0; # allow 0 or 1 for bool cols
666 $def = $def =~ /(^0000-00-00.*$|^0[0]*$|^0\.00$|CURRENT_TIMESTAMP|NULL)/i ? '' : $def ;
674 =head2 get_classmetadata
676 Gets class meta data *excluding cgi input* for the passed in class or the
677 calling class. *NOTE* excludes cgi inputs. This method is handy to call from
678 templates when you need some metadata for a related class.
682 sub get_classmetadata {
683 my ($self, $class) = @_; # class is class we want data for
685 $class = ref $class || $class;
689 $res{colnames} = {$class->column_names};
690 $res{columns} = [$class->display_columns];
691 $res{list_columns} = [$class->list_columns];
692 $res{moniker} = $class->moniker;
693 $res{plural} = $class->plural_moniker;
694 $res{table} = $class->table;