/[webpac2]/trunk/lib/WebPAC/Validate.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Validate.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 645 by dpavlin, Wed Sep 6 22:07:21 2006 UTC revision 828 by dpavlin, Sun May 20 16:19:17 2007 UTC
# Line 8  use blib; Line 8  use blib;
8  use base 'WebPAC::Common';  use base 'WebPAC::Common';
9  use File::Slurp;  use File::Slurp;
10  use List::Util qw/first/;  use List::Util qw/first/;
11  use Data::Dumper;  use Data::Dump qw/dump/;
12  use WebPAC::Normalize qw/_pack_subfields_hash/;  use WebPAC::Normalize qw/_pack_subfields_hash/;
13  use Storable qw/dclone/;  use Storable qw/dclone/;
14    
# Line 18  WebPAC::Validate - provide simple valida Line 18  WebPAC::Validate - provide simple valida
18    
19  =head1 VERSION  =head1 VERSION
20    
21  Version 0.03  Version 0.11
22    
23  =cut  =cut
24    
25  our $VERSION = '0.03';  our $VERSION = '0.11';
26    
27  =head1 SYNOPSIS  =head1 SYNOPSIS
28    
# Line 41  configuration file in following format: Line 41  configuration file in following format:
41    205! a    205! a
42    # while 210 can have a c or d    # while 210 can have a c or d
43    210 a c d    210 a c d
44      # field which is ignored in validation
45      999-
46    
47  =head1 FUNCTIONS  =head1 FUNCTIONS
48    
# Line 50  Create new validation object Line 52  Create new validation object
52    
53    my $validate = new WebPAC::Validate(    my $validate = new WebPAC::Validate(
54          path => 'conf/validate/file',          path => 'conf/validate/file',
55            delimiters => [ ' : ', ' / ', ' ; ', ' , ' ],
56    );    );
57    
58    Optional parametar C<delimiters> will turn on validating of delimiters. Be
59    careful here, those delimiters are just stuck into regex, so they can
60    contain L<perlre> regexpes.
61    
62  =cut  =cut
63    
64  sub new {  sub new {
# Line 86  sub new { Line 93  sub new {
93    
94                  if ($fld =~ s/!$//) {                  if ($fld =~ s/!$//) {
95                          $self->{must_exist}->{$fld}++;                          $self->{must_exist}->{$fld}++;
96                    } elsif ($fld =~ s/-$//) {
97                            $self->{dont_validate}->{$fld}++;
98                  }                  }
99    
100                  $log->logdie("need field name in line $curr_line: $l") unless (defined($fld));                  $log->logdie("need field name in line $curr_line: $l") unless (defined($fld));
101    
102                  if (@d) {                  if (@d) {
103                          $v->{$fld} = \@d;                          $v->{$fld} = [ map {
104                                    my $sf = $_;
105                                    if ( $sf =~ s/!(\*)?$/$1/ ) {
106                                            $self->{must_exist_sf}->{ $fld }->{ $sf }++;
107                                    };
108                                    $sf;
109                            } @d ];
110                  } else {                  } else {
111                          $v->{$fld} = 1;                          $v->{$fld} = 1;
112                  }                  }
113    
114          }          }
115    
116          $log->debug("current validation rules: ", Dumper($v));          $log->debug("current validation rules: ", dump($v));
117    
118          $self->{rules} = $v;          $self->{rules} = $v;
119    
120          $log->info("validation uses rules from $self->{path}");          $log->info("validation uses rules from $self->{path}");
121    
122            if ( $self->{delimiters} ) {
123                    $self->{delimiters_regex} = '(\^[a-z0-9]|' . join('|', @{ $self->{delimiters} }) . ')';
124                    $log->info("validation check delimiters with regex $self->{delimiters_regex}");
125            }
126    
127          $self ? return $self : return undef;          $self ? return $self : return undef;
128  }  }
129    
130  =head2 validate_errors  =head2 validate_rec
131    
132  Validate record and return errors  Validate record and return errors
133    
134    my @errors = $validate->validate_errors( $rec );    my @errors = $validate->validate_rec( $rec, $rec_dump );
135    
136  =cut  =cut
137    
138  sub validate_errors {  sub validate_rec {
139          my $self = shift;          my $self = shift;
140    
141          my $log = $self->_get_logger();          my $log = $self->_get_logger();
142    
143          my $rec = shift || $log->logdie("validate_errors need record");          my $rec = shift || $log->logdie("validate_rec need record");
144            my $rec_dump = shift;
145    
146          $log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');          $log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');
147          $log->logdie("can't find validation rules") unless (my $r = $self->{rules});          $log->logdie("can't find validation rules") unless (my $r = $self->{rules});
148    
149          my @errors;          my $errors;
150    
151          $log->debug("rec = ", sub { Dumper($rec) }, "keys = ", keys %{ $rec });          $log->debug("rec = ", sub { dump($rec) }, "keys = ", keys %{ $rec });
152    
153          my $fields;          my $fields;
154    
# Line 135  sub validate_errors { Line 156  sub validate_errors {
156    
157                  next if (!defined($f) || $f eq '' || $f eq '000');                  next if (!defined($f) || $f eq '' || $f eq '000');
158    
159                    # first check delimiters
160                    if ( my $regex = $self->{delimiters_regex} ) {
161    
162                            foreach my $v (@{ $rec->{$f} }) {
163                                            warn "## v = ", dump( $v );
164                                            my $l = _pack_subfields_hash( $v, 1 );
165                                            warn "## $l [$regex]\n";
166                                            my $template = '';
167                                            $l =~ s/$regex/$template.=$1/eg && warn "## new: $l\n";
168                                            warn "## template: $template\n";
169                                            $self->{_delimiters_templates}->{$f}->{$template}++ if ( $template );
170                            }
171    
172                    }
173    
174                    next if (defined( $self->{dont_validate}->{$f} ));
175    
176                    # track field usage
177                  $fields->{$f}++;                  $fields->{$f}++;
178    
179                  if ( ! defined($r->{$f}) ) {                  if ( ! defined($r->{$f}) ) {
180                          push @errors, "field '$f' shouldn't exists";                          $errors->{ $f }->{unexpected} = "this field is not expected";
181                          next;                          next;
182                  }                  }
183    
184    
185                  if (ref($rec->{$f}) ne 'ARRAY') {                  if (ref($rec->{$f}) ne 'ARRAY') {
186                          push @errors, "field '$f' isn't repetable, probably bug in parsing input data";                          $errors->{ $f }->{not_repeatable} = "probably bug in parsing input data";
187                          next;                          next;
188                  }                  }
189    
# Line 152  sub validate_errors { Line 191  sub validate_errors {
191                          # can we have subfields?                          # can we have subfields?
192                          if (ref($r->{$f}) eq 'ARRAY') {                          if (ref($r->{$f}) eq 'ARRAY') {
193                                  # are values hashes? (has subfields)                                  # are values hashes? (has subfields)
194                                  if (ref($v) ne 'HASH') {                                  if (! defined($v)) {
195                                          push @errors, "$f has value without subfields: $v";  #                                       $errors->{$f}->{empty} = undef;
196    #                                       $errors->{dump} = $rec_dump if ($rec_dump);
197                                    } elsif (ref($v) ne 'HASH') {
198                                            $errors->{$f}->{missing_subfield} = join(",", @{ $r->{$f} }) . " required";
199                                          next;                                          next;
200                                  } else {                                  } else {
201    
# Line 163  sub validate_errors { Line 205  sub validate_errors {
205    
206                                          delete($v->{subfields}) if (defined($v->{subfields}));                                          delete($v->{subfields}) if (defined($v->{subfields}));
207    
208                                            my $subfields;
209    
210                                          foreach my $sf (keys %{ $v }) {                                          foreach my $sf (keys %{ $v }) {
211    
212                                                    $subfields->{ $sf }++;
213    
214                                                  # is non-repeatable but with multiple values?                                                  # is non-repeatable but with multiple values?
215                                                  if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {                                                  if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {
216                                                          if ( ref($v->{$sf}) eq 'ARRAY' ) {                                                          if ( ref($v->{$sf}) eq 'ARRAY' ) {
217                                                                  $sf_repeatable->{$sf}++;                                                                  $sf_repeatable->{$sf}++;
218                                                          };                                                          };
219                                                          if (! first { $_ eq $sf } @{ $r->{$f} }) {                                                          if (! first { $_ eq $sf } @{ $r->{$f} }) {
220                                                                  push @errors, "$f has unknown subfield: $sf";                                                                  $errors->{ $f }->{subfield}->{extra}->{$sf}++;
221                                                          }                                                          }
222                                                  }                                                  }
223    
224                                          }                                          }
225                                          if (my @r_sf = sort keys( %$sf_repeatable )) {                                          if (my @r_sf = sort keys( %$sf_repeatable )) {
                                                 my $plural = $#r_sf > 0 ? 1 : 0;  
226    
227                                                  push @errors, "$f subfield" .                                                  foreach my $sf (@r_sf) {
228                                                  ( $plural ? 's ' : ' ' ) .                                                          $errors->{$f}->{subfield}->{extra_repeatable}->{$sf}++;
229                                                  join(', ', @r_sf) .                                                          $errors->{$f}->{dump} = _pack_subfields_hash( $h, 1 );
230                                                  ( $plural ? ' are ' : ' is ' ) .                                                  }
231                                                  'repeatable in: ' .  
232                                                  join('', _pack_subfields_hash( $h, 1) );                                          }
233    
234                                            if ( defined( $self->{must_exist_sf}->{$f} ) ) {
235                                                    foreach my $sf (sort keys %{ $self->{must_exist_sf}->{$f} }) {
236    #warn "====> $f $sf must exist\n";
237                                                            $errors->{$f}->{subfield}->{missing}->{$sf}++
238                                                                    unless defined( $subfields->{$sf} );
239                                                    }
240                                          }                                          }
241    
242                                  }                                  }
243                          } elsif (ref($v) eq 'HASH') {                          } elsif (ref($v) eq 'HASH') {
244                                  push @errors, "$f has subfields which is not valid";                                  $errors->{$f}->{unexpected_subfields}++;
245                                    $errors->{$f}->{dump} = _pack_subfields_hash( $v, 1 );
246                          }                          }
247                  }                  }
248          }          }
249    
250            $log->debug("_delimiters_templates = ", dump( $self->{_delimiters_templates} ) );
251    
252          foreach my $must (sort keys %{ $self->{must_exist} }) {          foreach my $must (sort keys %{ $self->{must_exist} }) {
253                  next if ($fields->{$must});                  next if ($fields->{$must});
254                  push @errors,                  $errors->{$must}->{missing}++;
255                          "field $must should exist, but it doesn't";                  $errors->{dump} = $rec_dump if ($rec_dump);
256            }
257    
258            if ($errors) {
259                    $log->debug("errors: ", $self->report_error( $errors ) );
260    
261                    my $mfn = $rec->{'000'}->[0] || $log->logconfess("record ", dump( $rec ), " doesn't have MFN");
262                    $self->{errors}->{$mfn} = $errors;
263          }          }
264    
265          #$log->logcluck("return from this function is ARRAY") unless wantarray;          #$log->logcluck("return from this function is ARRAY") unless wantarray;
266    
267          $log->debug("errors: ", join(", ", @errors)) if (@errors);          return $errors;
268    }
269    
270    =head2 reset_errors
271    
272    Clean all accumulated errors for this input
273    
274      $validate->reset_errors;
275    
276    =cut
277    
278    sub reset_errors {
279            my $self = shift;
280            delete ($self->{errors});
281    }
282    
283    =head2 all_errors
284    
285    Return hash with all errors
286    
287      print dump( $validate->all_errors );
288    
289    =cut
290    
291    sub all_errors {
292            my $self = shift;
293            return $self->{errors};
294    }
295    
296    =head2 report_error
297    
298    Produce nice humanly readable report of single error
299    
300      print $validate->report_error( $error_hash );
301    
302    =cut
303    
304    sub report_error {
305            my $self = shift;
306    
307            my $h = shift || die "no hash?";
308    
309            sub _unroll {
310                    my ($self, $tree, $accumulated) = @_;
311    
312                    my $log = $self->_get_logger();
313    
314                    $log->debug("# ",
315                            ( $tree                 ? "tree: $tree "                                        : '' ),
316                            ( $accumulated  ? "accumulated: $accumulated "          : '' ),
317                    );
318    
319                    my $results;
320    
321                    if (ref($tree) ne 'HASH') {
322                            return ("$accumulated\t($tree)", undef);
323                    }
324    
325                    my $dump;
326    
327                    foreach my $k (sort keys %{ $tree }) {
328    
329                            if ($k eq 'dump') {
330                                    $dump = $tree->{dump};
331    #                               warn "## dump: ",dump($dump),"\n";
332                                    next;
333                            }
334    
335                            $log->debug("current: $k");
336    
337                            my ($new_results, $new_dump) = $self->_unroll($tree->{$k},
338                                    $accumulated ? "$accumulated\t$k" : $k
339                            );
340    
341                            $log->debug(
342                                    ( $new_results          ? "new_results: " . dump($new_results) ." "     : '' ),
343                            );
344    
345                            push @$results, $new_results if ($new_results);
346                            $dump = $new_dump if ($new_dump);
347    
348                    }
349    
350                    $log->debug(
351                            ( $results              ? "results: " . dump($results) ." "     : '' ),
352                    );
353    
354                    if ($#$results == 0) {
355                            return ($results->[0], $dump);
356                    } else {
357                            return ($results, $dump);
358                    }
359            }
360    
361    
362            sub _reformat {
363                    my $l = shift;
364                    $l =~ s/\t/ /g;
365                    $l =~ s/_/ /;
366                    return $l;
367            }
368    
369            my $out = '';
370    
371            for my $f (sort keys %{ $h }) {
372                    $out .= "$f: ";
373                    
374                    my ($r, $d) = $self->_unroll( $h->{$f} );
375                    my $e;
376                    if (ref($r) eq 'ARRAY') {
377                            $e .= join(", ", map { _reformat( $_ ) } @$r);
378                    } else {
379                            $e .= _reformat( $r );
380                    }
381                    $e .= "\n\t$d" if ($d);
382    
383                    $out .= $e . "\n";
384            }
385            return $out;
386    }
387    
388    
389    =head2 report
390    
391    Produce nice humanly readable report of errors
392    
393      print $validate->report;
394    
395    =cut
396    
397    sub report {
398            my $self = shift;
399            my $e = $self->{errors} || return;
400    
401            my $out;
402            foreach my $mfn (sort { $a <=> $b } keys %$e) {
403                    $out .= "MFN $mfn\n" . $self->report_error( $e->{$mfn} ) . "\n";
404            }
405    
406            return $out;
407    
         return @errors;  
408  }  }
409    
410  =head1 AUTHOR  =head1 AUTHOR
Legend:
Removed from v.645  
changed lines
  Added in v.828
  ViewVC Help
Powered by ViewVC 1.1.26