1 package Maypole::Model::CDBI::FromCGI;
7 Maypole::Model:CDBI::FromCGI - Validate form input and populate Model objects
11 $obj = $class->create_from_cgi($r);
12 $obj = $class->create_from_cgi($r, { params => {data1=>...}, required => [..],
13 ignore => [...], all => [...]);
14 $obj = $class->create_from_cgi($h, $options); # CDBI::FromCGI style, see docs
16 $obj->update_from_cgi($r);
17 $obj->update_from_cgi($h, $options);
19 $obj = $obj->add_to_from_cgi($r);
20 $obj = $obj->add_to_from_cgi($r, { params => {...} } );
22 # This does not work like in CDBI::FromCGI and probably never will :
23 # $class->update_from_cgi($h, @columns);
28 Provides a way to validate form input and populate Model Objects, based
29 on Class::DBI::FromCGI.
34 # The base base model class for apps
35 # provides good search and create functions
37 use base qw(Exporter);
39 use Maypole::Constants;
40 use CGI::Untaint::Maypole;
41 our $Untainter = 'CGI::Untaint::Maypole';
43 our @EXPORT = qw/update_from_cgi create_from_cgi untaint_columns add_to_from_cgi
44 cgi_update_errors untaint_type validate_inputs validate_all _do_update_all
45 _do_create_all _create_related classify_form_inputs/;
49 use Data::Dumper; # for debugging
53 =head2 untaint_columns
55 Replicates Class::DBI::FromCGI method of same name :
57 __PACKAGE__->untaint_columns(
58 printable => [qw/Title Director/],
59 integer => [qw/DomesticGross NumExplodingSheep],
60 date => [qw/OpeningDate/],
66 die "untaint_columns() needs a hash" unless @_ % 2;
67 my ($class, %args) = @_;
68 $class->mk_classdata('__untaint_types')
69 unless $class->can('__untaint_types');
70 my %types = %{ $class->__untaint_types || {} };
71 while (my ($type, $ref) = each(%args)) {
74 $class->__untaint_types(\%types);
79 gets the untaint type for a column as set in "untaint_types"
83 # get/set untaint_type for a column
85 my ($class, $field, $new_type) = @_;
86 my %handler = __PACKAGE__->_untaint_handlers($class);
87 return $handler{$field} if $handler{$field};
89 local $SIG{__WARN__} = sub { };
90 my $type = $class->column_type($field) or die;
91 _column_type_for($type);
93 return $handler || undef;
96 =head2 cgi_update_errors
98 Returns errors that ocurred during an operation.
102 sub cgi_update_errors { %{ shift->{_cgi_update_error} || {} } }
106 =head2 create_from_cgi
108 Based on the same method in Class::DBI::FromCGI.
110 Creates multiple objects from a cgi form.
111 Errors are returned in cgi_update_errors
113 It can be called Maypole style passing the Maypole request object as the
114 first arg, or Class::DBI::FromCGI style passing the Untaint Handler ($h)
117 A hashref of options can be passed as the second argument. Unlike
118 in the CDBI equivalent, you can *not* pass a list as the second argument.
120 params -- hashref of cgi data to use instead of $r->params,
121 required -- list of fields that are required
122 ignore -- list of fields to ignore
123 all -- list of all fields (defaults to $class->columns)
127 sub create_from_cgi {
128 my ($self, $r, $opts) = @_;
129 $self->_croak( "create_from_cgi can only be called as a class method")
131 my ($errors, $validated);
134 if ($r->isa('CGI::Untaint')) { # FromCGI interface compatibility
135 ($validated, $errors) = $self->validate_inputs($r,$opts);
137 my $params = $opts->{params} || $r->params;
138 $opts->{params} = $self->classify_form_inputs($params);
139 ($validated, $errors) = $self->validate_all($r, $opts);
143 return bless { _cgi_update_error => $errors }, $self;
146 # Insert all the data
147 my ($obj, $err ) = $self->_do_create_all($validated);
149 return bless { _cgi_update_error => $err }, $self;
155 =head2 update_from_cgi
157 Replicates the Class::DBI::FromCGI method of same name. It updates an object and
158 returns 1 upon success. It can take the same arguments as create_form_cgi.
159 If errors, it sets the cgi_update_errors.
163 sub update_from_cgi {
164 my ($self, $r, $opts) = @_;
165 $self->_croak( "update_from_cgi can only be called as an object method") unless ref $self;
166 my ($errors, $validated);
167 $self->{_cgi_update_error} = {};
168 $opts->{updating} = 1;
170 # FromCGI interface compatibility
171 if ($r->isa('CGI::Untaint')) {
172 # REHASH the $opts for updating:
173 # 1: we ignore any fields we dont have parmeter for. (safe ?)
174 # 2: we dont want to update fields unless they change
176 my @ignore = @{$opts->{ignore} || []};
177 push @ignore, $self->primary_column->name;
178 my $raw = $r->raw_data;
179 #print "*** raw data ****" . Dumper($raw);
180 foreach my $field ($self->columns) {
181 #print "*** field is $field ***\n";
182 if (not defined $raw->{$field}) {
183 push @ignore, $field->name;
184 #print "*** ignoring $field because it is not present ***\n";
187 # stupid inflation , cant get at raw db value easy, must call
188 # deflate ***FIXME****
189 my $cur_val = ref $self->$field ? $self->$field->id : $self->$field;
190 if ($raw->{$field} eq $cur_val) {
191 #print "*** ignoring $field because unchanged ***\n";
192 push @ignore, "$field";
195 $opts->{ignore} = \@ignore;
196 ($validated, $errors) = $self->validate_inputs($r,$opts);
198 my $params = $opts->{params} || $r->params;
199 $opts->{params} = $self->classify_form_inputs($params);
200 ($validated, $errors) = $self->validate_all($r, $opts);
201 #print "*** errors for validate all ****" . Dumper($errors);
205 #print "*** we have errors ****" . Dumper($errors);
206 $self->{_cgi_update_error} = $errors;
210 # Update all the data
211 my ($obj, $err ) = $self->_do_update_all($validated);
213 $self->{_cgi_update_error} = $err;
219 =head2 add_to_from_cgi
221 $obj->add_to_from_cgi($r[, $opts]);
223 Like add_to_* for has_many relationships but will add nay objects it can
224 figure out from the data. It returns a list of objects it creates or nothing
225 on error. Call cgi_update_errors with the calling object to get errors.
226 Fatal errors are in the respective "FATAL" key.
230 sub add_to_from_cgi {
231 my ($self, $r, $opts) = @_;
232 $self->_croak( "add_to_from_cgi can only be called as an object method")
234 my ($errors, $validated, @created);
236 my $params = $opts->{params} || $r->params;
237 $opts->{params} = $self->classify_form_inputs($params);
238 ($validated, $errors) = $self->validate_all($r, $opts);
242 $self->{_cgi_update_error} = $errors;
246 # Insert all the data
247 foreach my $hm (keys %$validated) {
248 my ($obj, $errs) = $self->_create_related($hm, $validated->{$hm});
252 $errors->{$hm} = $errs;
257 $self->{_cgi_update_error} = $errors;
269 Validates (untaints) a hash of possibly mixed table data.
270 Returns validated and errors ($validated, $errors).
271 If no errors then undef in that spot.
276 my ($self, $r, $opts) = @_;
277 my $class = ref $self || $self;
278 my $classified = $opts->{params};
279 my $updating = $opts->{updating};
281 # Base case - validate this classes data
282 $opts->{all} ||= eval{ $r->config->{$self->table}{all_cols} } || [$self->columns('All')];
283 $opts->{required} ||= eval { $r->config->{$self->table}{required_cols} || $self->required_columns } || [];
284 my $ignore = $opts->{ignore} || eval{ $r->config->{$self->table}{ignore_cols} } || [];
285 push @$ignore, $self->primary_column->name if $updating;
287 # Ignore hashes of foreign inputs. This takes care of required has_a's
288 # for main object that we have foreign inputs for.
289 foreach (keys %$classified) {
290 push @$ignore, $_ if ref $classified->{$_} eq 'HASH';
292 $opts->{ignore} = $ignore;
293 my $h = $Untainter->new($classified);
294 my ($validated, $errs) = $self->validate_inputs($h, $opts);
296 # Validate all foreign input
298 #warn "Classified data is " . Dumper($classified);
299 foreach my $field (keys %$classified) {
300 if (ref $classified->{$field} eq "HASH") {
301 my $data = $classified->{$field};
303 my @usr_entered_vals = ();
304 foreach ( values %$data ) {
305 push @usr_entered_vals, $_ if $_ ne '';
309 # IF we have some inputs for the related
310 if ( @usr_entered_vals ) {
311 # We need to ignore us if we are a required has_a in this foreign class
312 my $rel_meta = $self->related_meta($r, $field);
313 my $fclass = $rel_meta->{foreign_class};
314 my $fmeta = $fclass->meta_info('has_a');
316 if ($fmeta->{$_}{foreign_class} eq $class) {
320 my ($valid, $ferrs) = $fclass->validate_all($r,
321 {params => $data, updating => $updating, ignore => $ignore } );
323 $errs->{$field} = $ferrs if $ferrs;
324 $validated->{$field} = $valid;
327 # Check this foreign object is not requeired
328 my %req = map { $_ => 1 } $opts->{required};
330 $errs->{$field}{FATAL} = "This is required. Please enter the required fields in this section."
335 #warn "Validated inputs are " . Dumper($validated);
336 undef $errs unless keys %$errs;
337 return ($validated, $errs);
342 =head2 validate_inputs
344 $self->validate_inputs($h, $opts);
346 This is the main validation method to validate inputs for a single class.
347 Most of the time you use validate_all.
349 Returns validated and errors.
351 If no errors then undef in that slot.
353 Note: This method is currently experimental (in 2.11) and may be subject to change
358 sub validate_inputs {
359 my ($self, $h, $opts) = @_;
360 my $updating = $opts->{updating};
361 my %required = map { $_ => 1 } @{$opts->{required}};
363 $seen{$_}++ foreach @{$opts->{ignore}};
366 $opts->{all} = [ $self->columns ] unless @{$opts->{all} || [] } ;
367 foreach my $field (@{$opts->{required}}, @{$opts->{all}}) {
368 next if $seen{$field}++;
369 my $type = $self->untaint_type($field) or
370 do { warn "No untaint type for $self 's field $field. Ignoring.";
373 my $value = $h->extract("-as_$type" => $field);
376 # Required field error
377 if ($required{$field} and !ref($value) and $err =~ /^No input for/) {
378 $errors->{$field} = "You must supply '$field'"
381 # 1: No inupt entered
382 if ($err =~ /^No input for/) {
383 # A : Updating -- set the field to undef or ''
385 $fields->{$field} = eval{$self->column_nullable($field)} ?
388 # B : Creating -- dont set a value and RDMS will put default
391 # 2: A real untaint error -- just set the error
392 elsif ($err !~ /^No parameter for/) {
393 $errors->{$field} = $err;
396 $fields->{$field} = $value
399 undef $errors unless keys %$errors;
400 return ($fields, $errors);
408 # Untaints and Creates objects from hashed params.
409 # Returns parent object and errors ($obj, $errors).
410 # If no errors, then undef in that slot.
412 my ($self, $validated) = @_;
413 my $class = ref $self || $self;
414 my ($errors, $accssr);
416 # Separate out related objects' data from main hash
418 foreach (keys %$validated) {
419 $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
421 # Make has_own/a rel type objects and put id in parent's data hash
422 # foreach $accssr (keys %related) {
423 # my $rel_meta = $self->related_meta('r', $accssr);
424 # $self->_croak("No relationship found for $accssr to $class.")
426 # my $rel_type = $rel_meta->{name};
427 # if ($rel_type =~ /(^has_own$|^has_a$)/) {
428 # my $fclass= $rel_meta->{foreign_class};
429 # my ($rel_obj, $errs) = $fclass->_do_create_all($related{$accssr});
430 # # put id in parent's data hash
431 # if (not keys %$errs) {
432 # $validated->{$accssr} = $rel_obj->id;
434 # $errors->{$accssr} = $errs;
436 # delete $related{$accssr}; # done with this
440 # Make main object -- base case
441 #warn "\n*** validated data is " . Dumper($validated). "***\n";
442 my $me_obj = eval { $self->create($validated) };
444 warn "Just failed making a " . $self. " FATAL Error is $@"
445 if (eval{$self->model_debug});
446 $errors->{FATAL} = $@;
447 return (undef, $errors);
450 if (eval{$self->model_debug}) {
452 warn "Just made a $self : $me_obj ( " . $me_obj->id . ")";
454 warn "Just failed making a " . $self. " FATAL Error is $@" if not $me_obj;
458 # Make other related (must_have, might_have, has_many etc )
459 foreach $accssr ( keys %related ) {
460 my ($rel_obj, $errs) =
461 $me_obj->_create_related($accssr, $related{$accssr});
462 $errors->{$accssr} = $errs if $errs;
465 #warn "Errors are " . Dumper($errors);
467 undef $errors unless keys %$errors;
468 return ($me_obj, $errors);
476 # Updates objects from hashed untainted data
480 my ($self, $validated) = @_;
481 my ($errors, $accssr);
483 # Separate out related objects' data from main hash
485 foreach (keys %$validated) {
486 $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
489 # set does not work with IsA right now so we set each col individually
490 #$self->set(%$validated);
491 my $old = $self->autoupdate(0);
492 for (keys %$validated) {
493 $self->$_($validated->{$_});
496 $self->autoupdate($old);
499 foreach $accssr (keys %related) {
500 my $fobj = $self->$accssr;
501 my $validated = $related{$accssr};
503 my $old = $fobj->autoupdate(0);
504 for (keys %$validated) {
505 $fobj->$_($validated->{$_});
508 $fobj->autoupdate($old);
511 $fobj = $self->_create_related($accssr, $related{$accssr});
522 # Creates and automatically relates newly created object to calling object
523 # Returns related object and errors ($obj, $errors).
524 # If no errors, then undef in that slot.
526 sub _create_related {
527 # self is object or class, accssr is accssr to relationship, params are
528 # data for relobject, and created is the array ref to store objs we
530 my ( $self, $accssr, $params, $created ) = @_;
531 $self->_croak ("Can't make related object without a parent $self object")
534 my $rel_meta = $self->related_meta('r',$accssr);
536 $self->_croak("No relationship for $accssr in " . ref($self));
538 my $rel_type = $rel_meta->{name};
539 my $fclass = $rel_meta->{foreign_class};
540 #warn " Dumper of meta is " . Dumper($rel_meta);
545 # Set up params for might_have, has_many, etc
546 if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
548 # Foreign Key meta data not very standardized in CDBI
549 my $fkey= $rel_meta->{args}{foreign_key} || $rel_meta->{foreign_column};
550 unless ($fkey) { die " Could not determine foreign key for $fclass"; }
551 my %data = (%$params, $fkey => $self->id);
552 %data = ( %data, %{$rel_meta->{args}->{constraint} || {}} );
553 #warn "Data is " . Dumper(\%data);
554 ($rel, $errs) = $fclass->_do_create_all(\%data, $created);
557 ($rel, $errs) = $fclass->_do_create_all($params, $created);
559 $self->$accssr($rel->id);
563 return ($rel, $errs);
569 =head2 classify_form_inputs
571 $self->classify_form_inputs($params[, $delimiter]);
573 Foreign inputs are inputs that have data for a related table.
574 They come named so we can tell which related class they belong to.
575 This assumes the form : $accessor . $delimeter . $column recursively
576 classifies them into hashes. It returns a hashref.
580 sub classify_form_inputs {
581 my ($self, $params, $delimiter) = @_;
584 $delimiter ||= $self->foreign_input_delimiter;
585 foreach my $input_name (keys %$params) {
586 my @accssrs = split /$delimiter/, $input_name;
587 my $col_name = pop @accssrs;
588 $bottom_level = \%hashed;
589 while ( my $a = shift @accssrs ) {
590 $bottom_level->{$a} ||= {};
591 $bottom_level = $bottom_level->{$a}; # point to bottom level
593 # now insert parameter at bottom level keyed on col name
594 $bottom_level->{$col_name} = $params->{$input_name};
599 sub _untaint_handlers {
600 my ($me, $them) = @_;
601 return () unless $them->can('__untaint_types');
602 my %type = %{ $them->__untaint_types || {} };
604 @h{ @{ $type{$_} } } = ($_) x @{ $type{$_} } foreach keys %type;
608 sub _column_type_for {
612 varchar => 'printable',
615 tinyint => 'integer',
616 smallint => 'integer',
617 mediumint => 'integer',
619 integer => 'integer',
624 return $map{$type} || "";
633 Peter Speltz, Aaron Trevena
635 =head1 AUTHORS EMERITUS
642 * add_to_from_cgi, search_from_cgi
643 * complete documentation
644 * ensure full backward compatibility with Class::DBI::FromCGI
646 =head1 BUGS and QUERIES
648 Please direct all correspondence regarding this module to:
651 =head1 COPYRIGHT AND LICENSE
653 Copyright 2003-2004 by Peter Speltz
655 This library is free software; you can redistribute it and/or modify
656 it under the same terms as Perl itself.
660 L<Class::DBI>, L<Class::DBI::FromCGI>