lib/Maypole/Model/CDBI/FromCGI.pm

   1 package Maypole::Model::CDBI::FromCGI;
   2 use strict;
   3 use warnings;
   4
   5 =head1 NAME
   6
   7 Maypole::Model:CDBI::FromCGI - Validate form input and populate Model objects
   8
   9 =head1 SYNOPSIS
  10
  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
  15
  16   $obj->update_from_cgi($r);
  17   $obj->update_from_cgi($h, $options);
  18
  19   $obj = $obj->add_to_from_cgi($r);
  20   $obj = $obj->add_to_from_cgi($r, { params => {...} } );
  21
  22   # This does not work like in CDBI::FromCGI and probably never will :
  23   # $class->update_from_cgi($h, @columns);
  24
  25
  26 =head1 DESCRIPTION
  27
  28 Provides a way to validate form input and populate Model Objects, based
  29 on Class::DBI::FromCGI.
  30
  31 =cut
  32
  33
  34 # The base base model class for apps
  35 # provides good search and create functions
  36
  37 use base qw(Exporter);
  38 use CGI::Untaint;
  39 use Maypole::Constants;
  40 use CGI::Untaint::Maypole;
  41 our $Untainter = 'CGI::Untaint::Maypole';
  42
  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/;
  46
  47
  48
  49 use Data::Dumper; # for debugging
  50
  51 =head1 METHODS
  52
  53 =head2 untaint_columns
  54
  55 Replicates Class::DBI::FromCGI method of same name :
  56
  57   __PACKAGE__->untaint_columns(
  58     printable => [qw/Title Director/],
  59     integer   => [qw/DomesticGross NumExplodingSheep],
  60     date      => [qw/OpeningDate/],
  61   );
  62
  63 =cut
  64
  65 sub untaint_columns {
  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)) {
  72         $types{$type} = $ref;
  73     }
  74     $class->__untaint_types(\%types);
  75 }
  76
  77 =head2 untaint_type
  78
  79   gets the  untaint type for a column as set in "untaint_types"
  80
  81 =cut
  82
  83 # get/set untaint_type for a column
  84 sub untaint_type {
  85     my ($class, $field, $new_type) = @_;
  86     my %handler = __PACKAGE__->_untaint_handlers($class);
  87     return $handler{$field} if $handler{$field};
  88     my $handler = eval {
  89         local $SIG{__WARN__} = sub { };
  90         my $type = $class->column_type($field) or die;
  91         _column_type_for($type);
  92     };
  93     return $handler || undef;
  94 }
  95
  96 =head2 cgi_update_errors
  97
  98 Returns errors that ocurred during an operation.
  99
 100 =cut
 101
 102 sub cgi_update_errors { %{ shift->{_cgi_update_error} || {} } }
 103
 104
 105
 106 =head2 create_from_cgi
 107
 108 Based on the same method in Class::DBI::FromCGI.
 109
 110 Creates  multiple objects  from a  cgi form.
 111 Errors are returned in cgi_update_errors
 112
 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)
 115 as the first arg.
 116
 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.
 119 Options can be :
 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)
 124
 125 =cut
 126
 127 sub create_from_cgi {
 128   my ($self, $r, $opts) = @_;
 129   $self->_croak( "create_from_cgi can only be called as a class method")
 130     if ref $self;
 131   my ($errors, $validated);
 132
 133
 134   if ($r->isa('CGI::Untaint')) { # FromCGI interface compatibility
 135     ($validated, $errors) = $self->validate_inputs($r,$opts);
 136   } else {
 137     my $params = $opts->{params} || $r->params;
 138     $opts->{params} = $self->classify_form_inputs($params);
 139     ($validated, $errors) = $self->validate_all($r, $opts);
 140   }
 141
 142   if (keys %$errors) {
 143     return bless { _cgi_update_error => $errors }, $self;
 144   }
 145
 146   # Insert all the data
 147   my ($obj, $err ) = $self->_do_create_all($validated);
 148   if ($err) {
 149     return bless { _cgi_update_error => $err }, $self;
 150   }
 151   return $obj;
 152 }
 153
 154
 155 =head2 update_from_cgi
 156
 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.
 160
 161 =cut
 162
 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;
 169
 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
 175
 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";
 185                         next;
 186         }
 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";
 193         }
 194     }
 195     $opts->{ignore} = \@ignore;
 196     ($validated, $errors) = $self->validate_inputs($r,$opts);
 197   } else {
 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);
 202   }
 203
 204   if (keys %$errors) {
 205     #print "*** we have errors   ****" . Dumper($errors);
 206     $self->{_cgi_update_error} = $errors;
 207     return;
 208   }
 209
 210   # Update all the data
 211   my ($obj, $err ) = $self->_do_update_all($validated);
 212   if ($err) {
 213     $self->{_cgi_update_error} = $err;
 214     return;
 215   }
 216   return 1;
 217 }
 218
 219 =head2 add_to_from_cgi
 220
 221 $obj->add_to_from_cgi($r[, $opts]);
 222
 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.
 227
 228 =cut
 229
 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")
 233     unless ref $self;
 234   my ($errors, $validated, @created);
 235
 236   my $params = $opts->{params} || $r->params;
 237   $opts->{params} = $self->classify_form_inputs($params);
 238   ($validated, $errors) = $self->validate_all($r, $opts);
 239
 240
 241   if (keys %$errors) {
 242     $self->{_cgi_update_error} = $errors;
 243         return;
 244   }
 245
 246   # Insert all the data
 247   foreach my $hm (keys %$validated) {
 248         my ($obj, $errs) = $self->_create_related($hm, $validated->{$hm});
 249         if (not $errs) {
 250                 push @created, $obj;
 251         }else {
 252                 $errors->{$hm} = $errs;
 253         }
 254   }
 255
 256   if (keys %$errors) {
 257     $self->{_cgi_update_error} = $errors;
 258         return;
 259   }
 260
 261   return @created;
 262 }
 263
 264
 265
 266
 267 =head2 validate_all
 268
 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.
 272
 273 =cut
 274
 275 sub validate_all {
 276   my ($self, $r, $opts) = @_;
 277   my $class = ref $self || $self;
 278   my $classified = $opts->{params};
 279   my $updating   = $opts->{updating};
 280
 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;
 286
 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';
 291   }
 292   $opts->{ignore} = $ignore;
 293   my $h = $Untainter->new($classified);
 294   my ($validated, $errs) = $self->validate_inputs($h, $opts);
 295
 296   # Validate all foreign input
 297
 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};
 302           my $ignore = [];
 303       my @usr_entered_vals = ();
 304       foreach ( values %$data ) {
 305                 push @usr_entered_vals, $_  if $_  ne '';
 306       }
 307
 308       # filled in values
 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');
 315                 for (keys %$fmeta) {
 316                         if ($fmeta->{$_}{foreign_class} eq $class) {
 317                                 push @$ignore, $_;
 318                         }
 319                 }
 320                 my ($valid, $ferrs) = $fclass->validate_all($r,
 321                 {params => $data, updating => $updating, ignore => $ignore } );
 322
 323                 $errs->{$field} = $ferrs if $ferrs;
 324                 $validated->{$field} = $valid;
 325
 326       } else {
 327                 # Check this foreign object is not requeired
 328                 my %req = map { $_ => 1 } $opts->{required};
 329                 if ($req{$field}) {
 330                         $errs->{$field}{FATAL} = "This is required. Please enter the required fields in this section."
 331                         }
 332                 }
 333         }
 334   }
 335   #warn "Validated inputs are " . Dumper($validated);
 336   undef $errs unless keys %$errs;
 337   return ($validated, $errs);
 338 }
 339
 340
 341
 342 =head2 validate_inputs
 343
 344 $self->validate_inputs($h, $opts);
 345
 346 This is the main validation method to validate inputs for a single class.
 347 Most of the time you use validate_all.
 348
 349 Returns validated and errors.
 350
 351 If no errors then undef in that slot.
 352
 353 Note: This method is currently experimental (in 2.11) and may be subject to change
 354 without notice.
 355
 356 =cut
 357
 358 sub validate_inputs {
 359   my ($self, $h, $opts) = @_;
 360   my $updating = $opts->{updating};
 361   my %required = map { $_ => 1 } @{$opts->{required}};
 362   my %seen;
 363   $seen{$_}++ foreach @{$opts->{ignore}};
 364   my $errors    = {};
 365   my $fields    = {};
 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.";
 371            next;
 372          };
 373     my $value = $h->extract("-as_$type" => $field);
 374     my $err = $h->error;
 375
 376     # Required field error
 377     if ($required{$field} and !ref($value) and $err =~ /^No input for/) {
 378       $errors->{$field} = "You must supply '$field'"
 379     } elsif ($err) {
 380
 381       # 1: No inupt entered
 382       if ($err =~ /^No input for/) {
 383                                 # A : Updating -- set the field to undef or ''
 384         if ($updating) {
 385           $fields->{$field} = eval{$self->column_nullable($field)} ?
 386             undef : '';
 387         }
 388                                 # B : Creating -- dont set a value and RDMS will put default
 389       }
 390
 391       # 2: A real untaint error -- just set the error
 392       elsif ($err !~ /^No parameter for/) {
 393         $errors->{$field} =  $err;
 394       }
 395     } else {
 396       $fields->{$field} = $value
 397     }
 398   }
 399   undef $errors unless keys %$errors;
 400   return ($fields, $errors);
 401 }
 402
 403
 404 ##################
 405 # _do_create_all #
 406 ##################
 407
 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.
 411 sub _do_create_all {
 412   my ($self, $validated) = @_;
 413   my $class = ref $self  || $self;
 414   my ($errors, $accssr);
 415
 416   # Separate out related objects' data from main hash
 417   my %related;
 418   foreach (keys %$validated) {
 419     $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
 420   }
 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.")
 425 #      unless $rel_meta;
 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;
 433 #      } else {
 434 #       $errors->{$accssr} = $errs;
 435 #      }
 436 #      delete $related{$accssr}; # done with this
 437 #    }
 438 #  }
 439
 440   # Make main object -- base case
 441   #warn "\n*** validated data is " . Dumper($validated). "***\n";
 442   my $me_obj  = eval { $self->create($validated) };
 443   if ($@) {
 444         warn "Just failed making a " . $self. " FATAL Error is $@"
 445                 if (eval{$self->model_debug});
 446     $errors->{FATAL} = $@;
 447     return (undef, $errors);
 448   }
 449
 450   if (eval{$self->model_debug}) {
 451     if ($me_obj) {
 452       warn "Just made a $self : $me_obj ( " . $me_obj->id . ")";
 453     } else {
 454       warn "Just failed making a " . $self. " FATAL Error is $@" if not $me_obj;
 455     }
 456   }
 457
 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;
 463
 464   }
 465   #warn "Errors are " . Dumper($errors);
 466
 467   undef $errors unless keys %$errors;
 468   return ($me_obj, $errors);
 469 }
 470
 471
 472 ##################
 473 # _do_update_all #
 474 ##################
 475
 476 #  Updates objects from hashed untainted data
 477 # Returns 1
 478
 479 sub _do_update_all {
 480         my ($self, $validated) = @_;
 481         my ($errors, $accssr);
 482
 483         #  Separate out related objects' data from main hash
 484         my %related;
 485         foreach (keys %$validated) {
 486                 $related{$_}= delete $validated->{$_} if ref $validated->{$_} eq 'HASH';
 487         }
 488         # Update main obj
 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->{$_});
 494         }
 495         $self->update;
 496         $self->autoupdate($old);
 497
 498         # Update related
 499         foreach $accssr (keys %related) {
 500                 my $fobj = $self->$accssr;
 501                 my $validated = $related{$accssr};
 502                 if ($fobj) {
 503                         my $old = $fobj->autoupdate(0);
 504                         for (keys %$validated) {
 505                                 $fobj->$_($validated->{$_});
 506                         }
 507                         $fobj->update;
 508                         $fobj->autoupdate($old);
 509                 }
 510                 else {
 511                         $fobj = $self->_create_related($accssr, $related{$accssr});
 512                 }
 513         }
 514         return 1;
 515 }
 516
 517
 518 ###################
 519 # _create_related #
 520 ###################
 521
 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.
 525
 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
 529         # create (optional).
 530         my ( $self, $accssr, $params, $created )  = @_;
 531         $self->_croak ("Can't make related object without a parent $self object")
 532                 unless ref $self;
 533         $created      ||= [];
 534         my  $rel_meta = $self->related_meta('r',$accssr);
 535     if (!$rel_meta) {
 536                 $self->_croak("No relationship for $accssr in " . ref($self));
 537         }
 538         my $rel_type  = $rel_meta->{name};
 539         my $fclass    = $rel_meta->{foreign_class};
 540         #warn " Dumper of meta is " . Dumper($rel_meta);
 541
 542
 543         my ($rel, $errs);
 544
 545         # Set up params for might_have, has_many, etc
 546         if ($rel_type ne 'has_own' and $rel_type ne 'has_a') {
 547
 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);
 555         }
 556         else {
 557             ($rel, $errs) =  $fclass->_do_create_all($params, $created);
 558                 unless ($errs) {
 559                         $self->$accssr($rel->id);
 560                         $self->update;
 561                 }
 562         }
 563         return ($rel, $errs);
 564 }
 565
 566
 567
 568
 569 =head2  classify_form_inputs
 570
 571 $self->classify_form_inputs($params[, $delimiter]);
 572
 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.
 577
 578 =cut
 579
 580 sub classify_form_inputs {
 581         my ($self, $params, $delimiter) = @_;
 582         my %hashed = ();
 583         my $bottom_level;
 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
 592                 }
 593                 # now insert parameter at bottom level keyed on col name
 594                 $bottom_level->{$col_name} = $params->{$input_name};
 595         }
 596         return  \%hashed;
 597 }
 598
 599 sub _untaint_handlers {
 600     my ($me, $them) = @_;
 601     return () unless $them->can('__untaint_types');
 602     my %type = %{ $them->__untaint_types || {} };
 603     my %h;
 604     @h{ @{ $type{$_} } } = ($_) x @{ $type{$_} } foreach keys %type;
 605     return %h;
 606 }
 607
 608 sub _column_type_for {
 609     my $type = lc shift;
 610     $type =~ s/\(.*//;
 611     my %map = (
 612         varchar   => 'printable',
 613         char      => 'printable',
 614         text      => 'printable',
 615         tinyint   => 'integer',
 616         smallint  => 'integer',
 617         mediumint => 'integer',
 618         int       => 'integer',
 619         integer   => 'integer',
 620         bigint    => 'integer',
 621         year      => 'integer',
 622         date      => 'date',
 623     );
 624     return $map{$type} || "";
 625 }
 626
 627 =head1 MAINTAINER
 628
 629 Maypole Developers
 630
 631 =head1 AUTHORS
 632
 633 Peter Speltz, Aaron Trevena
 634
 635 =head1 AUTHORS EMERITUS
 636
 637 Tony Bowden
 638
 639 =head1 TODO
 640
 641 * Tests
 642 * add_to_from_cgi, search_from_cgi
 643 * complete documentation
 644 * ensure full backward compatibility with Class::DBI::FromCGI
 645
 646 =head1 BUGS and QUERIES
 647
 648 Please direct all correspondence regarding this module to:
 649  Maypole list.
 650
 651 =head1 COPYRIGHT AND LICENSE
 652
 653 Copyright 2003-2004 by Peter Speltz
 654
 655 This library is free software; you can redistribute it and/or modify
 656 it under the same terms as Perl itself.
 657
 658 =head1 SEE ALSO
 659
 660 L<Class::DBI>, L<Class::DBI::FromCGI>
 661
 662 =cut
 663
 664 1;
 665
 666