1 package Maypole::Model::CDBI::FromCGI;
8 Maypole::Model:CDBI::FromCGI - Validate form input and populate Model objects
12 $obj = $class->create_from_cgi($r);
13 $obj = $class->create_from_cgi($r, { params => {data1=>...}, required => [..],
14 ignore => [...], all => [...]);
15 $obj = $class->create_from_cgi($h, $options); # CDBI::FromCGI style, see docs
17 $obj->update_from_cgi($r);
18 $obj->update_from_cgi($h, $options);
20 $obj = $obj->add_to_from_cgi($r);
21 $obj = $obj->add_to_from_cgi($r, { params => {...} } );
23 # This does not work like in CDBI::FromCGI and probably never will :
24 # $class->update_from_cgi($h, @columns);
29 Provides a way to validate form input and populate Model Objects, based
30 on Class::DBI::FromCGI.
35 # The base base model class for apps
36 # provides good search and create functions
38 use base qw(Exporter);
40 use Maypole::Constants;
41 use CGI::Untaint::Maypole;
42 our $Untainter = 'CGI::Untaint::Maypole';
44 our @EXPORT = qw/update_from_cgi create_from_cgi untaint_columns add_to_from_cgi
45 cgi_update_errors untaint_type validate_inputs validate_all _do_update_all
46 _do_create_all _create_related classify_form_inputs/;
50 use Data::Dumper; # for debugging
54 =head2 untaint_columns
56 Replicates Class::DBI::FromCGI method of same name :
58 __PACKAGE__->untaint_columns(
59 printable => [qw/Title Director/],
60 integer => [qw/DomesticGross NumExplodingSheep],
61 date => [qw/OpeningDate/],
67 die "untaint_columns() needs a hash" unless @_ % 2;
68 my ($class, %args) = @_;
69 $class->mk_classdata('__untaint_types')
70 unless $class->can('__untaint_types');
71 my %types = %{ $class->__untaint_types || {} };
72 while (my ($type, $ref) = each(%args)) {
75 $class->__untaint_types(\%types);
80 gets the untaint type for a column as set in "untaint_types"
84 # get/set untaint_type for a column
86 my ($class, $field, $new_type) = @_;
87 my %handler = __PACKAGE__->_untaint_handlers($class);
88 return $handler{$field} if $handler{$field};
90 local $SIG{__WARN__} = sub { };
91 my $type = $class->column_type($field) or die;
92 _column_type_for($type);
94 return $handler || undef;
97 =head2 cgi_update_errors
99 Returns errors that ocurred during an operation.
103 sub cgi_update_errors { %{ shift->{_cgi_update_error} || {} } }
105 =head2 create_from_cgi
107 Based on the same method in Class::DBI::FromCGI.
109 Creates multiple objects from a cgi form.
110 Errors are returned in cgi_update_errors
112 It can be called Maypole style passing the Maypole request object as the
113 first arg, or Class::DBI::FromCGI style passing the Untaint Handler ($h)
116 A hashref of options can be passed as the second argument. Unlike
117 in the CDBI equivalent, you can *not* pass a list as the second argument.
119 params -- hashref of cgi data to use instead of $r->params,
120 required -- list of fields that are required
121 ignore -- list of fields to ignore
122 all -- list of all fields (defaults to $class->columns)
126 sub create_from_cgi {
127 my ($self, $r, $opts) = @_;
128 $self->_croak( "create_from_cgi can only be called as a class method")
130 my ($errors, $validated);
133 if ($r->isa('CGI::Untaint')) { # FromCGI interface compatibility
134 ($validated, $errors) = $self->validate_inputs($r,$opts);
136 my $params = $opts->{params} || $r->params;
137 $opts->{params} = $self->classify_form_inputs($params);
138 ($validated, $errors) = $self->validate_all($r, $opts);
142 return bless { _cgi_update_error => $errors }, $self;
145 # Insert all the data
146 my ($obj, $err ) = $self->_do_create_all($validated);
148 return bless { _cgi_update_error => $err }, $self;
154 =head2 update_from_cgi
156 Replicates the Class::DBI::FromCGI method of same name. It updates an object and
157 returns 1 upon success. It can take the same arguments as create_form_cgi.
158 If errors, it sets the cgi_update_errors.
162 sub update_from_cgi {
163 my ($self, $r, $opts) = @_;
164 $self->_croak( "update_from_cgi can only be called as an object method") unless ref $self;
165 my ($errors, $validated);
166 $self->{_cgi_update_error} = {};
167 $opts->{updating} = 1;
169 # FromCGI interface compatibility
170 if ($r->isa('CGI::Untaint')) {
171 # REHASH the $opts for updating:
172 # 1: we ignore any fields we dont have parmeter for. (safe ?)
173 # 2: we dont want to update fields unless they change
175 my @ignore = @{$opts->{ignore} || []};
176 push @ignore, $self->primary_column->name;
177 my $raw = $r->raw_data;
178 #print "*** raw data ****" . Dumper($raw);
179 foreach my $field ($self->columns) {
180 #print "*** field is $field ***\n";
181 if (not defined $raw->{$field}) {
182 push @ignore, $field->name;
183 #print "*** ignoring $field because it is not present ***\n";
186 # stupid inflation , cant get at raw db value easy, must call
187 # deflate ***FIXME****
188 my $cur_val = ref $self->$field ? $self->$field->id : $self->$field;
189 if ($raw->{$field} eq $cur_val) {
190 #print "*** ignoring $field because unchanged ***\n";
191 push @ignore, "$field";
194 $opts->{ignore} = \@ignore;
195 ($validated, $errors) = $self->validate_inputs($r,$opts);
197 my $params = $opts->{params} || $r->params;
198 $opts->{params} = $self->classify_form_inputs($params);
199 ($validated, $errors) = $self->validate_all($r, $opts);
200 #print "*** errors for validate all ****" . Dumper($errors);
204 #print "*** we have errors ****" . Dumper($errors);
205 $self->{_cgi_update_error} = $errors;
209 # Update all the data
210 my ($obj, $err ) = $self->_do_update_all($validated);
212 $self->{_cgi_update_error} = $err;
218 =head2 add_to_from_cgi
220 $obj->add_to_from_cgi($r[, $opts]);
222 Like add_to_* for has_many relationships but will add nay objects it can
223 figure out from the data. It returns a list of objects it creates or nothing
224 on error. Call cgi_update_errors with the calling object to get errors.
225 Fatal errors are in the respective "FATAL" key.
229 sub add_to_from_cgi {
230 my ($self, $r, $opts) = @_;
231 $self->_croak( "add_to_from_cgi can only be called as an object method")
233 my ($errors, $validated, @created);
235 my $params = $opts->{params} || $r->params;
236 $opts->{params} = $self->classify_form_inputs($params);
237 ($validated, $errors) = $self->validate_all($r, $opts);
241 $self->{_cgi_update_error} = $errors;
245 # Insert all the data
246 foreach my $hm (keys %$validated) {
247 my ($obj, $errs) = $self->_create_related($hm, $validated->{$hm});
251 $errors->{$hm} = $errs;
256 $self->{_cgi_update_error} = $errors;
268 Validates (untaints) a hash of possibly mixed table data.
269 Returns validated and errors ($validated, $errors).
270 If no errors then undef in that spot.
275 my ($self, $r, $opts) = @_;
276 my $class = ref $self || $self;
277 my $classified = $opts->{params};
278 my $updating = $opts->{updating};
280 # Base case - validate this classes data
281 $opts->{all} ||= eval{ $r->config->{$self->table}{all_cols} } || [$self->columns('All')];
282 $opts->{required} ||= eval { $r->config->{$self->table}{required_cols} || $self->required_columns } || [];
283 my $ignore = $opts->{ignore} || eval{ $r->config->{$self->table}{ignore_cols} } || [];
284 push @$ignore, $self->primary_column->name if $updating;
286 # Ignore hashes of foreign inputs. This takes care of required has_a's
287 # for main object that we have foreign inputs for.
288 foreach (keys %$classified) {
289 push @$ignore, $_ if ref $classified->{$_} eq 'HASH';
291 $opts->{ignore} = $ignore;
292 my $h = $Untainter->new($classified);
293 my ($validated, $errs) = $self->validate_inputs($h, $opts);
295 # Validate all foreign input
297 #warn "Classified data is " . Dumper($classified);
298 foreach my $field (keys %$classified) {
299 if (ref $classified->{$field} eq "HASH") {
300 my $data = $classified->{$field};
302 my @usr_entered_vals = ();
303 foreach ( values %$data ) {
304 push @usr_entered_vals, $_ if $_ ne '';
308 # IF we have some inputs for the related
309 if ( @usr_entered_vals ) {
310 # We need to ignore us if we are a required has_a in this foreign class
311 my $rel_meta = $self->related_meta($r, $field);
312 my $fclass = $rel_meta->{foreign_class};
313 my $fmeta = $fclass->meta_info('has_a');
315 if ($fmeta->{$_}{foreign_class} eq $class) {
319 my ($valid, $ferrs) = $fclass->validate_all($r,
320 {params => $data, updating => $updating, ignore => $ignore } );
322 $errs->{$field} = $ferrs if $ferrs;
323 $validated->{$field} = $valid;
326 # Check this foreign object is not requeired
327 my %req = map { $_ => 1 } $opts->{required};
329 $errs->{$field}{FATAL} = "This is required. Please enter the required fields in this section."
334 #warn "Validated inputs are " . Dumper($validated);
335 undef $errs unless keys %$errs;
336 return ($validated, $errs);
341 =head2 validate_inputs
343 $self->validate_inputs($h, $opts);
345 This is the main validation method to validate inputs for a single class.
346 Most of the time you use validate_all.
348 Returns validated and errors.
350 If no errors then undef in that slot.
352 Note: This method is currently experimental (in 2.11) and may be subject to change
357 sub validate_inputs {
358 my ($self, $h, $opts) = @_;
359 my $updating = $opts->{updating};
360 my %required = map { $_ => 1 } @{$opts->{required}};
362 $seen{$_}++ foreach @{$opts->{ignore}};
365 $opts->{all} = [ $self->columns ] unless @{$opts->{all} || [] } ;
366 foreach my $field (@{$opts->{required}}, @{$opts->{all}}) {
367 next if $seen{$field}++;
368 my $type = $self->untaint_type($field) or
369 do { warn "No untaint type for $self 's field $field. Ignoring.";
372 my $value = $h->extract("-as_$type" => $field);
375 # Required field error
376 if ($required{$field} and !ref($value) and $err =~ /^No input for/) {
377 $errors->{$field} = "You must supply '$field'"
380 # 1: No inupt entered
381 if ($err =~ /^No input for/) {
382 # A : Updating -- set the field to undef or ''
384 $fields->{$field} = eval{$self->column_nullable($field)} ?
387 # B : Creating -- dont set a value and RDMS will put default
390 # 2: A real untaint error -- just set the error
391 elsif ($err !~ /^No parameter for/) {
392 $errors->{$field} = $err;
395 $fields->{$field} = $value
398 undef $errors unless keys %$errors;
399 return ($fields, $errors);
407 # Untaints and Creates objects from hashed params.
408 # Returns parent object and errors ($obj, $errors).
409 # If no errors, then undef in that slot.
411 my ($self, $validated) = @_;
412 my $class = ref $self || $self;
413 my ($errors, $accssr);
415 # Separate out related objects' data from main hash
417 foreach (keys %$validated) {
418 $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
421 # Make main object -- base case
422 #warn "\n*** validated data is " . Dumper($validated). "***\n";
423 my $me_obj = eval { $self->create($validated) };
425 warn "Just failed making a " . $self. " FATAL Error is $@"
426 if (eval{$self->model_debug});
427 $errors->{FATAL} = $@;
428 return (undef, $errors);
431 if (eval{$self->model_debug}) {
433 warn "Just made a $self : $me_obj ( " . $me_obj->id . ")";
435 warn "Just failed making a " . $self. " FATAL Error is $@" if not $me_obj;
439 # Make other related (must_have, might_have, has_many etc )
440 foreach $accssr ( keys %related ) {
441 my ($rel_obj, $errs) =
442 $me_obj->_create_related($accssr, $related{$accssr});
443 $errors->{$accssr} = $errs if $errs;
446 #warn "Errors are " . Dumper($errors);
448 undef $errors unless keys %$errors;
449 return ($me_obj, $errors);
457 # Updates objects from hashed untainted data
461 my ($self, $validated) = @_;
462 my ($errors, $accssr);
464 # Separate out related objects' data from main hash
466 foreach (keys %$validated) {
467 $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
470 # set does not work with IsA right now so we set each col individually
471 #$self->set(%$validated);
472 my $old = $self->autoupdate(0);
473 for (keys %$validated) {
474 $self->$_($validated->{$_});
477 $self->autoupdate($old);
480 foreach $accssr (keys %related) {
481 my $fobj = $self->$accssr;
482 my $validated = $related{$accssr};
484 my $old = $fobj->autoupdate(0);
485 for (keys %$validated) {
486 $fobj->$_($validated->{$_});
489 $fobj->autoupdate($old);
492 $fobj = $self->_create_related($accssr, $related{$accssr});
503 # Creates and automatically relates newly created object to calling object
504 # Returns related object and errors ($obj, $errors).
505 # If no errors, then undef in that slot.
507 sub _create_related {
508 # self is object or class, accssr is accssr to relationship, params are
509 # data for relobject, and created is the array ref to store objs we
511 my ( $self, $accssr, $params, $created ) = @_;
512 $self->_croak ("Can't make related object without a parent $self object")
515 my $rel_meta = $self->related_meta('r',$accssr);
517 $self->_carp("[_create_related] No relationship for $accssr in " . ref($self));
520 my $rel_type = $rel_meta->{name};
521 my $fclass = $rel_meta->{foreign_class};
522 #warn " Dumper of meta is " . Dumper($rel_meta);
527 # Set up params for might_have, has_many, etc
528 if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
530 # Foreign Key meta data not very standardized in CDBI
531 my $fkey= $rel_meta->{args}{foreign_key} || $rel_meta->{foreign_column};
532 unless ($fkey) { die " Could not determine foreign key for $fclass"; }
533 my %data = (%$params, $fkey => $self->id);
534 %data = ( %data, %{$rel_meta->{args}->{constraint} || {}} );
535 #warn "Data is " . Dumper(\%data);
536 ($rel, $errs) = $fclass->_do_create_all(\%data, $created);
539 ($rel, $errs) = $fclass->_do_create_all($params, $created);
541 $self->$accssr($rel->id);
545 return ($rel, $errs);
551 =head2 classify_form_inputs
553 $self->classify_form_inputs($params[, $delimiter]);
555 Foreign inputs are inputs that have data for a related table.
556 They come named so we can tell which related class they belong to.
557 This assumes the form : $accessor . $delimeter . $column recursively
558 classifies them into hashes. It returns a hashref.
562 sub classify_form_inputs {
563 my ($self, $params, $delimiter) = @_;
566 $delimiter ||= $self->foreign_input_delimiter;
567 foreach my $input_name (keys %$params) {
568 my @accssrs = split /$delimiter/, $input_name;
569 my $col_name = pop @accssrs;
570 $bottom_level = \%hashed;
571 while ( my $a = shift @accssrs ) {
572 $bottom_level->{$a} ||= {};
573 $bottom_level = $bottom_level->{$a}; # point to bottom level
575 # now insert parameter at bottom level keyed on col name
576 $bottom_level->{$col_name} = $params->{$input_name};
581 sub _untaint_handlers {
582 my ($me, $them) = @_;
583 return () unless $them->can('__untaint_types');
584 my %type = %{ $them->__untaint_types || {} };
586 @h{ @{ $type{$_} } } = ($_) x @{ $type{$_} } foreach keys %type;
590 sub _column_type_for {
594 varchar => 'printable',
597 tinyint => 'integer',
598 smallint => 'integer',
599 mediumint => 'integer',
601 integer => 'integer',
606 return $map{$type} || "";
615 Peter Speltz, Aaron Trevena
617 =head1 AUTHORS EMERITUS
624 * add_to_from_cgi, search_from_cgi
625 * complete documentation
626 * ensure full backward compatibility with Class::DBI::FromCGI
628 =head1 BUGS and QUERIES
630 Please direct all correspondence regarding this module to:
633 =head1 COPYRIGHT AND LICENSE
635 Copyright 2003-2004 by Peter Speltz
637 This library is free software; you can redistribute it and/or modify
638 it under the same terms as Perl itself.
642 L<Class::DBI>, L<Class::DBI::FromCGI>