lib/WebPAC/Validate.pm

package WebPAC::Validate;

use warnings;
use strict;

use blib;

use base 'WebPAC::Common';
use File::Slurp;
use List::Util qw/first/;
use Data::Dump qw/dump/;
use WebPAC::Normalize qw/_pack_subfields_hash/;
use Storable qw/dclone/;

=head1 NAME

WebPAC::Validate - provide simple validation for records

=head1 VERSION

Version 0.06

=cut

our $VERSION = '0.06';

=head1 SYNOPSIS

This module provide a simple way to validate your file against a simple
configuration file in following format:

  # field 10 doesn't have any subfields
  10
  # same with 101
  101
  # field 200 have valid subfields a-g
  # and field e is repeatable
  200 a b c d e* f g
  # field 205 can have only subfield a
  # and must exists
  205! a
  # while 210 can have a c or d
  210 a c d

=head1 FUNCTIONS

=head2 new

Create new validation object

  my $validate = new WebPAC::Validate(
        path => 'conf/validate/file',
  );

=cut

sub new {
        my $class = shift;
        my $self = {@_};
        bless($self, $class);

        my $log = $self->_get_logger();

        foreach my $p (qw/path/) {
                $log->logconfess("need $p") unless ($self->{$p});
        }

        my $v_file = read_file( $self->{path} ) ||
                $log->logdie("can't open validate path $self->{path}: $!");

        my $v;
        my $curr_line = 1;

        foreach my $l (split(/[\n\r]+/, $v_file)) {
                $curr_line++;

                # skip comments and whitespaces
                next if ($l =~ /^#/ || $l =~ /^\s*$/);

                $l =~ s/^\s+//;
                $l =~ s/\s+$//;

                my @d = split(/\s+/, $l);

                my $fld = shift @d;

                if ($fld =~ s/!$//) {
                        $self->{must_exist}->{$fld}++;
                }

                $log->logdie("need field name in line $curr_line: $l") unless (defined($fld));

                if (@d) {
                        $v->{$fld} = [ map {
                                my $sf = $_;
                                if ( $sf =~ s/!(\*)?$/$1/ ) {
                                        $self->{must_exist_sf}->{ $fld }->{ $sf }++;
                                };
                                $sf;
                        } @d ];
                } else {
                        $v->{$fld} = 1;
                }

        }

        $log->debug("current validation rules: ", dump($v));

        $self->{rules} = $v;

        $log->info("validation uses rules from $self->{path}");

        $self ? return $self : return undef;
}

=head2 validate_errors

Validate record and return errors

  my @errors = $validate->validate_errors( $rec );

=cut

sub validate_errors {
        my $self = shift;

        my $log = $self->_get_logger();

        my $rec = shift || $log->logdie("validate_errors need record");

        $log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');
        $log->logdie("can't find validation rules") unless (my $r = $self->{rules});

        my $errors;

        $log->debug("rec = ", sub { dump($rec) }, "keys = ", keys %{ $rec });

        my $fields;

        foreach my $f (keys %{ $rec }) {

                next if (!defined($f) || $f eq '' || $f eq '000');

                $fields->{$f}++;

                if ( ! defined($r->{$f}) ) {
                        $errors->{field}->{ $f }->{extra} = "not expected";
                        next;
                }


                if (ref($rec->{$f}) ne 'ARRAY') {
                        $errors->{field}->{ $f }->{not_repeatable} = "probably bug in parsing input data";
                        next;
                }

                foreach my $v (@{ $rec->{$f} }) {
                        # can we have subfields?
                        if (ref($r->{$f}) eq 'ARRAY') {
                                # are values hashes? (has subfields)
                                if (! defined($v)) {
                                        $errors->{field}->{$f}->{empty} = undef;
                                        $errors->{dump}->{record}++;
                                } elsif (ref($v) ne 'HASH') {
                                        $errors->{field}->{$f}->{missing_subfield} = "value without subfields: $v";
                                        next;
                                } else {

                                        my $h = dclone( $v );

                                        my $sf_repeatable;

                                        delete($v->{subfields}) if (defined($v->{subfields}));

                                        my $subfields;

                                        foreach my $sf (keys %{ $v }) {

                                                $subfields->{ $sf }++;

                                                # is non-repeatable but with multiple values?
                                                if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {
                                                        if ( ref($v->{$sf}) eq 'ARRAY' ) {
                                                                $sf_repeatable->{$sf}++;
                                                        };
                                                        if (! first { $_ eq $sf } @{ $r->{$f} }) {
                                                                $errors->{field}->{ $f }->{subfield}->{$sf} = "unknown";
                                                        }
                                                }

                                        }
                                        if (my @r_sf = sort keys( %$sf_repeatable )) {

                                                foreach my $sf (@r_sf) {
                                                        $errors->{field}->{$f}->{subfield}->{$sf} = "repeatable";
                                                        $errors->{dump}->{field}->{$f} =
                                                                join('', _pack_subfields_hash( $h, 1 ) );
                                                }

                                        }

                                        if ( defined( $self->{must_exist_sf}->{$f} ) ) {
                                                foreach my $sf (sort keys %{ $self->{must_exist_sf}->{$f} }) {
#warn "====> $f $sf must exist\n";
                                                        $errors->{field}->{$f}->{subfield}->{$sf} = "missing"
                                                                unless defined( $subfields->{$sf} );
                                                }
                                        }

                                }
                        } elsif (ref($v) eq 'HASH') {
                                $errors->{field}->{$f}->{unexpected_subfields}++;
                                $errors->{dump}->{field}->{$f} =
                                        join('', _pack_subfields_hash( $v, 1 ) );
                        }
                }
        }

        foreach my $must (sort keys %{ $self->{must_exist} }) {
                next if ($fields->{$must});
                $errors->{field}->{$must}->{missing}++;
                $errors->{dump}->{record}++;
        }

        if ($errors) {
                $log->debug("errors: ", sub { dump( $errors ) } );

                my $mfn = $rec->{'000'}->[0];
                $self->{errors}->{$mfn} = $errors;
        }

        #$log->logcluck("return from this function is ARRAY") unless wantarray;

        return $errors;
}

=head1 AUTHOR

Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>

=head1 COPYRIGHT & LICENSE

Copyright 2006 Dobrica Pavlinusic, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1; # End of WebPAC::Validate
1	dpavlin	514	package WebPAC::Validate;
2
3			use warnings;
4			use strict;
5
6			use blib;
7
8			use base 'WebPAC::Common';
9			use File::Slurp;
10	dpavlin	515	use List::Util qw/first/;
11	dpavlin	652	use Data::Dump qw/dump/;
12	dpavlin	643	use WebPAC::Normalize qw/_pack_subfields_hash/;
13			use Storable qw/dclone/;
14	dpavlin	514
15			=head1 NAME
16
17			WebPAC::Validate - provide simple validation for records
18
19			=head1 VERSION
20
21	dpavlin	652	Version 0.06
22	dpavlin	514
23			=cut
24
25	dpavlin	652	our $VERSION = '0.06';
26	dpavlin	514
27			=head1 SYNOPSIS
28
29			This module provide a simple way to validate your file against a simple
30			configuration file in following format:
31
32			# field 10 doesn't have any subfields
33			10
34			# same with 101
35			101
36			# field 200 have valid subfields a-g
37	dpavlin	645	# and field e is repeatable
38			200 a b c d e* f g
39	dpavlin	514	# field 205 can have only subfield a
40	dpavlin	645	# and must exists
41			205! a
42	dpavlin	514	# while 210 can have a c or d
43			210 a c d
44
45			=head1 FUNCTIONS
46
47			=head2 new
48
49			Create new validation object
50
51			my $validate = new WebPAC::Validate(
52	dpavlin	643	path => 'conf/validate/file',
53	dpavlin	514	);
54
55			=cut
56
57			sub new {
58			my $class = shift;
59			my $self = {@_};
60			bless($self, $class);
61
62			my $log = $self->_get_logger();
63
64			foreach my $p (qw/path/) {
65			$log->logconfess("need $p") unless ($self->{$p});
66			}
67
68			my $v_file = read_file( $self->{path} ) \|\|
69			$log->logdie("can't open validate path $self->{path}: $!");
70
71			my $v;
72			my $curr_line = 1;
73
74			foreach my $l (split(/[\n\r]+/, $v_file)) {
75			$curr_line++;
76
77	dpavlin	516	# skip comments and whitespaces
78			next if ($l =~ /^#/ \|\| $l =~ /^\s*$/);
79
80	dpavlin	514	$l =~ s/^\s+//;
81			$l =~ s/\s+$//;
82
83			my @d = split(/\s+/, $l);
84
85	dpavlin	516	my $fld = shift @d;
86	dpavlin	514
87	dpavlin	645	if ($fld =~ s/!$//) {
88			$self->{must_exist}->{$fld}++;
89			}
90
91	dpavlin	516	$log->logdie("need field name in line $curr_line: $l") unless (defined($fld));
92
93	dpavlin	514	if (@d) {
94	dpavlin	646	$v->{$fld} = [ map {
95			my $sf = $_;
96			if ( $sf =~ s/!(\*)?$/$1/ ) {
97			$self->{must_exist_sf}->{ $fld }->{ $sf }++;
98			};
99			$sf;
100			} @d ];
101	dpavlin	514	} else {
102	dpavlin	515	$v->{$fld} = 1;
103	dpavlin	514	}
104
105			}
106
107	dpavlin	652	$log->debug("current validation rules: ", dump($v));
108	dpavlin	514
109			$self->{rules} = $v;
110
111	dpavlin	516	$log->info("validation uses rules from $self->{path}");
112
113	dpavlin	514	$self ? return $self : return undef;
114			}
115
116	dpavlin	515	=head2 validate_errors
117
118			Validate record and return errors
119
120			my @errors = $validate->validate_errors( $rec );
121
122			=cut
123
124			sub validate_errors {
125			my $self = shift;
126
127			my $log = $self->_get_logger();
128
129			my $rec = shift \|\| $log->logdie("validate_errors need record");
130
131			$log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');
132			$log->logdie("can't find validation rules") unless (my $r = $self->{rules});
133
134	dpavlin	652	my $errors;
135	dpavlin	515
136	dpavlin	652	$log->debug("rec = ", sub { dump($rec) }, "keys = ", keys %{ $rec });
137	dpavlin	515
138	dpavlin	645	my $fields;
139
140	dpavlin	515	foreach my $f (keys %{ $rec }) {
141
142	dpavlin	516	next if (!defined($f) \|\| $f eq '' \|\| $f eq '000');
143	dpavlin	515
144	dpavlin	645	$fields->{$f}++;
145
146			if ( ! defined($r->{$f}) ) {
147	dpavlin	652	$errors->{field}->{ $f }->{extra} = "not expected";
148	dpavlin	515	next;
149			}
150
151	dpavlin	645
152	dpavlin	515	if (ref($rec->{$f}) ne 'ARRAY') {
153	dpavlin	652	$errors->{field}->{ $f }->{not_repeatable} = "probably bug in parsing input data";
154	dpavlin	515	next;
155			}
156
157			foreach my $v (@{ $rec->{$f} }) {
158			# can we have subfields?
159			if (ref($r->{$f}) eq 'ARRAY') {
160			# are values hashes? (has subfields)
161	dpavlin	652	if (! defined($v)) {
162			$errors->{field}->{$f}->{empty} = undef;
163			$errors->{dump}->{record}++;
164			} elsif (ref($v) ne 'HASH') {
165			$errors->{field}->{$f}->{missing_subfield} = "value without subfields: $v";
166	dpavlin	515	next;
167			} else {
168	dpavlin	643
169			my $h = dclone( $v );
170
171	dpavlin	645	my $sf_repeatable;
172
173	dpavlin	643	delete($v->{subfields}) if (defined($v->{subfields}));
174
175	dpavlin	646	my $subfields;
176
177	dpavlin	515	foreach my $sf (keys %{ $v }) {
178	dpavlin	643
179	dpavlin	646	$subfields->{ $sf }++;
180
181	dpavlin	645	# is non-repeatable but with multiple values?
182			if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {
183			if ( ref($v->{$sf}) eq 'ARRAY' ) {
184			$sf_repeatable->{$sf}++;
185			};
186			if (! first { $_ eq $sf } @{ $r->{$f} }) {
187	dpavlin	652	$errors->{field}->{ $f }->{subfield}->{$sf} = "unknown";
188	dpavlin	645	}
189	dpavlin	515	}
190	dpavlin	643
191	dpavlin	515	}
192	dpavlin	645	if (my @r_sf = sort keys( %$sf_repeatable )) {
193
194	dpavlin	652	foreach my $sf (@r_sf) {
195			$errors->{field}->{$f}->{subfield}->{$sf} = "repeatable";
196			$errors->{dump}->{field}->{$f} =
197			join('', _pack_subfields_hash( $h, 1 ) );
198			}
199
200	dpavlin	645	}
201	dpavlin	646
202			if ( defined( $self->{must_exist_sf}->{$f} ) ) {
203			foreach my $sf (sort keys %{ $self->{must_exist_sf}->{$f} }) {
204	dpavlin	647	#warn "====> $f $sf must exist\n";
205	dpavlin	652	$errors->{field}->{$f}->{subfield}->{$sf} = "missing"
206			unless defined( $subfields->{$sf} );
207	dpavlin	646	}
208			}
209
210	dpavlin	515	}
211			} elsif (ref($v) eq 'HASH') {
212	dpavlin	652	$errors->{field}->{$f}->{unexpected_subfields}++;
213			$errors->{dump}->{field}->{$f} =
214			join('', _pack_subfields_hash( $v, 1 ) );
215	dpavlin	515	}
216			}
217			}
218
219	dpavlin	645	foreach my $must (sort keys %{ $self->{must_exist} }) {
220			next if ($fields->{$must});
221	dpavlin	652	$errors->{field}->{$must}->{missing}++;
222			$errors->{dump}->{record}++;
223	dpavlin	645	}
224
225	dpavlin	652	if ($errors) {
226			$log->debug("errors: ", sub { dump( $errors ) } );
227
228			my $mfn = $rec->{'000'}->[0];
229			$self->{errors}->{$mfn} = $errors;
230			}
231
232	dpavlin	515	#$log->logcluck("return from this function is ARRAY") unless wantarray;
233
234	dpavlin	652	return $errors;
235	dpavlin	515	}
236
237	dpavlin	514	=head1 AUTHOR
238
239			Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
240
241			=head1 COPYRIGHT & LICENSE
242
243			Copyright 2006 Dobrica Pavlinusic, All Rights Reserved.
244
245			This program is free software; you can redistribute it and/or modify it
246			under the same terms as Perl itself.
247
248			=cut
249
250			1; # End of WebPAC::Validate