]>
Dogcows Code - chaz/p5-CGI-Ex/blob - lib/CGI/Ex/Validate.pm
77ebd2a4ea7c7f00160d0d3bde73fb84ab1cb6f3
1 package CGI
::Ex
::Validate
;
5 CGI::Ex::Validate - another form validator - but it does javascript in parallel
9 ###----------------------------------------------------------------###
10 # Copyright 2006 - Paul Seamons #
11 # Distributed under the Perl Artistic License without warranty #
12 ###----------------------------------------------------------------###
28 $QR_EXTRA = qr/^(\w+_error|as_(array|string|hash)_\w+|no_\w+)/;
29 @UNSUPPORTED_BROWSERS = (qr/MSIE\s+5.0\d/i);
33 ###----------------------------------------------------------------###
36 my $class = shift || __PACKAGE__
;
37 my $self = (@_ && ref($_[0])) ? shift : {@_};
39 ### allow for global defaults
40 foreach (keys %DEFAULT_OPTIONS) {
41 $self->{$_} = $DEFAULT_OPTIONS{$_} if ! exists $self->{$_};
44 return bless $self, $class;
47 ###----------------------------------------------------------------###
51 return $self->{cgix
} ||= do {
57 ### the main validation routine
59 my $self = (! ref($_[0])) ? shift-
>new # $class->validate
60 : UNIVERSAL
::isa
($_[0], __PACKAGE__
) ? shift # $self->validate
61 : __PACKAGE__-
>new; # &validate
62 my $form = shift || die "Missing form hash";
63 my $val_hash = shift || die "Missing validation hash";
64 my $what_was_validated = shift; # allow for extra arrayref that stores what was validated
66 ### turn the form into a form if it is really a CGI object
68 die "Invalid form hash or cgi object";
69 } elsif(! UNIVERSAL
::isa
($form,'HASH')) {
70 local $self->{cgi_object
} = $form;
71 $form = $self->cgix->get_form($form);
74 ### get the validation - let get_validation deal with types
75 ### if a ref is not passed - assume it is a filename
76 $val_hash = $self->get_validation($val_hash);
78 ### allow for validation passed as single group hash, single group array,
79 ### or array of group hashes or group arrays
83 my $group_order = UNIVERSAL
::isa
($val_hash,'HASH') ? [$val_hash] : $val_hash;
84 foreach my $group_val (@$group_order) {
85 die "Validation groups must be a hashref" if ! UNIVERSAL
::isa
($group_val,'HASH');
86 my $title = $group_val->{'group title'};
87 my $validate_if = $group_val->{'group validate_if'};
89 ### only validate this group if it is supposed to be checked
90 next if $validate_if && ! $self->check_conditional($form, $validate_if);
91 push @USED_GROUPS, $group_val;
93 ### If the validation items were not passed as an arrayref.
94 ### Look for a group order and then fail back to the keys of the group.
95 ### We will keep track of what was added using %found - the keys will
96 ### be the hash signatures of the field_val hashes (ignore the hash internals).
99 foreach (sort keys %$group_val) {
100 /^(group|general)\s+(\w+)/ ? push(@group_keys, [$1, $2, $_]) : push(@field_keys, $_);
102 my $fields = $group_val->{'group fields'};
103 if ($fields) { # if I passed group fields array - use it
104 die "'group fields' must be an arrayref" if ! UNIVERSAL
::isa
($fields,'ARRAY');
105 } else { # other wise - create our own array
107 if (my $order = $group_val->{'group order'} || \
@field_keys) {
108 die "Validation 'group order' must be an arrayref" if ! UNIVERSAL
::isa
($order,'ARRAY');
109 foreach my $field (@$order) {
110 my $field_val = exists($group_val->{$field}) ? $group_val->{$field}
111 : ($field eq 'OR') ? 'OR' : die "No element found in group for $field";
112 if (ref $field_val && ! $field_val->{'field'}) {
113 $field_val = { %$field_val, 'field' => $field }; # copy the values to add the key
115 push @fields, $field_val;
121 ### double check which field_vals have been used so far
122 ### add any remaining field_vals from the order
123 ### this is necessary for items that weren't in group fields or group order
124 my %found = map {$_->{'field'} => 1} @$fields;
125 foreach my $field (@field_keys) {
126 next if $found{$field};
127 my $field_val = $group_val->{$field};
128 die "Found a nonhashref value on field $field" if ! UNIVERSAL
::isa
($field_val, 'HASH');
129 $field_val->{'field'} = $field if ! defined $field_val->{'field'};
130 push @$fields, $field_val;
133 ### Finally we have our arrayref of hashrefs that each have their 'field' key
134 ### now lets do the validation
137 my $hold_error; # hold the error for a moment - to allow for an "Or" operation
138 foreach (my $i = 0; $i <= $#$fields; $i ++) {
139 my $ref = $fields->[$i];
140 if (! ref($ref) && $ref eq 'OR') {
141 $i ++ if $found; # if found skip the OR altogether
146 die "Missing field key during normal validation" if ! $ref->{'field'};
147 local $ref->{'was_validated'} = 1;
148 my @err = $self->validate_buddy($form, $ref->{'field'}, $ref);
149 if (delete($ref->{'was_validated'}) && $what_was_validated) {
150 push @$what_was_validated, $ref;
153 ### test the error - if errors occur allow for OR - if OR fails use errors from first fail
155 if ($i < $#$fields && ! ref($fields->[$i + 1]) && $fields->[$i + 1] eq 'OR') {
158 push @errors, $hold_error ? @$hold_error : @err;
165 push(@errors, @$hold_error) if $hold_error; # allow for final OR to work
167 ### add on errors as requested
168 if ($#errors != -1) {
169 push @ERRORS, $title if $title;
170 push @ERRORS, @errors;
173 ### add on general options, and group options if errors in group occurred
174 foreach (@group_keys) {
175 my ($type, $short_key, $full_key) = @$_;
176 next if $type eq 'group' && ($#errors == -1 || $short_key =~ /^(field|order|title)$/);
177 $EXTRA{$short_key} = $group_val->{$full_key};
181 ### store any extra items from self
182 $EXTRA{$_} = $self->{$_} for grep {/$QR_EXTRA/o} keys %$self;
184 ### allow for checking for unused keys
185 if ($EXTRA{no_extra_fields
}) {
186 my $which = ($EXTRA{no_extra_fields
} =~ /used/i) ? 'used' : 'all';
187 my $ref = ($which eq 'all') ? $val_hash : \
@USED_GROUPS;
188 my $keys = $self->get_validation_keys($ref);
189 foreach my $key (sort keys %$form) {
190 next if $keys->{$key};
191 push @ERRORS, [$key, 'no_extra_fields', {}, undef];
195 ### return what they want
196 if ($#ERRORS != -1) {
197 my $err_obj = $self->new_error(\
@ERRORS, \
%EXTRA);
198 die $err_obj if $EXTRA{'raise_error'};
201 return wantarray ? () : undef;
207 return CGI
::Ex
::Validate
::Error-
>new(@_);
210 ### allow for optional validation on groups and on individual items
211 sub check_conditional
{
212 my ($self, $form, $ifs, $N_level, $ifs_match) = @_;
215 $N_level ++; # prevent too many recursive checks
217 ### can pass a single hash - or an array ref of hashes
219 die "Need reference passed to check_conditional";
220 } elsif (! ref($ifs)) {
222 } elsif (UNIVERSAL
::isa
($ifs,'HASH')) {
226 ### run the if options here
227 ### multiple items can be passed - all are required unless OR is used to separate
229 foreach (my $i = 0; $i <= $#$ifs; $i ++) {
230 my $ref = $ifs->[$i];
233 $i ++ if $found; # if found skip the OR altogether
237 if ($ref =~ s/^\s*!\s*//) {
238 $ref = {field
=> $ref, max_in_set
=> "0 of $ref"};
240 $ref = {field
=> $ref, required
=> 1};
246 ### get the field - allow for custom variables based upon a match
247 my $field = $ref->{'field'} || die "Missing field key during validate_if (possibly used a reference to a main hash *foo -> &foo)";
248 $field =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
250 my @err = $self->validate_buddy($form, $field, $ref, $N_level);
251 $found = 0 if scalar @err;
257 ### this is where the main checking goes on
260 my ($form, $field, $field_val, $N_level, $ifs_match) = @_;
262 $N_level ++; # prevent too many recursive checks
263 die "Max dependency level reached $N_level" if $N_level > 10;
266 my $types = [sort keys %$field_val];
268 ### allow for not running some tests in the cgi
269 if ($field_val->{'exclude_cgi'}) {
270 delete $field_val->{'was_validated'};
271 return wantarray ? @errors : $#errors + 1;
274 ### allow for field names that contain regular expressions
275 if ($field =~ m/^(!\s*|)m([^\s\w])(.*)\2([eigsmx]*)$/s) {
276 my ($not,$pat,$opt) = ($1,$3,$4);
278 die "The e option cannot be used on validation keys on field $field" if $opt =~ /e/;
279 foreach my $_field (sort keys %$form) {
280 next if ($not && $_field =~ m/(?$opt:$pat)/) || (! $not && $_field !~ m/(?$opt:$pat)/);
281 my @match = (undef, $1, $2, $3, $4, $5); # limit to the matches
282 push @errors, $self->validate_buddy($form, $_field, $field_val, $N_level, \
@match);
284 return wantarray ? @errors : $#errors + 1;
287 my $values = UNIVERSAL
::isa
($form->{$field},'ARRAY') ? $form->{$field} : [$form->{$field}];
288 my $n_values = $#$values + 1;
290 ### allow for default value
291 if (exists $field_val->{'default'}) {
292 if ($n_values == 0 || ($n_values == 1 && (! defined($values->[0]) || ! length($values->[0])))) {
293 $form->{$field} = $values->[0] = $field_val->{'default'};
297 ### allow for a few form modifiers
299 foreach my $value (@$values) {
300 next if ! defined $value;
301 if (! $field_val->{'do_not_trim'}) { # whitespace
306 if ($field_val->{'to_upper_case'}) { # uppercase
309 } elsif ($field_val->{'to_lower_case'}) { # lowercase
314 # allow for inline specified modifications (ie s/foo/bar/)
315 foreach my $type (grep {/^replace_?\d*$/} @$types) {
316 my $ref = UNIVERSAL
::isa
($field_val->{$type},'ARRAY') ? $field_val->{$type}
317 : [split(/\s*\|\|\s*/,$field_val->{$type})];
318 foreach my $rx (@$ref) {
319 if ($rx !~ m/^\s*s([^\s\w])(.+)\1(.*)\1([eigsmx]*)$/s) {
320 die "Not sure how to parse that replace ($rx)";
322 my ($pat, $swap, $opt) = ($2, $3, $4);
323 die "The e option cannot be used in swap on field $field" if $opt =~ /e/;
324 my $global = $opt =~ s/g//g;
327 foreach my $value (@$values) {
328 $value =~ s
{(?$opt:$pat)}{
329 my @match = (undef, $1, $2, $3, $4, $5, $6); # limit on the number of matches
331 $copy =~ s/\$(\d+)/defined($match[$1]) ? $match[$1] : ""/ge;
333 $copy; # return of the swap
337 foreach my $value (@$values) {
338 $value =~ s
{(?$opt:$pat)}{
339 my @match = (undef, $1, $2, $3, $4, $5, $6); # limit on the number of matches
341 $copy =~ s/\$(\d+)/defined($match[$1]) ? $match[$1] : ""/ge;
343 $copy; # return of the swap
349 ### put them back into the form if we have modified it
351 if ($n_values == 1) {
352 $form->{$field} = $values->[0];
353 $self->{cgi_object
}->param(-name
=> $field, -value
=> $values->[0])
354 if $self->{cgi_object
};
356 ### values in @{ $form->{$field} } were modified directly
357 $self->{cgi_object
}->param(-name
=> $field, -value
=> $values)
358 if $self->{cgi_object
};
362 ### only continue if a validate_if is not present or passes test
365 foreach my $type (grep {/^validate_if_?\d*$/} @$types) {
367 my $ifs = $field_val->{$type};
368 my $ret = $self->check_conditional($form, $ifs, $N_level, $ifs_match);
369 $needs_val ++ if $ret;
371 if (! $needs_val && $n_vif) {
372 delete $field_val->{'was_validated'};
373 return wantarray ? @errors : $#errors + 1;
376 ### check for simple existence
377 ### optionally check only if another condition is met
378 my $is_required = $field_val->{'required'} ? 'required' : '';
379 if (! $is_required) {
380 foreach my $type (grep {/^required_if_?\d*$/} @$types) {
381 my $ifs = $field_val->{$type};
382 next if ! $self->check_conditional($form, $ifs, $N_level, $ifs_match);
383 $is_required = $type;
388 && ($n_values == 0 || ($n_values == 1 && (! defined($values->[0]) || ! length $values->[0])))) {
389 return 1 if ! wantarray;
390 push @errors, [$field, $is_required, $field_val, $ifs_match];
395 my $n = exists($field_val->{'min_values'}) ? $field_val->{'min_values'} || 0 : 0;
396 if ($n_values < $n) {
397 return 1 if ! wantarray;
398 push @errors, [$field, 'min_values', $field_val, $ifs_match];
403 $field_val->{'max_values'} = 1 if ! exists $field_val->{'max_values'};
404 $n = $field_val->{'max_values'} || 0;
405 if ($n_values > $n) {
406 return 1 if ! wantarray;
407 push @errors, [$field, 'max_values', $field_val, $ifs_match];
411 ### max_in_set and min_in_set checks
412 my @min = grep {/^min_in_set_?\d*$/} @$types;
413 my @max = grep {/^max_in_set_?\d*$/} @$types;
414 foreach ([min
=> \
@min],
416 my ($minmax, $keys) = @$_;
417 foreach my $type (@$keys) {
418 $field_val->{$type} =~ m/^\s*(\d+)(?i:\s*of)?\s+(.+)\s*$/
419 || die "Invalid in_set check $field_val->{$type}";
421 foreach my $_field (split /[\s,]+/, $2) {
422 my $ref = UNIVERSAL
::isa
($form->{$_field},'ARRAY') ? $form->{$_field} : [$form->{$_field}];
423 foreach my $_value (@$ref) {
424 $n -- if defined($_value) && length($_value);
427 if ( ($minmax eq 'min' && $n > 0)
428 || ($minmax eq 'max' && $n < 0)) {
429 return 1 if ! wantarray;
430 push @errors, [$field, $type, $field_val, $ifs_match];
436 ### at this point @errors should still be empty
437 my $content_checked; # allow later for possible untainting (only happens if content was checked)
439 ### loop on values of field
440 foreach my $value (@$values) {
442 ### allow for enum types
443 if (exists $field_val->{'enum'}) {
444 my $ref = ref($field_val->{'enum'}) ? $field_val->{'enum'} : [split(/\s*\|\|\s*/,$field_val->{'enum'})];
447 $found = 1 if defined($value) && $_ eq $value;
450 return 1 if ! wantarray;
451 push @errors, [$field, 'enum', $field_val, $ifs_match];
453 $content_checked = 1;
456 ### field equality test
457 foreach my $type (grep {/^equals_?\d*$/} @$types) {
458 my $field2 = $field_val->{$type};
459 my $not = ($field2 =~ s/^!\s*//) ? 1 : 0;
461 if ($field2 =~ m/^([\"\'])(.*)\1$/) {
463 $success = (defined($value) && $value eq $test);
464 } elsif (exists($form->{$field2}) && defined($form->{$field2})) {
465 $success = (defined($value) && $value eq $form->{$field2});
466 } elsif (! defined($value)) {
467 $success = 1; # occurs if they are both undefined
469 if ($not ? $success : ! $success) {
470 return 1 if ! wantarray;
471 push @errors, [$field, $type, $field_val, $ifs_match];
473 $content_checked = 1;
477 if (exists $field_val->{'min_len'}) {
478 my $n = $field_val->{'min_len'};
479 if (! defined($value) || length($value) < $n) {
480 return 1 if ! wantarray;
481 push @errors, [$field, 'min_len', $field_val, $ifs_match];
486 if (exists $field_val->{'max_len'}) {
487 my $n = $field_val->{'max_len'};
488 if (defined($value) && length($value) > $n) {
489 return 1 if ! wantarray;
490 push @errors, [$field, 'max_len', $field_val, $ifs_match];
494 ### now do match types
495 foreach my $type (grep {/^match_?\d*$/} @$types) {
496 my $ref = UNIVERSAL
::isa
($field_val->{$type},'ARRAY') ? $field_val->{$type}
497 : UNIVERSAL
::isa
($field_val->{$type}, 'Regexp') ? [$field_val->{$type}]
498 : [split(/\s*\|\|\s*/,$field_val->{$type})];
499 foreach my $rx (@$ref) {
500 if (UNIVERSAL
::isa
($rx,'Regexp')) {
501 if (! defined($value) || $value !~ $rx) {
502 push @errors, [$field, $type, $field_val, $ifs_match];
505 if ($rx !~ m/^(!\s*|)m([^\s\w])(.*)\2([eigsmx]*)$/s) {
506 die "Not sure how to parse that match ($rx)";
508 my ($not,$pat,$opt) = ($1,$3,$4);
510 die "The e option cannot be used on validation keys on field $field" if $opt =~ /e/;
511 if ( ( $not && ( defined($value) && $value =~ m/(?$opt:$pat)/))
512 || (! $not && (! defined($value) || $value !~ m/(?$opt:$pat)/))
514 return 1 if ! wantarray;
515 push @errors, [$field, $type, $field_val, $ifs_match];
519 $content_checked = 1;
522 ### allow for comparison checks
523 foreach my $type (grep {/^compare_?\d*$/} @$types) {
524 my $ref = UNIVERSAL
::isa
($field_val->{$type},'ARRAY') ? $field_val->{$type}
525 : [split(/\s*\|\|\s*/,$field_val->{$type})];
526 foreach my $comp (@$ref) {
529 if ($comp =~ /^\s*(>|<|[><!=]=)\s*([\d\.\-]+)\s*$/) {
530 my $val = $value || 0;
532 if ($1 eq '>' ) { $test = ($val > $2) }
533 elsif ($1 eq '<' ) { $test = ($val < $2) }
534 elsif ($1 eq '>=') { $test = ($val >= $2) }
535 elsif ($1 eq '<=') { $test = ($val <= $2) }
536 elsif ($1 eq '!=') { $test = ($val != $2) }
537 elsif ($1 eq '==') { $test = ($val == $2) }
539 } elsif ($comp =~ /^\s*(eq|ne|gt|ge|lt|le)\s+(.+?)\s*$/) {
540 my $val = defined($value) ? $value : '';
541 my ($op, $value2) = ($1, $2);
542 $value2 =~ s/^([\"\'])(.*)\1$/$2/;
543 if ($op eq 'gt') { $test = ($val gt $value2) }
544 elsif ($op eq 'lt') { $test = ($val lt $value2) }
545 elsif ($op eq 'ge') { $test = ($val ge $value2) }
546 elsif ($op eq 'le') { $test = ($val le $value2) }
547 elsif ($op eq 'ne') { $test = ($val ne $value2) }
548 elsif ($op eq 'eq') { $test = ($val eq $value2) }
551 die "Not sure how to compare \"$comp\"";
554 return 1 if ! wantarray;
555 push @errors, [$field, $type, $field_val, $ifs_match];
558 $content_checked = 1;
561 ### server side sql type
562 foreach my $type (grep {/^sql_?\d*$/} @$types) {
563 my $db_type = $field_val->{"${type}_db_type"};
564 my $dbh = ($db_type) ? $self->{dbhs
}->{$db_type} : $self->{dbh
};
566 die "Missing dbh for $type type on field $field" . ($db_type ? " and db_type $db_type" : "");
567 } elsif (UNIVERSAL
::isa
($dbh,'CODE')) {
568 $dbh = &$dbh($field, $self) || die "SQL Coderef did not return a dbh";
570 my $sql = $field_val->{$type};
571 my @args = ($value) x
$sql =~ tr/?//;
572 my $return = $dbh->selectrow_array($sql, {}, @args); # is this right - copied from O::FORMS
573 $field_val->{"${type}_error_if"} = 1 if ! defined $field_val->{"${type}_error_if"};
574 if ( (! $return && $field_val->{"${type}_error_if"})
575 || ($return && ! $field_val->{"${type}_error_if"}) ) {
576 return 1 if ! wantarray;
577 push @errors, [$field, $type, $field_val, $ifs_match];
579 $content_checked = 1;
582 ### server side custom type
583 foreach my $type (grep {/^custom_?\d*$/} @$types) {
584 my $check = $field_val->{$type};
585 next if UNIVERSAL
::isa
($check, 'CODE') ? &$check($field, $value, $field_val, $type) : $check;
586 return 1 if ! wantarray;
587 push @errors, [$field, $type, $field_val, $ifs_match];
588 $content_checked = 1;
591 ### do specific type checks
592 foreach my $type (grep {/^type_?\d*$/} @$types) {
593 if (! $self->check_type($value,$field_val->{'type'},$field,$form)){
594 return 1 if ! wantarray;
595 push @errors, [$field, $type, $field_val, $ifs_match];
597 $content_checked = 1;
601 ### allow for the data to be "untainted"
602 ### this is only allowable if the user ran some other check for the datatype
603 if ($field_val->{'untaint'} && $#errors == -1) {
604 if (! $content_checked) {
605 push @errors, [$field, 'untaint', $field_val, $ifs_match];
607 ### generic untainter - assuming the other required content_checks did good validation
608 $_ = /(.*)/ ? $1 : die "Couldn't match?" foreach @$values;
609 if ($n_values == 1) {
610 $form->{$field} = $values->[0];
611 $self->{cgi_object
}->param(-name
=> $field, -value
=> $values->[0])
612 if $self->{cgi_object
};
614 ### values in @{ $form->{$field} } were modified directly
615 $self->{cgi_object
}->param(-name
=> $field, -value
=> $values)
616 if $self->{cgi_object
};
621 ### all done - time to return
622 return wantarray ? @errors : $#errors + 1;
625 ###----------------------------------------------------------------###
627 ### used to validate specific types
631 my $type = uc(shift);
633 ### do valid email address for our system
634 if ($type eq 'EMAIL') {
635 return 0 if ! $value;
636 my($local_p,$dom) = ($value =~ /^(.+)\@(.+?)$/) ? ($1,$2) : return 0;
638 return 0 if length($local_p) > 60;
639 return 0 if length($dom) > 100;
640 return 0 if ! $self->check_type($dom,'DOMAIN') && ! $self->check_type($dom,'IP');
641 return 0 if ! $self->check_type($local_p,'LOCAL_PART');
643 ### the "username" portion of an email address
644 } elsif ($type eq 'LOCAL_PART') {
645 return 0 if ! defined($value) || ! length($value);
646 return 0 if $value =~ m/[^a-z0-9.\-!&+]/;
647 return 0 if $value =~ m/^[\.\-]/;
648 return 0 if $value =~ m/[\.\-\&]$/;
649 return 0 if $value =~ m/(\.\-|\-\.|\.\.)/;
651 ### standard IP address
652 } elsif ($type eq 'IP') {
653 return 0 if ! $value;
654 return (4 == grep {!/\D/ && $_ < 256} split /\./, $value, 4);
656 ### domain name - including tld and subdomains (which are all domains)
657 } elsif ($type eq 'DOMAIN') {
658 return 0 if ! $value;
659 return 0 if $value =~ m/[^a-z0-9.\-]/;
660 return 0 if $value =~ m/^[\.\-]/;
661 return 0 if $value =~ m/(\.\-|\-\.|\.\.)/;
662 return 0 if length($value) > 255;
663 return 0 if $value !~ s/\.([a-z]+)$//;
666 if ($ext eq 'name') { # .name domains
667 return 0 if $value !~ /^[a-z0-9][a-z0-9\-]{0,62} \. [a-z0-9][a-z0-9\-]{0,62}$/x;
668 } else { # any other domains
669 return 0 if $value !~ /^([a-z0-9][a-z0-9\-]{0,62} \.)* [a-z0-9][a-z0-9\-]{0,62}$/x;
673 } elsif ($type eq 'URL') {
674 return 0 if ! $value;
675 $value =~ s
|^https
?://([^/]+)||i
|| return 0;
677 return 0 if ! $self->check_type($dom,'DOMAIN') && ! $self->check_type($dom,'IP');
678 return 0 if $value && ! $self->check_type($value,'URI');
680 ### validate a uri - the path portion of a request
681 } elsif ($type eq 'URI') {
682 return 0 if ! $value;
683 return 0 if $value =~ m/\s+/;
685 } elsif ($type eq 'CC') {
686 return 0 if ! $value;
687 ### validate the number
688 return 0 if $value =~ /[^\d\-\ ]/
689 || length($value) > 16
690 || length($value) < 13;
692 ### simple mod10 check
696 foreach my $digit ( reverse split //, $value ){
697 $switch = 1 if ++ $switch > 2;
698 my $y = $digit * $switch;
702 return 0 if $sum % 10;
709 ###----------------------------------------------------------------###
714 return CGI
::Ex
::Conf
::conf_read
($val, {html_key
=> 'validation', default_ext
=> $DEFAULT_EXT});
717 ### returns all keys from all groups - even if group has validate_if
718 sub get_validation_keys
{
720 my $val_hash = shift;
721 my $form = shift; # with optional form - will only return keys in validated groups
724 ### if a form was passed - make sure it is a hashref
727 die "Invalid form hash or cgi object";
728 } elsif(! UNIVERSAL
::isa
($form,'HASH')) {
730 $form = CGI
::Ex-
>new->get_form($form);
734 my $refs = $self->get_validation($val_hash);
735 $refs = [$refs] if ! UNIVERSAL
::isa
($refs,'ARRAY');
736 foreach my $group_val (@$refs) {
737 die "Group found that was not a hashref" if ! UNIVERSAL
::isa
($group_val, 'HASH');
739 ### if form is passed, check to see if the group passed validation
741 my $validate_if = $group_val->{'group validate_if'};
742 next if $validate_if && ! $self->check_conditional($form, $validate_if);
745 if ($group_val->{"group fields"}) {
746 die "Group fields must be an arrayref" if ! UNIVERSAL
::isa
($group_val->{"group fields"}, 'ARRAY');
747 foreach my $field_val (@{ $group_val->{"group fields"} }) {
748 next if ! ref($field_val) && $field_val eq 'OR';
749 die "Field_val must be a hashref" if ! UNIVERSAL
::isa
($field_val, 'HASH');
750 my $key = $field_val->{'field'} || die "Missing field key in field_val hashref";
751 $keys{$key} = $field_val->{'name'} || 1;
753 } elsif ($group_val->{"group order"}) {
754 die "Group order must be an arrayref" if ! UNIVERSAL
::isa
($group_val->{"group order"}, 'ARRAY');
755 foreach my $key (@{ $group_val->{"group order"} }) {
756 my $field_val = $group_val->{$key};
757 next if ! $field_val && $key eq 'OR';
758 die "Field_val for $key must be a hashref" if ! UNIVERSAL
::isa
($field_val, 'HASH');
759 $key = $field_val->{'field'} if $field_val->{'field'};
760 $keys{$key} = $field_val->{'name'} || 1;
765 foreach my $key (keys %$group_val) {
766 next if $key =~ /^(general|group)\s/;
767 my $field_val = $group_val->{$key};
768 next if ! UNIVERSAL
::isa
($field_val, 'HASH');
769 $keys{$key} = $field_val->{'name'} || 1;
776 ###----------------------------------------------------------------###
778 ### spit out a chunk that will do the validation
780 ### allow for some browsers to not receive the validation js
781 return "<!-- JS validation not supported in this browser $_ -->"
782 if $ENV{'HTTP_USER_AGENT'} && grep {$ENV{'HTTP_USER_AGENT'} =~ $_} @UNSUPPORTED_BROWSERS;
785 my $val_hash = shift || die "Missing validation";
786 my $form_name = shift || die "Missing form name";
787 my $js_uri_path = shift || $JS_URI_PATH;
788 $val_hash = $self->get_validation($val_hash);
790 ### store any extra items from self
792 $EXTRA{"general $_"} = $self->{$_} for grep {/$QR_EXTRA/o} keys %$self; # add 'general' to be used in javascript
794 my $js_uri_path_validate = $JS_URI_PATH_VALIDATE || do {
795 die "Missing \$js_uri_path" if ! $js_uri_path;
796 "$js_uri_path/CGI/Ex/validate.js";
799 if (! $self->{'no_jsondump'} && eval { require CGI
::Ex
::JSONDump
}) {
800 my $json = CGI
::Ex
::JSONDump-
>new({pretty
=> 1})->dump($val_hash);
801 return qq{<script src="$js_uri_path_validate"></script>
803 document.validation = $json;
804 if (document.check_form) document.check_form("$form_name");
808 } elsif (! $self->{'no_json'} && eval { require JSON
}) {
809 my $json = JSON-
>new(pretty
=> 1)->objToJson($val_hash);
811 return qq{<script src="$js_uri_path_validate"></script>
813 document.validation = $json;
814 if (document.check_form) document.check_form("$form_name");
818 } elsif (eval { require YAML
}) {
820 my $str = YAML
::Dump
((scalar keys %EXTRA) ? (\
%EXTRA) : () , $val_hash);
821 $str =~ s/(?<!\\)\\(?=[sSdDwWbB0-9?.*+|\-\^\${}()\[\]])/\\\\/g; # fix some issues with YAML
822 $str =~ s/\n/\\n\\\n/g; # allow for one big string that flows on multiple lines
823 $str =~ s/\"/\\\"/g; # quotify it
826 my $js_uri_path_yaml = $JS_URI_PATH_YAML || do {
827 die "Missing \$js_uri_path" if ! $js_uri_path;
828 "$js_uri_path/CGI/Ex/yaml_load.js";
831 ### return the string
832 return qq{<script src="$js_uri_path_yaml"></script>
833 <script src="$js_uri_path_validate"></script>
835 document.validation = "$str";
836 if (document.check_form) document.check_form("$form_name");
840 return '<!-- no JSON or YAML support found for JS validation -->';
844 ###----------------------------------------------------------------###
845 ### How to handle errors
847 package CGI
::Ex
::Validate
::Error
;
850 use overload
'""' => \
&as_string
;
853 my $class = shift || __PACKAGE__
;
855 my $extra = shift || {};
856 die "Missing or invalid arrayref" if ! UNIVERSAL
::isa
($errors, 'ARRAY');
857 die "Missing or invalid hashref" if ! UNIVERSAL
::isa
($extra, 'HASH');
858 return bless {errors
=> $errors, extra
=> $extra}, $class;
863 my $extra = $self->{extra
} || {};
864 my $extra2 = shift || {};
866 ### allow for formatting
867 my $join = defined($extra2->{as_string_join
}) ? $extra2->{as_string_join
}
868 : defined($extra->{as_string_join
}) ? $extra->{as_string_join
}
870 my $header = defined($extra2->{as_string_header
}) ? $extra2->{as_string_header
}
871 : defined($extra->{as_string_header
}) ? $extra->{as_string_header
} : "";
872 my $footer = defined($extra2->{as_string_footer
}) ? $extra2->{as_string_footer
}
873 : defined($extra->{as_string_footer
}) ? $extra->{as_string_footer
} : "";
875 return $header . join($join, @{ $self->as_array($extra2) }) . $footer;
878 ### return an array of applicable errors
881 my $errors = $self->{errors
} || die "Missing errors";
882 my $extra = $self->{extra
} || {};
883 my $extra2 = shift || {};
885 my $title = defined($extra2->{as_array_title
}) ? $extra2->{as_array_title
}
886 : defined($extra->{as_array_title
}) ? $extra->{as_array_title
}
887 : "Please correct the following items:";
889 ### if there are heading items then we may end up needing a prefix
901 my $prefix = defined($extra2->{as_array_prefix
}) ? $extra2->{as_array_prefix
}
902 : defined($extra->{as_array_prefix
}) ? $extra->{as_array_prefix
}
903 : $has_headings ? ' ' : '';
905 ### get the array ready
907 push @array, $title if length $title;
911 foreach my $err (@$errors) {
916 my $text = $self->get_error_text($err);
917 next if $found{$text};
919 push @array, "$prefix$text";
926 ### return a hash of applicable errors
929 my $errors = $self->{errors
} || die "Missing errors";
930 my $extra = $self->{extra
} || {};
931 my $extra2 = shift || {};
933 my $suffix = defined($extra2->{as_hash_suffix
}) ? $extra2->{as_hash_suffix
}
934 : defined($extra->{as_hash_suffix
}) ? $extra->{as_hash_suffix
} : '_error';
935 my $join = defined($extra2->{as_hash_join
}) ? $extra2->{as_hash_join
}
936 : defined($extra->{as_hash_join
}) ? $extra->{as_hash_join
} : '<br />';
938 ### now add to the hash
941 foreach my $err (@$errors) {
944 my ($field, $type, $field_val, $ifs_match) = @$err;
945 die "Missing field name" if ! $field;
946 if ($field_val->{delegate_error
}) {
947 $field = $field_val->{delegate_error
};
948 $field =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
951 my $text = $self->get_error_text($err);
952 next if $found{$field}->{$text};
953 $found{$field}->{$text} = 1;
956 $return{$field} ||= [];
957 $return{$field} = [$return{$field}] if ! ref($return{$field});
958 push @{ $return{$field} }, $text;
961 ### allow for elements returned as
963 my $header = defined($extra2->{as_hash_header
}) ? $extra2->{as_hash_header
}
964 : defined($extra->{as_hash_header
}) ? $extra->{as_hash_header
} : "";
965 my $footer = defined($extra2->{as_hash_footer
}) ? $extra2->{as_hash_footer
}
966 : defined($extra->{as_hash_footer
}) ? $extra->{as_hash_footer
} : "";
967 foreach my $key (keys %return) {
968 $return{$key} = $header . join($join,@{ $return{$key} }) . $footer;
975 ### return a user friendly error message
979 my $extra = $self->{extra
} || {};
980 my ($field, $type, $field_val, $ifs_match) = @$err;
981 my $dig = ($type =~ s/(_?\d+)$//) ? $1 : '';
982 my $type_lc = lc($type);
984 ### allow for delegated field names - only used for defaults
985 if ($field_val->{delegate_error
}) {
986 $field = $field_val->{delegate_error
};
987 $field =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
990 ### the the name of this thing
991 my $name = $field_val->{'name'} || "The field $field";
992 $name =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
994 ### type can look like "required" or "required2" or "required100023"
995 ### allow for fallback from required100023_error through required_error
996 my @possible_error_keys = ("${type}_error");
997 unshift @possible_error_keys, "${type}${dig}_error" if length($dig);
999 ### look in the passed hash or self first
1001 foreach my $key (@possible_error_keys){
1002 $return = $field_val->{$key} || $extra->{$key} || next;
1003 $return =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
1004 $return =~ s/\$field/$field/g;
1005 $return =~ s/\$name/$name/g;
1006 if (my $value = $field_val->{"$type$dig"}) {
1007 $return =~ s/\$value/$value/g if ! ref $value;
1012 ### set default messages
1014 if ($type eq 'required' || $type eq 'required_if') {
1015 $return = "$name is required.";
1017 } elsif ($type eq 'min_values') {
1018 my $n = $field_val->{"min_values${dig}"};
1019 my $values = ($n == 1) ? 'value' : 'values';
1020 $return = "$name had less than $n $values.";
1022 } elsif ($type eq 'max_values') {
1023 my $n = $field_val->{"max_values${dig}"};
1024 my $values = ($n == 1) ? 'value' : 'values';
1025 $return = "$name had more than $n $values.";
1027 } elsif ($type eq 'enum') {
1028 $return = "$name is not in the given list.";
1030 } elsif ($type eq 'equals') {
1031 my $field2 = $field_val->{"equals${dig}"};
1032 my $name2 = $field_val->{"equals${dig}_name"} || "the field $field2";
1033 $name2 =~ s/\$(\d+)/defined($ifs_match->[$1]) ? $ifs_match->[$1] : ''/eg if $ifs_match;
1034 $return = "$name did not equal $name2.";
1036 } elsif ($type eq 'min_len') {
1037 my $n = $field_val->{"min_len${dig}"};
1038 my $char = ($n == 1) ? 'character' : 'characters';
1039 $return = "$name was less than $n $char.";
1041 } elsif ($type eq 'max_len') {
1042 my $n = $field_val->{"max_len${dig}"};
1043 my $char = ($n == 1) ? 'character' : 'characters';
1044 $return = "$name was more than $n $char.";
1046 } elsif ($type eq 'max_in_set') {
1047 my $set = $field_val->{"max_in_set${dig}"};
1048 $return = "Too many fields were chosen from the set ($set)";
1050 } elsif ($type eq 'min_in_set') {
1051 my $set = $field_val->{"min_in_set${dig}"};
1052 $return = "Not enough fields were chosen from the set ($set)";
1054 } elsif ($type eq 'match') {
1055 $return = "$name contains invalid characters.";
1057 } elsif ($type eq 'compare') {
1058 $return = "$name did not fit comparison.";
1060 } elsif ($type eq 'sql') {
1061 $return = "$name did not match sql test.";
1063 } elsif ($type eq 'custom') {
1064 $return = "$name did not match custom test.";
1066 } elsif ($type eq 'type') {
1067 my $_type = $field_val->{"type${dig}"};
1068 $return = "$name did not match type $_type.";
1070 } elsif ($type eq 'untaint') {
1071 $return = "$name cannot be untainted without one of the following checks: enum, equals, match, compare, sql, type, custom";
1073 } elsif ($type eq 'no_extra_fields') {
1074 $return = "$name should not be passed to validate.";
1078 die "Missing error on field $field for type $type$dig" if ! $return;
1083 ###----------------------------------------------------------------###
1092 use CGI::Ex::Validate;
1096 my $errobj = CGI::Ex::Validate->new->validate($form, $val_hash);
1100 my $form = CGI->new;
1102 my $form = CGI::Ex->new; # OR CGI::Ex->get_form;
1104 my $form = {key1 => 'val1', key2 => 'val2'};
1112 field => 'username',
1113 # field is optional in this case - will use key name
1120 validate_if => 'email',
1127 'group order' => [qw(username email email2)],
1128 username => {required => 1, max_len => 30},
1135 'group fields' => [{
1136 field => 'username', # field is not optional in this case
1145 validate_if => 'email',
1151 my $vob = CGI::Ex::Validate->new;
1152 my $errobj = $vob->validate($form, $val_hash);
1154 my $errobj = $vob->validate($form, "/somefile/somewhere.val"); # import config using yaml file
1156 my $errobj = $vob->validate($form, "/somefile/somewhere.pl"); # import config using perl file
1158 my $errobj = $vob->validate($form, "--- # a yaml document\n"); # import config using yaml str
1162 my $error_heading = $errobj->as_string; # OR "$errobj";
1163 my $error_list = $errobj->as_array; # ordered list of what when wrong
1164 my $error_hash = $errobj->as_hash; # hash of arrayrefs of errors
1166 # form passed validation
1169 ### will add an error for any form key not found in $val_hash
1170 my $vob = CGI::Ex::Validate->new({no_extra_keys => 1});
1171 my $errobj = $vob->validate($form, $val_hash);
1175 CGI::Ex::Validate is one of many validation modules. It aims to have
1176 all of the basic data validation functions, avoid adding all of the
1177 millions of possible types, while still giving the capability for the
1178 developer to add their own types.
1180 CGI::Ex::Validate can work in a simple way like all of the other
1181 validators do. However, it also allows for grouping of validation
1182 items and conditional validation of groups or individual items. This
1183 is more in line with the normal validation procedures for a website.
1185 It also has full support for providing the same validation in javascript.
1186 It provides methods for attaching the javascript to existing forms.
1194 Used to instantiate the object. Arguments are either a hash, or hashref,
1195 or nothing at all. Keys of the hash become the keys of the object.
1197 =item C<get_validation>
1199 Given a filename or YAML string will return perl hash. If more than one
1200 group is contained in the file, it will return an arrayref of hashrefs.
1202 my $ref = $self->get_validation($file);
1204 =item C<get_validation_keys>
1206 Given a filename or YAML string or a validation hashref, will return all
1207 of the possible keys found in the validation hash. This can be used to
1208 check to see if extra items have been passed to validate. If a second
1209 argument contains a form hash is passed, get_validation_keys will only
1210 return the keys of groups that were validated.
1212 my $key_hashref = $self->get_validation_keys($val_hash);
1214 The values of the hash are the names of the fields.
1218 Arguments are a form hashref or cgi object, a validation hashref or
1219 filename, and an optional what_was_validated arrayref. If a CGI
1220 object is passed, CGI::Ex::get_form will be called on that object to
1221 turn it into a hashref. If a filename is given for the validation,
1222 get_validation will be called on that filename. If the
1223 what_was_validated_arrayref is passed - it will be populated (pushed)
1224 with the field hashes that were actually validated (anything that was
1225 skipped because of validate_if will not be in the array).
1227 If the form passes validation, validate will return undef. If it
1228 fails validation, it will return a CGI::Ex::Validate::Error object.
1229 If the 'raise_error' general option has been set, validate will die
1230 with a CGI::Ex::validate::Error object as the value.
1232 my $err_obj = $self->validate($form, $val_hash);
1236 $self->{raise_error} = 1; # raise error can also be listed in the
1237 val_hash eval { $self->validate($form, $val_hash) }; if ($@) { my
1240 =item C<generate_js>
1242 Requires JSON or YAML to work properly (see L<JSON> or L<YAML>).
1244 Takes a validation hash, a form name, and an optional javascript uri
1245 path and returns Javascript that can be embedded on a page and will
1246 perform identical validations as the server side. The validation can
1247 be any validation hash (or arrayref of hashes. The form name must be
1248 the name of the form that the validation will act upon - the name is
1249 used to register an onsubmit function. The javascript uri path is
1250 used to embed the locations two external javascript source files.
1253 The javascript uri path is highly dependent upon the server
1254 configuration and therefore must be configured manually. It may be
1255 passed to generate_js, or it may be specified in $JS_URI_PATH. There
1256 are two files included with this module that are needed -
1257 CGI/Ex/yaml_load.js and CGI/Ex/validate.js. When generating the js
1258 code, generate_js will look in $JS_URI_PATH_YAML and
1259 $JS_URI_PATH_VALIDATE. If either of these are not set, generate_js
1260 will default to "$JS_URI_PATH/CGI/Ex/yaml_load.js" and
1261 "$JS_URI_PATH/CGI/Ex/validate.js".
1263 $self->generate_js($val_hash, 'my_form', "/cgi-bin/js")
1265 # would generate something like the following...
1267 <script src="/cgi-bin/js/CGI/Ex/yaml_load.js"></script>
1268 <script src="/cgi-bin/js/CGI/Ex/validate.js"></script>
1269 ... more js follows ...
1271 $CGI::Ex::Validate::JS_URI_PATH = "/stock/js";
1272 $CGI::Ex::Validate::JS_URI_PATH_YAML = "/js/yaml_load.js";
1273 $self->generate_js($val_hash, 'my_form')
1275 # would generate something like the following...
1277 <script src="/js/yaml_load.js"></script>
1278 <script src="/stock/js/CGI/Ex/validate.js"></script>
1279 ... more js follows ...
1281 Referencing yaml_load.js and validate.js can be done in any of
1282 several ways. They can be copied to or symlinked to a fixed location
1283 in the servers html directory. They can also be printed out by a cgi.
1284 The method C<-E<gt>print_js> has been provided in CGI::Ex for printing
1285 js files found in the perl hierarchy. See L<CGI::Ex> for more details.
1286 The $JS_URI_PATH of "/cgi-bin/js" could contain the following:
1293 ### path_info should contain something like /CGI/Ex/yaml_load.js
1294 my $info = $ENV{PATH_INFO} || '';
1295 die "Invalid path" if $info !~ m|^(/\w+)+.js$|;
1298 CGI::Ex->new->print_js($info);
1301 The print_js method in CGI::Ex is designed to cache the javascript in
1302 the browser (caching is suggested as they are medium sized files).
1306 Returns a CGI::Ex object. Used internally.
1310 =head1 VALIDATION HASH
1312 The validation hash may be passed as a perl a hashref or as a
1313 filename, or as a YAML document string. If it is a filename, it will
1314 be translated into a hash using the %EXT_HANDLER for the extension on
1315 the file. If there is no extension, it will use $DEFAULT_EXT as a
1318 The validation "hash" may also be an arrayref of hashrefs. In this
1319 case, each arrayref is treated as a group and is validated separately.
1320 A group can have a validate_if function that allows for that
1321 particular group to apply only if certain conditions are met.
1325 Each hashref that is passed as a validation hash is treated as a
1326 group. Keys matching the regex m/^group\s+(\w+)$/ are reserved and
1327 are counted as GROUP OPTIONS. Keys matching the regex m/^general\s+(\w+)$/
1328 are reserved and are counted as GENERAL OPTIONS. Other keys (if
1329 any, should be keys that need validation).
1331 If the GROUP OPTION 'group validate_if' is set, the group will only
1332 be validated if the conditions are met. Any group with out a validate_if
1333 fill be automatically validated.
1335 Each of the items listed in the group will be validated. The
1336 validation order is determined in one of three ways:
1340 =item Specify 'group fields' arrayref.
1342 # order will be (username, password, 'm/\w+_foo/', somethingelse)
1344 'group title' => "User Information",
1346 {field => 'username', required => 1},
1347 {field => 'password', required => 1},
1348 {field => 'm/\w+_foo/', required => 1},
1350 somethingelse => {required => 1},
1353 =item Specify 'group order' arrayref.
1355 # order will be (username, password, 'm/\w+_foo/', somethingelse)
1357 'group title' => "User Information",
1358 'group order' => [qw(username password), 'm/\w+_foo/'],
1359 username => {required => 1},
1360 password => {required => 1},
1361 'm/\w+_foo/' => {required => 1},
1362 somethingelse => {required => 1},
1365 =item Do nothing - use sorted order.
1367 # order will be ('m/\w+_foo/', password, somethingelse, username)
1369 'group title' => "User Information",
1370 username => {required => 1},
1371 password => {required => 1},
1372 'm/\w+_foo/' => {required => 1},
1373 somethingelse => {required => 1},
1378 Each of the individual field validation hashrefs should contain the
1379 types listed in VALIDATION TYPES.
1381 Optionally the 'group fields' or the 'group order' may contain the
1382 word 'OR' as a special keyword. If the item preceding 'OR' fails
1383 validation the item after 'OR' will be tested instead. If the item
1384 preceding 'OR' passes validation the item after 'OR' will not be
1387 'group order' => [qw(zip OR postalcode state OR region)],
1389 Each individual validation hashref will operate on the field contained
1390 in the 'field' key. This key may also be a regular expression in the
1391 form of 'm/somepattern/'. If a regular expression is used, all keys
1392 matching that pattern will be validated.
1394 =head1 VALIDATION TYPES
1396 This section lists the available validation types. Multiple instances
1397 of the same type may be used for some validation types by adding a
1398 number to the type (ie match, match2, match232, match_94). Multiple
1399 instances are validated in sorted order. Types that allow multiple
1416 =item C<validate_if>
1418 If validate_if is specified, the field will only be validated
1419 if the conditions are met. Works in JS.
1421 validate_if => {field => 'name', required => 1, max_len => 30}
1422 # Will only validate if the field "name" is present and is less than 30 chars.
1424 validate_if => 'name',
1426 validate_if => {field => 'name', required => 1},
1428 validate_if => '! name',
1430 validate_if => {field => 'name', max_in_set => '0 of name'},
1432 validate_if => {field => 'country', compare => "eq US"},
1433 # only if country's value is equal to US
1435 validate_if => {field => 'country', compare => "ne US"},
1436 # if country doesn't equal US
1438 validate_if => {field => 'password', match => 'm/^md5\([a-z0-9]{20}\)$/'},
1439 # if password looks like md5(12345678901234567890)
1442 field => 'm/^(\w+)_pass/',
1443 validate_if => '$1_user',
1446 # will validate foo_pass only if foo_user was present.
1448 The validate_if may also contain an arrayref of validation items. So that
1449 multiple checks can be run. They will be run in order. validate_if will
1450 return true only if all options returned true.
1452 validate_if => ['email', 'phone', 'fax']
1454 Optionally, if validate_if is an arrayref, it may contain the word
1455 'OR' as a special keyword. If the item preceding 'OR' fails validation
1456 the item after 'OR' will be tested instead. If the item preceding 'OR'
1457 passes validation the item after 'OR' will not be tested.
1459 validate_if => [qw(zip OR postalcode)],
1461 =item C<required_if>
1463 Requires the form field if the condition is satisfied. The conditions
1464 available are the same as for validate_if. This is somewhat the same
1467 validate_if => 'some_condition',
1470 required_if => 'some_condition',
1472 If a regex is used for the field name, the required_if
1473 field will have any match patterns swapped in.
1476 field => 'm/^(\w+)_pass/',
1477 required_if => '$1_user',
1480 This example would require the "foobar_pass" field to be set
1481 if the "foobar_user" field was passed.
1485 Requires the form field to have some value. If the field is not present,
1486 no other checks will be run.
1488 =item C<min_values> and C<max_values>
1490 Allows for specifying the maximum number of form elements passed.
1491 max_values defaults to 1 (You must explicitly set it higher
1492 to allow more than one item by any given name).
1494 =item C<min_in_set> and C<max_in_set>
1496 Somewhat like min_values and max_values except that you specify the
1497 fields that participate in the count. Also - entries that are not
1498 defined or do not have length are not counted. An optional "of" can
1499 be placed after the number for human readability.
1501 min_in_set => "2 of foo bar baz",
1502 # two of the fields foo, bar or baz must be set
1504 min_in_set => "2 foo bar baz",
1506 min_in_set => "2 OF foo bar baz",
1508 validate_if => {field => 'whatever', max_in_set => '0 of whatever'},
1509 # only run validation if there were zero occurrences of whatever
1513 Allows for checking whether an item matches a set of options. In perl
1514 the value may be passed as an arrayref. In the conf or in perl the
1515 value may be passed of the options joined with ||.
1518 field => 'password_type',
1519 enum => 'plaintext||crypt||md5', # OR enum => [qw(plaintext crypt md5)],
1524 Allows for comparison of two form elements. Can have an optional !.
1527 field => 'password',
1528 equals => 'password_verify',
1532 equals => '!domain2', # make sure the fields are not the same
1535 =item C<min_len and max_len>
1537 Allows for check on the length of fields
1547 Allows for regular expression comparison. Multiple matches may
1548 be concatenated with ||. Available in JS.
1552 match => 'm/^\d{1,3}(\.\d{1,3})3$/',
1553 match_2 => '!/^0\./ || !/^192\./',
1558 Allows for custom comparisons. Available types are
1559 >, <, >=, <=, !=, ==, gt, lt, ge, le, ne, and eq. Comparisons
1560 also work in the JS.
1563 field => 'my_number',
1564 match => 'm/^\d+$/',
1565 compare1 => '> 100',
1566 compare2 => '< 255',
1567 compare3 => '!= 150',
1572 SQL query based - not available in JS. The database handle will be looked
1573 for in the value $self->{dbhs}->{foo} if sql_db_type is set to 'foo',
1574 otherwise it will default to $self->{dbh}. If $self->{dbhs}->{foo} or
1575 $self->{dbh} is a coderef - they will be called and should return a dbh.
1578 field => 'username',
1579 sql => 'SELECT COUNT(*) FROM users WHERE username = ?',
1580 sql_error_if => 1, # default is 1 - set to 0 to negate result
1581 # sql_db_type => 'foo', # will look for a dbh under $self->{dbhs}->{foo}
1586 Custom value - not available in JS. Allows for extra programming types.
1587 May be either a boolean value predetermined before calling validate, or may be
1588 a coderef that will be called during validation. If coderef is called, it will
1589 be passed the field name, the form value for that name, and a reference to the
1590 field validation hash. If the custom type returns false the element fails
1591 validation and an error is added.
1594 field => 'username',
1596 my ($key, $val, $type, $field_val_hash) = @_;
1604 Custom value - only available in JS. Allows for extra programming types.
1605 May be either a boolean value pre-determined before calling validate, or may be
1606 section of javascript that will be eval'ed. The last value (return value) of
1607 the eval'ed javascript will determine if validation passed. A false value indicates
1608 the value did not pass validation. A true value indicates that it did. See
1609 the t/samples/js_validate_3.html page for a sample of usage.
1614 match => 'm|^\d\d\d\d/\d\d/\d\d$|',
1615 match_error => 'Please enter date in YYYY/MM/DD format',
1618 var y=t.getYear()+1900;
1619 var m=t.getMonth() + 1;
1621 if (m<10) m = '0'+m;
1622 if (d<10) d = '0'+d;
1623 (value > ''+y+'/'+m+'/'+d) ? 1 : 0;
1625 custom_js_error => 'The date was not greater than today.',
1630 Allows for more strict type checking. Currently supported types
1631 include CC (credit card). Other types will be added upon request provided
1632 we can add a perl and a javascript version.
1635 field => 'credit_card',
1641 =head1 SPECIAL VALIDATION TYPES
1647 Specify which field to work on. Key may be a regex in the form 'm/\w+_user/'.
1648 This key is required if 'group fields' is used or if validate_if or required_if
1649 are used. It can optionally be used with other types to specify a different form
1650 element to operate on. On errors, if a non-default error is found, $field
1651 will be swapped with the value found in field.
1653 The field name may also be a regular expression in the
1654 form of 'm/somepattern/'. If a regular expression is used, all keys
1655 matching that pattern will be validated.
1659 Name to use for errors. If a name is not specified, default errors will use
1660 "The field $field" as the name. If a non-default error is found, $name
1661 will be swapped with this name.
1663 =item C<delegate_error>
1665 This option allows for any errors generated on a field to delegate to
1666 a different field. If the field name was a regex, any patterns will
1667 be swapped into the delegate_error value. This option is generally only
1668 useful with the as_hash method of the error object (for inline errors).
1672 match => 'm/^\d{5}/',
1675 field => 'zip_plus4',
1676 match => 'm/^\d{4}/',
1677 delegate_error => 'zip',
1680 field => 'm/^(id_[\d+])_user$/',
1681 delegate_error => '$1',
1686 This allows the cgi to do checking while keeping the checks from
1687 being run in JavaScript
1695 =item C<exclude_cgi>
1697 This allows the js to do checking while keeping the checks from
1698 being run in the cgi
1708 =head1 MODIFYING VALIDATION TYPES
1710 The following types will modify the form value before it is processed.
1711 They work in both the perl and in javascript as well. The javascript
1712 version changes the actual value in the form on appropriate form types.
1716 =item C<do_not_trim>
1718 By default, validate will trim leading and trailing whitespace
1719 from submitted values. Set do_not_trim to 1 to allow it to
1722 {field => 'foo', do_not_trim => 1}
1726 Pass a swap pattern to change the actual value of the form.
1727 Any perl regex can be passed but it is suggested that javascript
1728 compatible regexes are used to make generate_js possible.
1730 {field => 'foo', replace => 's/(\d{3})(\d{3})(\d{3})/($1) $2-$3/'}
1734 Set item to default value if there is no existing value (undefined
1735 or zero length string).
1737 {field => 'country', default => 'EN'}
1739 =item C<to_upper_case> and C<to_lower_case>
1741 Do what they say they do.
1745 Requires that the validated field has been also checked with
1746 an enum, equals, match, compare, custom, or type check. If the
1747 field has been checked and there are no errors - the field is "untainted."
1749 This is for use in conjunction with perl's -T switch.
1755 Failed validation results in an error an error object created via the
1756 new_error method. The default error class is CGI::Ex::Validate::Error.
1758 The error object has several methods for determining what the errors were.
1764 Returns an array or arrayref (depending on scalar context) of errors that
1765 occurred in the order that they occurred. Individual groups may have a heading
1766 and the entire validation will have a heading (the default heading can be changed
1767 via the 'as_array_title' general option). Each error that occurred is a separate
1768 item and are pre-pended with 'as_array_prefix' (which is a general option - default
1769 is ' '). The as_array_ options may also be set via a hashref passed to as_array.
1770 as_array_title defaults to 'Please correct the following items:'.
1772 ### if this returns the following
1773 my $array = $err_obj->as_array;
1775 # ['Please correct the following items:', ' error1', ' error2']
1777 ### then this would return the following
1778 my $array = $err_obj->as_array({
1779 as_array_prefix => ' - ',
1780 as_array_title => 'Something went wrong:',
1783 # ['Something went wrong:', ' - error1', ' - error2']
1787 Returns values of as_array joined with a newline. This method is used as
1788 the stringification for the error object. Values of as_array are joined with
1789 'as_string_join' which defaults to "\n". If 'as_string_header' is set, it will
1790 be pre-pended onto the error string. If 'as_string_footer' is set, it will be
1791 appended onto the error string.
1793 ### if this returns the following
1794 my $string = $err_obj->as_string;
1795 # $string looks like
1796 # "Please correct the following items:\n error1\n error2"
1798 ### then this would return the following
1799 my $string = $err_obj->as_string({
1800 as_array_prefix => ' - ',
1801 as_array_title => 'Something went wrong:',
1802 as_string_join => '<br />',
1803 as_string_header => '<span class="error">',
1804 as_string_footer => '</span>',
1806 # $string looks like
1807 # '<span class="error">Something went wrong:<br /> - error1<br /> - error2</span>'
1811 Returns a hash or hashref (depending on scalar context) of errors that
1812 occurred. Each key is the field name of the form that failed validation with
1813 'as_hash_suffix' added on as a suffix. as_hash_suffix is available as a general option
1814 and may also be passed in via a hashref as the only argument to as_hash.
1815 The default value is '_error'. The values of the hash are arrayrefs of errors
1816 that occurred to that form element.
1818 By default as_hash will return the values of the hash as arrayrefs (a list of the errors
1819 that occurred to that key). It is possible to also return the values as strings.
1820 Three options are available for formatting: 'as_hash_header' which will be pre-pended
1821 onto the error string, 'as_hash_footer' which will be appended, and 'as_hash_join' which
1822 will be used to join the arrayref. The only argument required to force the
1823 stringification is 'as_hash_join'.
1825 ### if this returns the following
1826 my $hash = $err_obj->as_hash;
1828 # {key1_error => ['error1', 'error2']}
1830 ### then this would return the following
1831 my $hash = $err_obj->as_hash({
1832 as_hash_suffix => '_foo',
1833 as_hash_join => '<br />',
1834 as_hash_header => '<span class="error">'
1835 as_hash_footer => '</span>'
1838 # {key1_foo => '<span class="error">error1<br />error2</span>'}
1842 =head1 GROUP OPTIONS
1844 Any key in a validation hash matching the pattern m/^group\s+(\w+)$/
1845 is considered a group option. The current know options are:
1849 =item C<'group title'>
1851 Used as a group section heading when as_array or as_string is called
1852 by the error object.
1854 =item C<'group order'>
1856 Order in which to validate key/value pairs of group.
1858 =item C<'group fields'>
1860 Arrayref of validation items to validate.
1862 =item C<'group validate_if'>
1864 Conditions that will be checked to see if the group should be validated.
1865 If no validate_if option is found, the group will be validated.
1869 =head1 GENERAL OPTIONS
1871 Any key in a validation hash matching the pattern m/^general\s+(\w+)$/
1872 is considered a general option. General options will also be looked
1873 for in the Validate object ($self) and can be set when instantiating
1874 the object ($self->{raise_error} is equivalent to
1875 $valhash->{'general raise_error'}). The current know options are:
1877 General options may be set in any group using the syntax:
1879 'general general_option_name' => 'general_option_value'
1881 They will only be set if the group's validate_if is successful or
1882 if the group does not have a validate_if. It is also possible to set
1883 a "group general" option using the following syntax:
1885 'group general_option_name' => 'general_option_value'
1887 These items will only be set if the group fails validation.
1888 If a group has a validate_if block and passes validation, the group
1889 items will not be used. This is so that a failed section can have
1890 its own settings. Note though that the last option found will be
1891 used and that items set in $self override those set in the validation
1894 Options may also be set globally before calling validate by
1895 populating the %DEFAULT_OPTIONS global hash.
1899 =item C<'general raise_error'>
1901 If raise_error is true, any call to validate that fails validation
1902 will die with an error object as the value.
1904 =item C<'general no_extra_fields'>
1906 If no_extra_fields is true, validate will add errors for any field found
1907 in form that does not have a field_val hashref in the validation hash.
1908 Default is false. If no_extra_fields is set to 'used', it will check for
1909 any keys that were not in a group that was validated.
1911 An important exception to this is that field_val hashrefs or field names listed
1912 in a validate_if or required_if statement will not be included. You must
1913 have an explicit entry for each key.
1915 =item C<'general \w+_error'>
1917 These items allow for an override of the default errors.
1919 'general required_error' => '$name is really required',
1920 'general max_len_error' => '$name must be shorter than $value characters',
1922 my $self = CGI::Ex::Validate->new({
1923 max_len_error => '$name must be shorter than $value characters',
1926 =item C<'general as_array_title'>
1928 Used as the section title for all errors that occur, when as_array
1929 or as_string is called by the error object.
1931 =item C<'general as_array_prefix'>
1933 Used as prefix to individual errors that occur, when as_array
1934 or as_string is called by the error object. Each individual error
1935 will be prefixed with this string. Headings will not be prefixed.
1938 =item C<'general as_string_join'>
1940 When as_string is called, the values from as_array will be joined with
1941 as_string_join. Default value is "\n".
1943 =item C<'general as_string_header'>
1945 If set, will be pre-pended onto the string when as_string is called.
1947 =item C<'general as_string_footer'>
1949 If set, will be pre-pended onto the string when as_string is called.
1951 =item C<'general as_hash_suffix'>
1953 Added on to key names during the call to as_hash. Default is '_error'.
1955 =item C<'general as_hash_join'>
1957 By default, as_hash will return hashref values that are errors joined with
1958 the default as_hash_join value of <br />. It can also return values that are
1959 arrayrefs of the errors. This can be done by setting as_hash_join to a non-true value
1962 =item C<'general as_hash_header'>
1964 If as_hash_join has been set to a true value, as_hash_header may be set to
1965 a string that will be pre-pended on to the error string.
1967 =item C<'general as_hash_footer'>
1969 If as_hash_join has been set to a true value, as_hash_footer may be set to
1970 a string that will be postpended on to the error string.
1972 =item C<'general no_inline'>
1974 If set to true, the javascript validation will not attempt to generate inline
1975 errors. Default is true. Inline errors are independent of confirm and alert
1978 =item C<'general no_confirm'>
1980 If set to true, the javascript validation will try to use an alert instead
1981 of a confirm to inform the user of errors. Alert and confirm are independent
1982 or inline errors. Default is false.
1984 =item C<'general no_alert'>
1986 If set to true, the javascript validation will not show an alert box
1987 when errors occur. Default is false. This option only comes into
1988 play if no_confirm is also set. This option is independent of inline
1989 errors. Although it is possible to turn off all errors by setting
1990 no_inline, no_confirm, and no_alert all to 1, it is suggested that at
1991 least one of the error reporting facilities is left on.
1995 It is possible to have a group that contains nothing but general options.
1998 {'general error_title' => 'The following things went wrong',
1999 'general error_prefix' => ' - ',
2000 'general raise_error' => 1,
2001 'general name_suffix' => '_foo_error',
2002 'general required_error' => '$name is required',
2004 {'group title' => 'User Information',
2005 username => {required => 1},
2006 email => {required => 1},
2007 password => {required => 1},
2013 CGI::Ex::Validate provides for having duplicate validation on the
2014 client side as on the server side. Errors can be shown in any
2015 combination of inline and confirm, inline and alert, inline only,
2016 confirm only, alert only, and none. These combinations are controlled
2017 by the general options no_inline, no_confirm, and no_alert.
2018 Javascript validation can be generated for a page using the
2019 C<-E<gt>generate_js> Method of CGI::Ex::Validate. It is also possible
2020 to store the validation inline with the html. This can be done by
2021 giving each of the elements to be validated an attribute called
2022 "validation", or by setting a global javascript variable called
2023 "document.validation" or "var validation". An html file containing this
2024 validation will be read in using CGI::Ex::Conf::read_handler_html.
2026 All inline html validation must be written in yaml.
2028 It is anticipated that the html will contain something like either of the
2031 <script src="/cgi-bin/js/CGI/Ex/yaml_load.js"></script>
2032 <script src="/cgi-bin/js/CGI/Ex/validate.js"></script>
2034 // \n\ allows all browsers to view this as a single string
2035 document.validation = "\n\
2036 general no_confirm: 1\n\
2037 general no_alert: 1\n\
2038 group order: [username, password]\n\
2046 if (document.check_form) document.check_form('my_form_name');
2049 Alternately we can use element attributes:
2051 <form name="my_form_name">
2053 Username: <input type=text size=20 name=username validation="
2057 <span class=error id=username_error>[% username_error %]</span><br>
2059 Password: <input type=text size=20 name=password validation="
2063 <span class=error id=password_error>[% password_error %]</span><br>
2069 <script src="/cgi-bin/js/CGI/Ex/yaml_load.js"></script>
2070 <script src="/cgi-bin/js/CGI/Ex/validate.js"></script>
2072 if (document.check_form) document.check_form('my_form_name');
2075 The read_handler_html from CGI::Ex::Conf will find either of these
2076 types of validation.
2078 If inline errors are asked for, each error that occurs will attempt
2079 to find an html element with its name as the id. For example, if
2080 the field "username" failed validation and created a "username_error",
2081 the javascript would set the html of <span id="username_error"></span>
2082 to the error message.
2084 It is suggested to use something like the following so that you can
2085 have inline javascript validation as well as report validation errors
2086 from the server side as well.
2088 <span class=error id=password_error>[% password_error %]</span><br>
2090 If the javascript fails for some reason, the form should still be able
2091 to submit as normal (fail gracefully).
2093 If the confirm option is used, the errors will be displayed to the user.
2094 If they choose OK they will be able to try and fix the errors. If they
2095 choose cancel, the form will submit anyway and will rely on the server
2096 to do the validation. This is for fail safety to make sure that if the
2097 javascript didn't validate correctly, the user can still submit the data.
2101 Thanks to Eamon Daly for providing bug fixes for bugs in validate.js
2102 caused by HTML::Prototype.
2110 This module may be distributed under the same terms as Perl itself.
This page took 0.196149 seconds and 4 git commands to generate.