/[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 643 by dpavlin, Wed Sep 6 21:10:30 2006 UTC revision 670 by dpavlin, Mon Sep 11 14:29:08 2006 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.02  Version 0.08
22    
23  =cut  =cut
24    
25  our $VERSION = '0.02';  our $VERSION = '0.08';
26    
27  =head1 SYNOPSIS  =head1 SYNOPSIS
28    
# Line 34  configuration file in following format: Line 34  configuration file in following format:
34    # same with 101    # same with 101
35    101    101
36    # field 200 have valid subfields a-g    # field 200 have valid subfields a-g
37    200 a b c d e f g    # and field e is repeatable
38      200 a b c d e* f g
39    # field 205 can have only subfield a    # field 205 can have only subfield a
40    205 a    # and must exists
41      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    
# Line 82  sub new { Line 84  sub new {
84    
85                  my $fld = shift @d;                  my $fld = shift @d;
86    
87                    if ($fld =~ s/!$//) {
88                            $self->{must_exist}->{$fld}++;
89                    }
90    
91                  $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));
92    
93                  if (@d) {                  if (@d) {
94                          $v->{$fld} = \@d;                          $v->{$fld} = [ map {
95                                    my $sf = $_;
96                                    if ( $sf =~ s/!(\*)?$/$1/ ) {
97                                            $self->{must_exist_sf}->{ $fld }->{ $sf }++;
98                                    };
99                                    $sf;
100                            } @d ];
101                  } else {                  } else {
102                          $v->{$fld} = 1;                          $v->{$fld} = 1;
103                  }                  }
104    
105          }          }
106    
107          $log->debug("current validation rules: ", Dumper($v));          $log->debug("current validation rules: ", dump($v));
108    
109          $self->{rules} = $v;          $self->{rules} = $v;
110    
# Line 105  sub new { Line 117  sub new {
117    
118  Validate record and return errors  Validate record and return errors
119    
120    my @errors = $validate->validate_errors( $rec );    my @errors = $validate->validate_errors( $rec, $rec_dump );
121    
122  =cut  =cut
123    
# Line 115  sub validate_errors { Line 127  sub validate_errors {
127          my $log = $self->_get_logger();          my $log = $self->_get_logger();
128    
129          my $rec = shift || $log->logdie("validate_errors need record");          my $rec = shift || $log->logdie("validate_errors need record");
130            my $rec_dump = shift;
131    
132          $log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');          $log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');
133          $log->logdie("can't find validation rules") unless (my $r = $self->{rules});          $log->logdie("can't find validation rules") unless (my $r = $self->{rules});
134    
135          my @errors;          my $errors;
136    
137            $log->debug("rec = ", sub { dump($rec) }, "keys = ", keys %{ $rec });
138    
139          $log->debug("rec = ", sub { Dumper($rec) }, "keys = ", keys %{ $rec });          my $fields;
140    
141          foreach my $f (keys %{ $rec }) {          foreach my $f (keys %{ $rec }) {
142    
143                  next if (!defined($f) || $f eq '' || $f eq '000');                  next if (!defined($f) || $f eq '' || $f eq '000');
144    
145                  if (! defined($r->{$f})) {                  $fields->{$f}++;
146                          push @errors, "field '$f' shouldn't exists";  
147                    if ( ! defined($r->{$f}) ) {
148                            $errors->{ $f }->{unexpected} = "this field is not expected";
149                          next;                          next;
150                  }                  }
151    
152    
153                  if (ref($rec->{$f}) ne 'ARRAY') {                  if (ref($rec->{$f}) ne 'ARRAY') {
154                          push @errors, "field '$f' isn't repetable, probably bug in parsing input data";                          $errors->{ $f }->{not_repeatable} = "probably bug in parsing input data";
155                          next;                          next;
156                  }                  }
157    
# Line 141  sub validate_errors { Line 159  sub validate_errors {
159                          # can we have subfields?                          # can we have subfields?
160                          if (ref($r->{$f}) eq 'ARRAY') {                          if (ref($r->{$f}) eq 'ARRAY') {
161                                  # are values hashes? (has subfields)                                  # are values hashes? (has subfields)
162                                  if (ref($v) ne 'HASH') {                                  if (! defined($v)) {
163                                          push @errors, "$f has value without subfields: $v";  #                                       $errors->{$f}->{empty} = undef;
164    #                                       $errors->{dump} = $rec_dump if ($rec_dump);
165                                    } elsif (ref($v) ne 'HASH') {
166                                            $errors->{$f}->{missing_subfield} = join(",", @{ $r->{$f} }) . " required";
167                                          next;                                          next;
168                                  } else {                                  } else {
169    
170                                          my $h = dclone( $v );                                          my $h = dclone( $v );
171    
172                                            my $sf_repeatable;
173    
174                                          delete($v->{subfields}) if (defined($v->{subfields}));                                          delete($v->{subfields}) if (defined($v->{subfields}));
175    
176                                            my $subfields;
177    
178                                          foreach my $sf (keys %{ $v }) {                                          foreach my $sf (keys %{ $v }) {
179    
180                                                  # permited subfield?                                                  $subfields->{ $sf }++;
181                                                  if (! first { $_ eq $sf } @{ $r->{$f} }) {  
182                                                          push @errors, "$f has unknown subfield: $sf";                                                  # is non-repeatable but with multiple values?
183                                                    if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {
184                                                            if ( ref($v->{$sf}) eq 'ARRAY' ) {
185                                                                    $sf_repeatable->{$sf}++;
186                                                            };
187                                                            if (! first { $_ eq $sf } @{ $r->{$f} }) {
188                                                                    $errors->{ $f }->{subfield}->{extra}->{$sf}++;
189                                                            }
190                                                  }                                                  }
191    
192                                                  # is repeatable?                                          }
193                                                  if ( ref($v->{$sf}) eq 'ARRAY' ) {                                          if (my @r_sf = sort keys( %$sf_repeatable )) {
194                                                          push @errors, "$f subfield $sf is repeatable: " .  
195                                                                  join('', _pack_subfields_hash( dclone($h), 1) );                                                  foreach my $sf (@r_sf) {
196                                                          ### FIXME                                                          $errors->{$f}->{subfield}->{extra_repeatable}->{$sf}++;
197                                                            $errors->{$f}->{dump} = _pack_subfields_hash( $h, 1 );
198                                                  }                                                  }
199    
200                                          }                                          }
201    
202                                            if ( defined( $self->{must_exist_sf}->{$f} ) ) {
203                                                    foreach my $sf (sort keys %{ $self->{must_exist_sf}->{$f} }) {
204    #warn "====> $f $sf must exist\n";
205                                                            $errors->{$f}->{subfield}->{missing}->{$sf}++
206                                                                    unless defined( $subfields->{$sf} );
207                                                    }
208                                            }
209    
210                                  }                                  }
211                          } elsif (ref($v) eq 'HASH') {                          } elsif (ref($v) eq 'HASH') {
212                                  push @errors, "$f has subfields which is not valid";                                  $errors->{$f}->{unexpected_subfields}++;
213                                    $errors->{$f}->{dump} = _pack_subfields_hash( $v, 1 );
214                          }                          }
215                  }                  }
216          }          }
217    
218            foreach my $must (sort keys %{ $self->{must_exist} }) {
219                    next if ($fields->{$must});
220                    $errors->{$must}->{missing}++;
221                    $errors->{dump} = $rec_dump if ($rec_dump);
222            }
223    
224            if ($errors) {
225                    $log->debug("errors: ", sub { dump( $errors ) } );
226    
227                    my $mfn = $rec->{'000'}->[0] || $log->logconfess("record ", dump( $rec ), " doesn't have MFN");
228                    $self->{errors}->{$mfn} = $errors;
229            }
230    
231          #$log->logcluck("return from this function is ARRAY") unless wantarray;          #$log->logcluck("return from this function is ARRAY") unless wantarray;
232    
233          $log->debug("errors: ", join(", ", @errors)) if (@errors);          return $errors;
234    }
235    
236    =head2 reset_errors
237    
238    Clean all accumulated errors for this input
239    
240      $validate->reset_errors;
241    
242    =cut
243    
244    sub reset_errors {
245            my $self = shift;
246            delete ($self->{errors});
247    }
248    
249    =head2 all_errors
250    
251    Return hash with all errors
252    
253      print dump( $validate->all_errors );
254    
255    =cut
256    
257    sub all_errors {
258            my $self = shift;
259            return $self->{errors};
260    }
261    
262    =head2 report
263    
264    Produce nice humanly readable report of errors
265    
266      print $validate->report;
267    
268    =cut
269    
270    sub report {
271            my $self = shift;
272    
273            sub unroll {
274                    my ($self, $tree, $accumulated) = @_;
275    
276                    my $log = $self->_get_logger();
277    
278                    $log->debug("# ",
279                            ( $tree                 ? "tree: $tree "                                        : '' ),
280                            ( $accumulated  ? "accumulated: $accumulated "          : '' ),
281                    );
282    
283                    my $results;
284    
285                    if (ref($tree) ne 'HASH') {
286                            return ("$accumulated\t($tree)", undef);
287                    }
288    
289                    my $dump;
290    
291                    foreach my $k (sort keys %{ $tree }) {
292    
293                            if ($k eq 'dump') {
294                                    $dump = $tree->{dump};
295    #                               warn "## dump: ",dump($dump),"\n";
296                                    next;
297                            }
298    
299                            $log->debug("current: $k");
300    
301                            my ($new_results, $new_dump) = $self->unroll($tree->{$k},
302                                    $accumulated ? "$accumulated\t$k" : $k
303                            );
304    
305                            $log->debug(
306                                    ( $new_results          ? "new_results: " . dump($new_results) ." "     : '' ),
307                            );
308    
309                            push @$results, $new_results if ($new_results);
310                            $dump = $new_dump if ($new_dump);
311    
312                    }
313    
314                    $log->debug(
315                            ( $results              ? "results: " . dump($results) ." "     : '' ),
316                    );
317    
318                    if ($#$results == 0) {
319                            return ($results->[0], $dump);
320                    } else {
321                            return ($results, $dump);
322                    }
323            }
324    
325            my $log = $self->_get_logger();
326    
327            my $out = '';
328            my $e = $self->{errors} || return;
329    
330            sub reformat {
331                    my $l = shift;
332                    $l =~ s/\t/ /g;
333                    $l =~ s/_/ /;
334                    return $l;
335            }
336    
337            foreach my $mfn (sort keys %$e) {
338                    $out .= "MFN $mfn\n";
339    
340                    for my $f (sort keys %{ $e->{$mfn} }) {
341                            my ($r, $d) = $self->unroll( $e->{$mfn}->{$f} );
342                            my $e = $f . ': ';
343                            if (ref($r) eq 'ARRAY') {
344                                    $e .= join(", ", map { reformat( $_ ) } @$r);
345                            } else {
346                                    $e .= reformat( $r );
347                            }
348                            $e .= "\n\t$d" if ($d);
349                            $e .= "\n";
350                            $log->debug("MFN $mfn | $e");
351                            $out .= $e;
352                    }
353            }
354    
355          return @errors;          return $out;
356  }  }
357    
358  =head1 AUTHOR  =head1 AUTHOR
Legend:
Removed from v.643  
changed lines
  Added in v.670
  ViewVC Help
Powered by ViewVC 1.1.26