lib/Maypole/Model/CDBI/DFV.pm

   1 package Maypole::Model::CDBI::DFV;
   2 use strict;
   3
   4 =head1 NAME
   5
   6 Maypole::Model::CDBI::DFV - Class::DBI::DFV model for Maypole.
   7
   8 =head1 SYNOPSIS
   9
  10     package Foo;
  11     use 'Maypole::Application';
  12
  13     Foo->config->model("Maypole::Model::CDBI::DFV");
  14     Foo->setup([qw/ Foo::SomeTable Foo::Other::Table /]);
  15
  16     # Look ma, no untainting
  17
  18     sub Foo::SomeTable::SomeAction : Exported {
  19
  20         . . .
  21
  22     }
  23
  24 =head1 DESCRIPTION
  25
  26 This module allows you to use Maypole with previously set-up
  27 L<Class::DBI> classes that use Class::DBI::DFV;
  28
  29 Simply call C<setup> with a list reference of the classes you're going to use,
  30 and Maypole will work out the tables and set up the inheritance relationships
  31 as normal.
  32
  33 Better still, it will also set use your DFV profile to validate input instead
  34 of CGI::Untaint. For teh win!!
  35
  36 =cut
  37
  38 use Class::C3;
  39 use Data::FormValidator;
  40 use Data::Dumper;
  41
  42 use Maypole::Config;
  43 use Maypole::Model::CDBI::AsForm;
  44
  45 use base qw(Maypole::Model::CDBI::Base);
  46
  47 Maypole::Config->mk_accessors(qw(table_to_class _COLUMN_INFO));
  48
  49 =head1 METHODS
  50
  51 =head2 setup
  52
  53   This method is inherited from Maypole::Model::Base and calls setup_database,
  54   which uses Class::DBI::Loader to create and load Class::DBI classes from
  55   the given database schema.
  56
  57 =head2 setup_database
  58
  59   This method loads the model classes for the application
  60
  61 =cut
  62
  63 sub setup_database {
  64     my ( $self, $config, $namespace, $classes ) = @_;
  65     $config->{classes}        = $classes;
  66     foreach my $class (@$classes) {
  67       $namespace->load_model_subclass($class);
  68     }
  69     $namespace->model_classes_loaded(1);
  70     $config->{table_to_class} = { map { $_->table => $_ } @$classes };
  71     $config->{tables}         = [ keys %{ $config->{table_to_class} } ];
  72 }
  73
  74 =head2 class_of
  75
  76   returns class for given table
  77
  78 =cut
  79
  80 sub class_of {
  81     my ( $self, $r, $table ) = @_;
  82     return $r->config->{table_to_class}->{$table};
  83 }
  84
  85 =head2 adopt
  86
  87 This class method is passed the name of a model class that represensts a table
  88 and allows the master model class to do any set-up required.
  89
  90 =cut
  91
  92 sub adopt {
  93     my ( $self, $child ) = @_;
  94     if ( my $col = $child->stringify_column ) {
  95         $child->columns( Stringify => $col );
  96     }
  97 }
  98
  99 =head2 check_params
 100
 101   Checks parameters against the DFV profile for the class, returns the results
 102   of DFV's check.
 103
 104   my $dfv_results = __PACKAGE__->check_params($r->params);
 105
 106 =cut
 107
 108 sub check_params {
 109   my ($class,$params) = @_;
 110   return Data::FormValidator->check($params, $class->dfv_profile);
 111 }
 112
 113
 114 =head1 Action Methods
 115
 116 Action methods are methods that are accessed through web (or other public) interface.
 117
 118 Inherited from L<Maypole::Model::CDBI::Base> except do_edit (below)
 119
 120 =head2 do_edit
 121
 122 If there is an object in C<$r-E<gt>objects>, then it should be edited
 123 with the parameters in C<$r-E<gt>params>; otherwise, a new object should
 124 be created with those parameters, and put back into C<$r-E<gt>objects>.
 125 The template should be changed to C<view>, or C<edit> if there were any
 126 errors. A hash of errors will be passed to the template.
 127
 128 =cut
 129
 130 sub do_edit : Exported {
 131   my ($class, $r, $obj) = @_;
 132
 133   my $config   = $r->config;
 134   my $table    = $r->table;
 135
 136   # handle cancel button hit
 137   if ( $r->params->{cancel} ) {
 138     $r->template("list");
 139     $r->objects( [$class->retrieve_all] );
 140     return;
 141   }
 142
 143
 144   my $errors;
 145   if ($obj) {
 146     ($obj,$errors) = $class->_do_update($r,$obj);
 147   } else {
 148     ($obj,$errors) = $class->_do_create($r);
 149   }
 150
 151   # handle errors, if none, proceed to view the newly created/updated object
 152   if (ref $errors) {
 153     # pass errors to template
 154     $r->template_args->{errors} = $errors;
 155     # Set it up as it was:
 156     $r->template_args->{cgi_params} = $r->params;
 157     $r->template("edit");
 158   } else {
 159     $r->template("view");
 160   }
 161
 162   $r->objects( $obj ? [$obj] : []);
 163 }
 164
 165 sub _do_update {
 166   my ($class,$r,$obj) = @_;
 167   my $errors;
 168   my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
 169
 170   # handle dfv errors
 171   if ( $dfv_results->has_missing ) {   # missing fields
 172     foreach my $field ( $dfv_results->missing ) {
 173       $errors->{$field} = "$field is required";
 174     }
 175   }
 176   if ( $dfv_results->has_invalid ) {   # Print the name of invalid fields
 177     foreach my $field ( $dfv_results->invalid ) {
 178       $errors->{$field} =  "$field is invalid: " . $dfv_results->invalid( $field );
 179     }
 180   }
 181
 182
 183   my $this_class_params = {};
 184   foreach my $param ( $class->columns ) {
 185     next if ($param eq $class->columns('Primary'));
 186     my $value = $r->params->{$param};
 187     next unless (defined $value);
 188     $this_class_params->{$param} = ( $value eq '' ) ?  undef : $value;
 189   }
 190
 191   # update or make other related (must_have, might_have, has_many  etc )
 192   unless ($errors) {
 193     foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
 194       # get related object if it exists
 195       my $rel_meta = $class->related_meta('r',$accssr);
 196       if (!$rel_meta) {
 197         $r->warn("[_do_update] No relationship for $accssr in " . ref($class));
 198         next;
 199       }
 200
 201       my $rel_type  = $rel_meta->{name};
 202       my $fclass    = $rel_meta->{foreign_class};
 203       my ($rel_obj,$errs);
 204       $rel_obj = $fclass->retrieve($r->params->{$accssr});
 205       # update or create related object
 206       ($rel_obj, $errs) = ($rel_obj)
 207         ? $fclass->_do_update($r, $rel_obj)
 208           : $obj->_create_related($accssr, $r->params);
 209       $errors->{$accssr} = $errs if ($errs);
 210     }
 211   }
 212
 213   unless ($errors) {
 214     $obj->set( %$this_class_params );
 215     $obj->update;
 216   }
 217
 218   return ($obj,$errors);
 219 }
 220
 221 sub _do_create {
 222   my ($class,$r) = @_;
 223   my $errors;
 224
 225   my $this_class_params = {};
 226   foreach my $param ( $class->columns ) {
 227     next if ($param eq $class->columns('Primary'));
 228     my $value = $r->params->{$param};
 229     next unless (defined $value);
 230     $this_class_params->{$param} = ( $value eq '' ) ?  undef : $value;
 231   }
 232
 233   my $obj;
 234
 235   my $dfv_results = Data::FormValidator->check($r->{params}, $class->dfv_profile);
 236   if ($dfv_results->success) {
 237     $obj = $class->create($this_class_params);
 238   } else {
 239     # handle dfv errors
 240     if ( $dfv_results->has_missing ) {   # missing fields
 241       foreach my $field ( $dfv_results->missing ) {
 242         $errors->{$field} = "$field is required";
 243       }
 244     }
 245     if ( $dfv_results->has_invalid ) {   # Print the name of invalid fields
 246       foreach my $field ( $dfv_results->invalid ) {
 247         $errors->{$field} =  "$field is invalid: " . $dfv_results->invalid( $field );
 248       }
 249     }
 250   }
 251
 252   # Make other related (must_have, might_have, has_many  etc )
 253   unless ($errors) {
 254     foreach my $accssr ( grep ( !(exists $this_class_params->{$_}) , keys %{$r->{params}} ) ) {
 255       my ($rel_obj, $errs) = $obj->_create_related($accssr, $r->{params}{$accssr});
 256       $errors->{$accssr} = $errs if ($errs);
 257     }
 258   }
 259   return ($obj,$errors);
 260 }
 261
 262
 263 sub _create_related {
 264   # self is object or class, accssr is accssr to relationship, params are
 265   # data for relobject, and created is the array ref to store objs
 266   my ( $self, $accssr, $params )  = @_;
 267   $self->_croak ("Can't make related object without a parent $self object") unless (ref $self);
 268   my $created = [];
 269   my $rel_meta = $self->related_meta('r',$accssr);
 270   if (!$rel_meta) {
 271     $self->_carp("[_create_related] No relationship for $accssr in " . ref($self));
 272     return;
 273   }
 274
 275   my $rel_type  = $rel_meta->{name};
 276   my $fclass    = $rel_meta->{foreign_class};
 277
 278   my ($rel, $errs);
 279
 280   # Set up params for might_have, has_many, etc
 281   if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
 282     # Foreign Key meta data not very standardized in CDBI
 283     my $fkey= $rel_meta->{args}{foreign_key} || $rel_meta->{foreign_column};
 284     unless ($fkey) { die " Could not determine foreign key for $fclass"; }
 285     my %data = (%$params, $fkey => $self->id);
 286     %data = ( %data, %{$rel_meta->{args}->{constraint} || {}} );
 287     ($rel, $errs) =  $fclass->_do_create(\%data);
 288   }
 289   else {
 290     ($rel, $errs) =  $fclass->_do_create($params);
 291     unless ($errs) {
 292       $self->$accssr($rel->id);
 293       $self->update;
 294     }
 295   }
 296   return ($rel, $errs);
 297 }
 298
 299
 300 =head2 do_delete
 301
 302 Inherited from Maypole::Model::CDBI::Base.
 303
 304 This action deletes records
 305
 306 =head2 do_search
 307
 308 Inherited from Maypole::Model::CDBI::Base.
 309
 310 This action method searches for database records.
 311
 312 =head2 list
 313
 314 Inherited from Maypole::Model::CDBI::Base.
 315
 316 The C<list> method fills C<$r-E<gt>objects> with all of the
 317 objects in the class. The results are paged using a pager.
 318
 319 =cut
 320
 321 sub _column_info {
 322   my $class = shift;
 323
 324   # get COLUMN INFO from DB
 325   $class->SUPER::_column_info() unless (ref $class->COLUMN_INFO);
 326
 327   # update with required columns from DFV Profile
 328   my $profile = $class->dfv_profile;
 329   $class->required_columns($profile->{required});
 330
 331   return $class->COLUMN_INFO;
 332 }
 333
 334
 335
 336 =head1 SEE ALSO
 337
 338 L<Maypole::Model::Base>
 339
 340 L<Maypole::Model::CDBI::Base>
 341
 342 =head1 AUTHOR
 343
 344 Aaron Trevena.
 345
 346 =head1 LICENSE
 347
 348 You may distribute this code under the same terms as Perl itself.
 349
 350 =cut
 351
 352 1;
 353
 354