/usr/lib/x86_64-linux-gnu/perl5/5.22/Embperl/Form/Validate.pm is in libembperl-perl 2.5.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 | ###################################################################################
#
# Embperl - Copyright (c) 1997-2008 Gerald Richter / ecos gmbh www.ecos.de
# Embperl - Copyright (c) 2008-2014 Gerald Richter
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
#
# THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
# WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# $Id: Validate.pm 1578075 2014-03-16 14:01:14Z richter $
#
###################################################################################
package Embperl::Form::Validate;
use strict;
use vars qw($VERSION $has_encode);
BEGIN
{
eval "require Encode" ;
$has_encode = $@?0:1 ;
}
$VERSION = '2.5.0' ;
=encoding iso8859-1
=head1 NAME
Embperl::Form::Validate - Form validation with server- and client-side support.
=head1 DESCRIPTION
This modules is developed to do form validation for you. It works
on the server side by checking the posted form data and it
generates client side script functions, to validate the
form values, as far as possible, before they are send to
the server, to avoid another server roundtrip.
Also it has the best support for Embperl, it should also work
outside of Embperl e.g. with CGI.pm or mod_perl.
It can be extended by new validation rules for
additional syntaxes (e.g. US zip codes, German
Postleitzahlen, number plates, iso-3166 2-digit language or country
codes, etc.)
Each module has the ability to rely it's answer on parameters like
e.g. the browser, which caused the request for or submitted the form.
The module fully supports internationalisation. Any message can be
provided in multiple languages and it makes use of Embperl's
multilanguage support.
=head1 SYNOPSIS
use Embperl::Form::Validate;
my $epf = new Embperl::Form::Validate($rules, $form_id);
$epf->add_rule('fnord', $fnord_rules);
# validate the form values and returns error information, if any
my $result = $epf -> validate ;
# Does the form content validate?
print 'Validate: ' . ($result?'no':'yes');
# validate the form values and reaturn all error messages, if any
my $errors = $epf->validate_messages($fdat, $pref);
# Get the code for a client-side form validation according to the
# rules given to new:
$epf -> get_script_code ;
=head1 METHODS
The following methods are available:
=head2 $epf = Embperl::Form::Validate -> new ($rules [, $form_id ], [$default_language], [$charset]);
Constructor for a new form validator. Returns a reference to a
Embperl::Form::Validate object.
=over
=item $rules
should be a reference to an array of rules, see L<"RULES"> elsewhere in this
document for details.
=item $form_id
should be the name (im HTML) or id (in XHTML) parameter of
the form tag, which has to be verified.It\'s e.g. used for
generating the right path in the JavaScript DOM. It defaults to 'forms[0]'
which should be the first form in your page.
=item $default_language
language to use when no messages are available in the desired language.
Defaults to 'en'.
=item $charset
Pass 'utf-8' in case you want utf-8 messages.
=back
=cut
sub new
{
my $invokedby = shift;
my $class = ref($invokedby) || $invokedby;
my ($frules, $form_id, $default_language, $charset) = @_ ;
my $self = {
form_id => $form_id || 'forms[0]', # The name
frules => $frules || [], # \@frules
default_language => $default_language || 'en',
charset => $charset || 'iso8859-15',
};
bless($self, $class);
$self->init;
return $self;
}
###
### init() yet undocumented. The only purpose of init() is too allow
### to add functionality without rewriting the whole new() method.
###
sub init # $self
{
my $self = shift;
return 1;
}
=head2 $epf->add_rules($field, $field_rules);
Adds rules $field_rules for a (new) field $field to the validator,
e.g.
$epf->add_rule([ -key => 'fnord', -type => 'Number', -max => 1.3, -name => 'Fnord' ]);
The new rule will be appended to the end of the list of rules.
See L<"RULES"> elsewhere in this document.
=cut
sub add_rule # $self, $field, \%rules
{
my $self = shift;
my $rules = shift;
push @{$self->{frules}}, $rules;
return 1;
}
=head2 $epf -> validate ([$fdat, [$pref]]);
Does the server-side form validation.
=over
=item $fdat
should be a hash reference to all postend form values.
It defaults to %fdat of the current Embperl page.
=item $pref
can contain addtional information for the validation process.
At the moment the keys C<language> and C<default_language>
are recognized. C<language> defaults to the language set by
Embperl. C<default_language> defaults to the one given with C<new>.
=back
The method verifies the content $fdat according to the rules given
to the Embperl::Form::Validate
constructor and added by the add_rule() method and returns an
array refernce to error information. If there is no error it
returns undef. Each element of the returned array contains a hash with
the following keys:
=over
=item key
key into $fdat which caused the error
=item id
message id
=item typeobj
object reference to the Validate object which was used to validate the field
=item name
human readable name, if any. Maybe a hash with multiple languages.
=item msg
field specific messages, if any. Maybe a hash with multiple languages.
=item param
array with parameters which should subsituted inside the message
=back
=cut
sub loadtype
{
my ($self, $type) = @_ ;
eval "require $type;";
die 'Died inside '.__PACKAGE__.'::loadtype::eval: '.$@ if $@;
return $type;
}
sub newtype
{
my ($self, $type) = @_ ;
$type ||= 'Default';
$type = 'Embperl::Form::Validate::'.$type
unless $type =~ m!(::|/)!;
my $obj = $self -> {typeobjs}{$type} ;
return $obj if ($obj) ;
$type = $self -> loadtype ($type) ;
$obj = $self -> {typeobjs}{$type} = $type -> new ;
return $obj ;
}
sub validate_rules
{
my ($self, $frules, $fdat, $pref, $result) = @_ ;
my %param ;
my $type ;
my $typeobj ;
my $i ;
my $keys = [] ;
my $key ;
my $status ;
my $name ;
my $msg ;
my $break = 0 ;
while ($i < @$frules)
{
my $action = $frules -> [$i++] ;
if (ref $action eq 'ARRAY')
{
my $fail = $self -> validate_rules ($action, $fdat, $pref, $result) ;
return $fail if ($fail) ;
}
elsif (ref $action eq 'CODE')
{
my $arg = $frules -> [$i++] ;
foreach my $k (@$keys)
{
$status = &$action($k, $fdat -> {$k}, $arg, $fdat, $pref) ;
last if (!$status) ;
}
}
elsif ($action =~ /^-(.*?)$/)
{
if ($1 eq 'key')
{
$key = $frules->[$i++] ;
$keys = ref $key?$key:[$key] ;
$type = 'Default' ;
$typeobj = $self -> newtype ($type) ;
$name = undef ;
$msg = undef ;
}
elsif ($1 eq 'name')
{
$name = $i++ ;
}
elsif ($1 eq 'msg')
{
$msg = $i++ ;
}
elsif ($1 eq 'break')
{
$break = $frules->[$i++] ;
}
elsif ($1 eq 'type')
{
$type = $frules->[$i++] ;
$typeobj = $self -> newtype ($type) ;
foreach my $k (@$keys)
{
$status = $typeobj -> validate ($k, $fdat -> {$k}, $fdat, $pref) ;
last if (!$status) ;
}
}
else
{
$param{$1} = 1 ;
}
}
else
{
my $arg = $frules -> [$i++] ;
foreach my $k (@$keys)
{
my $method = 'validate_' . $action ;
$status = $typeobj -> $method ($k, $fdat -> {$k}, $arg, $fdat, $pref) ;
last if (!$status) ;
}
}
if ($status)
{
if (@$status && !$break)
{
my $id = $status -> [0] ;
push @$result, { typeobj => $typeobj, id => $id, key => $key, ($name?(name => $frules -> [$name]):()), ($msg?(msg => $frules -> [$msg]):()), param => $status} ;
}
last if (!$param{cont})
}
}
return $param{fail} ;
}
sub validate
{
my ($self, $fdat, $pref, $epreq) = @_ ;
$epreq ||= $Embperl::req ;
$fdat ||= $epreq -> thread -> form_hash ;
my @result ;
$self -> validate_rules ($self->{frules}, $fdat, $pref, \@result) ;
return \@result ;
}
sub build_message
{
my ($self, $id, $key, $name, $msg, $param, $typeobj, $pref, $epreq) = @_ ;
my $language = $pref -> {language} ;
my $default_language = $pref -> {default_language} || $self -> {default_language} ;
my $charset = $pref -> {charset} ;
my $txt ;
$name ||= $epreq?$epreq -> gettext($key):$key ;
if (ref $name eq 'ARRAY')
{
my @names ;
foreach my $n (@$name)
{
push @names, ref $n ? ($n -> {"$language.$charset"} || $n -> {"$default_language.$charset"} || $n -> {$language} || $n -> {$default_language} || (each %$n)[1] || $key):$n ;
}
$name = join (', ', @names) ;
}
else
{
$name = ref $name ? ($name -> {"$language.$charset"} || $name -> {"$default_language.$charset"} || $name -> {$language} || $name -> {$default_language} || (each %$name)[1] || $key):$name ;
}
if ($msg)
{
$txt = ref $msg ? ($msg -> {"$language.$charset"} || $msg -> {"$default_language.$charset"} || $msg -> {$language} || $msg -> {$default_language} || (each %$msg)[1] || undef):$msg ;
}
else
{
$txt = $typeobj -> getmsg ($id, "$language.$charset", "$default_language.$charset") ;
$txt ||= $typeobj -> getmsg ($id, $language, $default_language) ;
}
$txt = $epreq -> gettext($id) if (!$txt && $epreq) ;
$txt ||= "Missing Message $id: %0 %1 %2 %3" ;
$id = $param -> [0] ;
$param -> [0] = $name ;
my @param ;
eval "require Encode" ;
if ($charset && $has_encode)
{
@param = map { Encode::encode($charset, $_) } @$param ;
}
else
{
@param = @$param ;
}
$txt =~ s/%(\d+)/$param[$1]/g ;
$param -> [0] = $id ;
return $txt ;
}
=pod
=head2 $epf -> error_message ($err, [ $pref ])
Converts one item returned by validate into a error message
=over
=item $err
Item returned by validate
=item $pref
Preferences (see L<validate>)
=back
=cut
sub error_message
{
my ($self, $err, $pref, $epreq) = @_ ;
$epreq ||= $Embperl::req ;
return $self -> build_message ($err -> {id}, $err -> {key}, $err -> {name}, $err -> {msg}, $err -> {param}, $err -> {typeobj}, $pref, $epreq) ;
}
=pod
=head2 $epf -> validate_messages ($fdat, [ $pref ])
Validate the form content and returns the error messages
as array ref if any. See L<validate> for details.
=cut
sub validate_messages
{
my ($self, $fdat, $pref, $epreq) = @_ ;
$epreq ||= $Embperl::req ;
$pref -> {language} ||= $epreq -> param -> language if ($epreq) ;
$pref -> {default_language} ||= $self -> {default_language} ;
$pref -> {charset} ||= $self -> {charset} ;
my $result = $self -> validate ($fdat, $pref, $epreq) ;
return [] if (!@$result) ;
my @msgs ;
foreach my $err (@$result)
{
my $msg = $self -> build_message ($err -> {id}, $err -> {key}, $err -> {name}, $err -> {msg}, $err -> {param}, $err -> {typeobj}, $pref, $epreq) ;
push @msgs, $msg ;
}
return \@msgs ;
}
sub gather_script_code
{
my ($self, $frules, $pref, $epreq) = @_ ;
my %param ;
my $type ;
my $typeobj ;
my $i ;
my $keys = [] ;
my $key ;
my $status ;
my $name ;
my $msg ;
my $msgparam ;
my $language = $pref -> {language} ;
my $default_language = $pref -> {default_language} || 'en' ;
my $scriptcode = $self -> {scriptcode} ||= {} ;
my $script = '' ;
my $form = $self -> {form_id} ;
my $break = 0 ;
while ($i < @$frules)
{
my $arg ;
my $method ;
my $action = $frules -> [$i++] ;
if (ref $action eq 'ARRAY')
{
$script .= $self -> gather_script_code ($action, $pref, $epreq) ;
}
elsif (ref $action eq 'CODE')
{
$i++ ;
}
elsif ($action =~ /^-(.*?)$/)
{
if ($1 eq 'key')
{
$key = $frules->[$i++] ;
$keys = ref $key?$key:[$key] ;
$type = 'Default' ;
$typeobj = $self -> newtype ($type) ;
$name = undef ;
$msg = undef ;
}
elsif ($1 eq 'name')
{
$name = $i++ ;
}
elsif ($1 eq 'msg')
{
$msg = $i++ ;
}
elsif ($1 eq 'break')
{
$break = $frules->[$i++] ;
}
elsif ($1 eq 'type')
{
$type = $frules->[$i++] ;
$typeobj = $self -> newtype ($type) ;
$method = 'getscript_validate' ;
$arg = '' ;
}
else
{
$param{$1} = 1 ;
}
}
else
{
$method = 'getscript_' . $action ;
$arg = $frules -> [$i++] ;
}
if ($method)
{
my $code ;
my $ret ;
my $k = "$type*$action*$arg" ;
if (!exists ($scriptcode -> {$k}))
{
if ($typeobj -> can ($method))
{
($code, $msgparam) = $typeobj -> $method ($arg, $pref, $form) ;
$scriptcode -> {$k} = [$code, $msgparam] ;
}
else
{
$code = '' ;
$scriptcode -> {$k} = '' ;
}
}
else
{
if ($scriptcode -> {$k})
{
$code = $scriptcode -> {$k}[0] ;
$msgparam = $scriptcode -> {$k}[1] ;
}
}
if ($code)
{
my $nametxt = $name?$frules -> [$name]:undef ;
my $msgtxt = $msg?$frules -> [$msg]:undef ;
my $setmsg = '' ;
if ($msgparam && !$break)
{
my $txt = $self -> build_message ($msgparam -> [0], $key, $nametxt, $msgtxt, $msgparam, $typeobj, $pref, $epreq) ;
$setmsg = "ids[i] = '$key' ; msgs[i++]='$txt';"
}
if (!ref $key)
{
$script .= "obj = formelem\['$key'\] ; if (obj && !($code)) { $setmsg " . ($param{fail}?'fail=1;break;':($param{cont}?'':'break;')) . "}\n" ;
}
else
{
foreach my $k (@$keys)
{
$script .= "obj = formelem\['$k'\] ; if (obj && !($code)) {" ;
}
$script .= " $setmsg " . ($param{fail}?'fail=1;break;':($param{cont}?'':'break;')) . "\n" ;
foreach my $k (@$keys)
{
$script .= "}" ;
}
}
}
}
}
if ($script)
{
return qq{
do {
$script
} while (0) ; if (fail) break ;
} ;
}
return '' ;
}
=pod
=head2 $epf -> get_script_code ([$pref])
Returns the script code necessary to do the client-side validation.
Put the result between <SCRIPT> and </SCRIPT> tags inside your page.
It will contain a function that is named C<epform_validate_<name_of_your_form>>
where <name_of_your_form> is replaced by the form named you have passed
to L<new>. You should call this function in the C<onSubmit> of your form.
Example:
<script>
[+ do { local $escmode = 0 ; $epf -> get_script_code } +]
</script>
<form name="foo" action="POST" onSubmit="return epform_validate_foo()">
....
</form>
=cut
sub get_script_code
{
my ($self, $pref, $epreq) = @_ ;
$epreq ||= $Embperl::req ;
$pref ||= {} ;
$pref -> {language} ||= $epreq -> param -> language if ($epreq) ;
$pref -> {default_language} ||= $self -> {default_language} ;
$pref -> {charset} ||= $self -> {charset} ;
my $script ;
$script = $self -> gather_script_code ($self->{frules}, $pref, $epreq) ;
my $fname = $self -> {form_id} ;
$fname =~ s/([^a-zA-Z0-9_])/_/g ;
return qq{
function epform_validate_$fname(return_msgs, failed_class, formelem)
{
var msgs = new Array ;
var ids = new Array ;
var fail = 0 ;
var i = 0 ;
var obj ;
if (!formelem)
formelem = document.$fname ;
do {
$script ;
}
while (0) ;
if (failed_class)
{
var key ;
var i ;
for (key in ids)
{
var elems = formelem\[ids[key]\] ;
if (elems)
{
if (!(elems instanceof NodeList))
elems = [elems] ;
if (elems[0] instanceof NodeList)
elems = elems[0] ;
for (i = 0; i < elems.length ;i++)
{
var elem = elems[i] ;
if (elem.getAttribute('type') == 'radio')
elem = elem.parentElement ;
var eclass = elem.getAttribute('class') ;
elem.setAttribute ('class', eclass + ' ' + failed_class) ;
elem.setAttribute ('title', msgs[key]) ;
}
}
}
}
if (return_msgs)
{
var ret = [msgs, ids] ;
return ret ;
}
if (i)
alert (msgs.join('\\n')) ;
return !i ;
}
} ;
}
=head1 DATA STRUCTURES
The functions and methods expect the named data structures as follows:
=head2 RULES
The $rules array contains a list of tests to perform. Alls the given tests
are process sequenzially. You can group tests together, so when one test fails
the remaining tests of the same group are not processed and the processing
continues in the next outer group with the next test.
[
[
-key => 'lang',
-name => 'Language'
required => 1,
length_max => 5,
],
[
-key => 'from',
-type => 'EMail',
emptyok => 1,
],
-key => ['foo', 'bar']
required => 1,
]
All items starting with a dash are control elements, while all items
without a dash are tests to perform.
=over
=item -key
gives the key in the passed form data hash which should be tested. -key
is normally the name given in the HTML name attribute within a form field.
C<-key> can also be a arrayref, in which case B<only one of> the given keys
must statisfy the following test to succeed.
=item -name
is a human readable name that should be used in error messages. Can be
hash with multiple languages, e.g.
-name => { 'en' => 'date', 'de' => 'Datum' }
=item -type
specfify to not use the standard tests, but the ones for a special type.
For example there is a type C<Number> which will replaces all the comparsions
by numeric ones instead of string comparisions. You may add your own types
by writing a module that contains the necessary test and dropping it under
Embperl::Form::Validate::<Typename>. The -type directive also can verfiy
that the given data has a valid format for the type.
The following types are available:
=over
=item Default
This one is used when no type is specified. It contains all the standard
tests.
=item Number
Input must be a floating point number.
=item Integer
Input must be a integer number.
=item PosInteger
Input must be a integer number and greater or equal zero.
=item TimeHHMM
Input must be the time in the format hh::mm
=item TimeHHMMSS
Input must be the time in the format hh::mm:ss
=item TimeValue
Input must be a number followed by s, m, h, d or w.
=item EMail
Input must be a valid email address including a top level domain
e.g. user@example.com
=item EMailRFC
Input must be a valid email address, no top level domain is required,
so user@foo is also valid.
=item IPAddr
Input must be an ip-address in the form nnn.nnn.nnn.nnn
=item IPAddr_Mask
Input must be an ip-address and network mask in the form nnn.nnn.nnn.nnn/mm
=item FQDN_IPAddr
Input must be an ip-address or an fqdn (host.domain)
=item select
This used together with required and causes Embperl::Form::Validate
to test of a selected index != 0 instead of a non empty input.
=back
If you write your own type package,
make sure to send them back, so they can be part of the next distribution.
=item -msg
Used to give messages which should be used when the test fails. This message
overrides the standard messages provided by Embperl::Form::Validate and
by Embperls message management. Can also be a hash with messages for multiple
languages. The -msg parameter must preceed the test for which it should be
displayed. You can have multiple different messages for different tests, e.g.
[
-key => 'email',
-name => 'E-Mail-Address',
emptyok => 1, # it's ok to leave this field empty (in this case the following tests are skiped)
-msg => 'The E-Mail-Address is invalid.',
matches_regex => '(^[^ <>()@¡-ÿ]+@[^ <>()@¡-ÿ]+\.[a-zA-Z]{2,3}$)',
-msg => 'The E-Mail address must contain a "@".',
must_contain_one_of => '@',
-msg => 'The E-Mail address must contain at least one period.',
must_contain_one_of => '.',
],
=item -fail
stops further validation of any rule after the first error is found
=item -cont
continues validation in the same group, also a error was found
=item -break => 1
errors only break current block, but does not display any message.
-break => 0 turns bak to normal behaviour. This can be used for preconditions:
[
-key => 'action', emptyok => 1, -break => 1, ne => 0, -break => 0,
-key => 'input', 'required' => 1
]
The above example will only require the field "input", when the field "action" is
not empty and is not zero.
=item [arrayref]
you can place a arrayref with tests at any point in the rules list. The array will
be considered as a group and the default is the stop processing of a group as soon
as the first error is found and continue with processing with the next rule in the
next outer group.
=back
The following test are currently defined:
=over
=item required
=item emptyok
=item length_min
=item length_max
=item length_eq
=item eq
=item same
Value must be the same as in field given as argument. This is useful
if you want for example verify that two passwords are the same. The
Text displayed to the user for the second field maybe added to the argument
separeted by a colon. Example:
$epf = Embperl::Form::Validate -> new (
[
-key => 'pass', -name => 'Password', required => 1, length_min => 4,
-key => 'pass2', -name => 'Repeat Password', required => 1, length_min => 4,
same => 'pass:Password',
],
'passform') ;
=item ne
=item lt
=item gt
=item le
=item ge
=item matches_regex
Value must match B<Perl> regular expression. Only executed on server side.
=item matches_regex_js
Value must match B<JavaScript> regular expression. Only executed on client side.
B<IMPORTANT:> If the user has disabled JavaScript in his browser this test will
be never executed. Use a corresponding Perl Regex with C<matches_regex>
to get a server side validation. Use this with care, because different browser
may have different support for regular expressions.
=item not_matches_regex
Value must not match B<Perl> regular expression. Only executed on server side.
=item not_matches_regex_js
Value must not match B<JavaScript> regular expression. Only executed on client side.
B<IMPORTANT:> If the user has disabled JavaScript in his browser this test will
be never executed. Use a corresponding Perl Regex with C<not_matches_regex>
to get a server side validation. Use this with care, because different browser
may have different support for regular expressions.
=item matches_wildcard
=item must_only_contain
=item must_not_contain
=item must_contain_one_of
=item checked
Checkbox must be selected
=item notchecked
Checkbox must not be selected
=back
=head2 PREFERENCES
The $pref hash (reference) contains information about a single form
request or submission, e.g. the browser version, which made the
request or submission and the language in which the error messages
should be returned. See also L<validate>
=head2 ERROR CODES
For a descriptions of the error codes, validate is returning see L<validate>
=head2 FDAT
See also L<Embperl>.
my $fdat = { foo => 'foobar',
bar => 'baz',
baz => 49,
fnord => 1.2 };
=head1 Example
This example simply validates the form input when you hit submit.
If your input is correct, the form is redisplay with your input,
otherwise the error message is shown. If you turn off JavaScript
the validation is still done one the server-side. Any validation
for which no JavaScript validation is defined (like regex matches),
only the server-side validation is performed.
<html>
<head>
[-
use Embperl::Form::Validate ;
$epf = Embperl::Form::Validate -> new (
[
[
-key => 'name',
-name => 'Name',
required => 1,
length_min => 4,
],
[
-key => 'id',
-name => 'Id',
-type => 'Number',
gt => 0,
lt => 10,
],
[
-key => 'email',
-msg => 'This is not a valid E-Mail address',
must_contain_one_of => '@.',
matches_regex => '..+@..+\\...+',
length_min => 8,
],
[
-key => 'msg',
-name => 'Message',
emptyok => 1,
length_min => 10,
]
]) ;
if ($fdat{check})
{
$errors = $epf -> validate_messages ;
}
-]
<script>
[+ do { local $escmode = 0 ; $epf -> get_script_code } +]
</script>
</head>
<body>
<h1>Embperl Example - Input Form Validation</h1>
[$if @$errors $]
<h3>Please correct the following errors</h3>
[$foreach $e (@$errors)$]
<font color="red">[+ $e +]</font><br>
[$endforeach$]
[$else$]
<h3>Please enter your data</h3>
[$endif$]
<form action="formvalidation.htm" method="GET" onSubmit="return epform_validate_forms_0_()">
<table>
<tr><td><b>Name</b></td> <td><input type="text" name="name"></td></tr>
<tr><td><b>Id (1-9)</b></td> <td><input type="text" name="id"></td></tr>
<tr><td><b>E-Mail</b></td> <td><input type="text" name="email"></td></tr>
<tr><td><b>Message</b></td> <td><input type="text" name="msg"></td></tr>
<tr><td colspan=2><input type="submit" name="check" value="send"></td></tr>
</table>
</form>
<p><hr>
<small>Embperl (c) 1997-2010 G.Richter / ecos gmbh <a href="http://www.ecos.de">www.ecos.de</a></small>
</body>
</html>
See also eg/x/formvalidation.htm
=head1 SEE ALSO
See also L<Embperl>.
=head1 AUTHOR
Axel Beckert (abe@ecos.de)
Gerald Richter (richter at embperl dot org)
|