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.11

=cut

our $VERSION = '0.11';

=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
  # field which is ignored in validation
  999-

=head1 FUNCTIONS

=head2 new

Create new validation object

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

Optional parametar C<delimiters> will turn on validating of delimiters. Be
careful here, those delimiters are just stuck into regex, so they can
contain L<perlre> regexpes.

=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}++;
                } elsif ($fld =~ s/-$//) {
                        $self->{dont_validate}->{$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}");

        if ( $self->{delimiters} ) {
                $self->{delimiters_regex} = '(\^[a-z0-9]|' . join('|', @{ $self->{delimiters} }) . ')';
                $log->info("validation check delimiters with regex $self->{delimiters_regex}");
        }

        $self ? return $self : return undef;
}

=head2 validate_rec

Validate record and return errors

  my @errors = $validate->validate_rec( $rec, $rec_dump );

=cut

sub validate_rec {
        my $self = shift;

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

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

        $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');

                # first check delimiters
                if ( my $regex = $self->{delimiters_regex} ) {

                        foreach my $v (@{ $rec->{$f} }) {
                                my $l = _pack_subfields_hash( $v, 1 );
                                my $subfield_dump = $l;
                                my $template = '';
                                $l =~ s/$regex/$template.=$1/eg;
                                #warn "## template: $template\n";

                                if ( $template ) {
                                        $self->{_delimiters_templates}->{$f}->{$template}++;

                                        if ( my $v = $self->{_validate_delimiters_templates} ) {
                                                if ( ! defined( $v->{$template} ) ) {
                                                        $errors->{$f}->{invalid_delimiters_combination} = $template;
                                                        $errors->{$f}->{dump} = $subfield_dump;
                                                } else {
                                                        warn "## $f $template ok\n";
                                                }
                                        }
                                }
                        }
                }

                next if (defined( $self->{dont_validate}->{$f} ));

                # track field usage
                $fields->{$f}++;

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


                if (ref($rec->{$f}) ne 'ARRAY') {
                        $errors->{ $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->{$f}->{empty} = undef;
#                                       $errors->{dump} = $rec_dump if ($rec_dump);
                                } elsif (ref($v) ne 'HASH') {
                                        $errors->{$f}->{missing_subfield} = join(",", @{ $r->{$f} }) . " required";
                                        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->{ $f }->{subfield}->{extra}->{$sf}++;
                                                        }
                                                }

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

                                                foreach my $sf (@r_sf) {
                                                        $errors->{$f}->{subfield}->{extra_repeatable}->{$sf}++;
                                                        $errors->{$f}->{dump} = _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->{$f}->{subfield}->{missing}->{$sf}++
                                                                unless defined( $subfields->{$sf} );
                                                }
                                        }

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

        $log->debug("_delimiters_templates = ", dump( $self->{_delimiters_templates} ) );

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

        if ($errors) {
                $log->debug("errors: ", $self->report_error( $errors ) );

                my $mfn = $rec->{'000'}->[0] || $log->logconfess("record ", dump( $rec ), " doesn't have MFN");
                $self->{errors}->{$mfn} = $errors;
        }

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

        return $errors;
}

=head2 reset_errors

Clean all accumulated errors for this input

  $validate->reset_errors;

=cut

sub reset_errors {
        my $self = shift;
        delete ($self->{errors});
}

=head2 all_errors

Return hash with all errors

  print dump( $validate->all_errors );

=cut

sub all_errors {
        my $self = shift;
        return $self->{errors};
}

=head2 report_error

Produce nice humanly readable report of single error

  print $validate->report_error( $error_hash );

=cut

sub report_error {
        my $self = shift;

        my $h = shift || die "no hash?";

        sub _unroll {
                my ($self, $tree, $accumulated) = @_;

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

                $log->debug("# ",
                        ( $tree                 ? "tree: $tree "                                        : '' ),
                        ( $accumulated  ? "accumulated: $accumulated "          : '' ),
                );

                my $results;

                if (ref($tree) ne 'HASH') {
                        return ("$accumulated\t($tree)", undef);
                }

                my $dump;

                foreach my $k (sort keys %{ $tree }) {

                        if ($k eq 'dump') {
                                $dump = $tree->{dump};
                                #warn "## dump ",dump($dump),"\n";
                                next;
                        }

                        $log->debug("current: $k");

                        my ($new_results, $new_dump) = $self->_unroll($tree->{$k},
                                $accumulated ? "$accumulated\t$k" : $k
                        );

                        $log->debug(
                                ( $new_results          ? "new_results: " . dump($new_results) ." "     : '' ),
                        );

                        push @$results, $new_results if ($new_results);
                        $dump = $new_dump if ($new_dump);

                }

                $log->debug(
                        ( $results              ? "results: " . dump($results) ." "     : '' ),
                );

                if ($#$results == 0) {
                        return ($results->[0], $dump);
                } else {
                        return ($results, $dump);
                }
        }


        sub _reformat {
                my $l = shift;
                $l =~ s/\t/ /g;
                $l =~ s/_/ /g;
                return $l;
        }

        my $out = '';

        for my $f (sort keys %{ $h }) {
                $out .= "$f: ";
                
                my ($r, $d) = $self->_unroll( $h->{$f} );
                my $e;
                if (ref($r) eq 'ARRAY') {
                        $e .= join(", ", map { _reformat( $_ ) } @$r);
                } else {
                        $e .= _reformat( $r );
                }
                $e .= "\n\t$d" if ($d);

                $out .= $e . "\n";
        }
        return $out;
}


=head2 report

Produce nice humanly readable report of errors

  print $validate->report;

=cut

sub report {
        my $self = shift;
        my $e = $self->{errors} || return;

        my $out;
        foreach my $mfn (sort { $a <=> $b } keys %$e) {
                $out .= "MFN $mfn\n" . $self->report_error( $e->{$mfn} ) . "\n";
        }

        return $out;

}

=head2 delimiters_templates

Generate report of delimiter tamplates 

  my $report = $validate->delimiter_teplates(
        report => 1,
  );

Options:

=over 4

=item report

Generate humanly readable report with single fields

=back

=cut

sub delimiters_templates {
        my $self = shift;

        my $args = {@_};

        my $t = $self->{_delimiters_templates};

        my $log = $self->_get_logger;

        unless ($t) {
                $log->error("called without delimiters");
                return;
        }

        my $out;

        foreach my $f (sort { $a <=> $b } keys %$t) {
                $out .= "$f\n" if ( $args->{report} );
                foreach my $template (sort { $a cmp $b } keys %{ $t->{$f} }) {
                        my $count = $t->{$f}->{$template};
                        $out .= 
                                ( $count ? "" : "# " ) .
                                ( $args->{report} ? "" : "$f\t" ) .
                                "\t$count\t$template\n";
                }
        }

        return $out;
}

=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	827	Version 0.11
22	dpavlin	514
23			=cut
24
25	dpavlin	827	our $VERSION = '0.11';
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	dpavlin	677	# field which is ignored in validation
45			999-
46	dpavlin	514
47			=head1 FUNCTIONS
48
49			=head2 new
50
51			Create new validation object
52
53			my $validate = new WebPAC::Validate(
54	dpavlin	643	path => 'conf/validate/file',
55	dpavlin	827	delimiters => [ ' : ', ' / ', ' ; ', ' , ' ],
56	dpavlin	514	);
57
58	dpavlin	827	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	dpavlin	514	=cut
63
64			sub new {
65			my $class = shift;
66			my $self = {@_};
67			bless($self, $class);
68
69			my $log = $self->_get_logger();
70
71			foreach my $p (qw/path/) {
72			$log->logconfess("need $p") unless ($self->{$p});
73			}
74
75			my $v_file = read_file( $self->{path} ) \|\|
76			$log->logdie("can't open validate path $self->{path}: $!");
77
78			my $v;
79			my $curr_line = 1;
80
81			foreach my $l (split(/[\n\r]+/, $v_file)) {
82			$curr_line++;
83
84	dpavlin	516	# skip comments and whitespaces
85			next if ($l =~ /^#/ \|\| $l =~ /^\s*$/);
86
87	dpavlin	514	$l =~ s/^\s+//;
88			$l =~ s/\s+$//;
89
90			my @d = split(/\s+/, $l);
91
92	dpavlin	516	my $fld = shift @d;
93	dpavlin	514
94	dpavlin	645	if ($fld =~ s/!$//) {
95			$self->{must_exist}->{$fld}++;
96	dpavlin	677	} elsif ($fld =~ s/-$//) {
97			$self->{dont_validate}->{$fld}++;
98	dpavlin	645	}
99
100	dpavlin	516	$log->logdie("need field name in line $curr_line: $l") unless (defined($fld));
101
102	dpavlin	514	if (@d) {
103	dpavlin	646	$v->{$fld} = [ map {
104			my $sf = $_;
105			if ( $sf =~ s/!(\*)?$/$1/ ) {
106			$self->{must_exist_sf}->{ $fld }->{ $sf }++;
107			};
108			$sf;
109			} @d ];
110	dpavlin	514	} else {
111	dpavlin	515	$v->{$fld} = 1;
112	dpavlin	514	}
113
114			}
115
116	dpavlin	652	$log->debug("current validation rules: ", dump($v));
117	dpavlin	514
118			$self->{rules} = $v;
119
120	dpavlin	516	$log->info("validation uses rules from $self->{path}");
121
122	dpavlin	827	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	dpavlin	514	$self ? return $self : return undef;
128			}
129
130	dpavlin	768	=head2 validate_rec
131	dpavlin	515
132			Validate record and return errors
133
134	dpavlin	768	my @errors = $validate->validate_rec( $rec, $rec_dump );
135	dpavlin	515
136			=cut
137
138	dpavlin	768	sub validate_rec {
139	dpavlin	515	my $self = shift;
140
141			my $log = $self->_get_logger();
142
143	dpavlin	768	my $rec = shift \|\| $log->logdie("validate_rec need record");
144	dpavlin	653	my $rec_dump = shift;
145	dpavlin	515
146			$log->logdie("rec isn't HASH") unless (ref($rec) eq 'HASH');
147			$log->logdie("can't find validation rules") unless (my $r = $self->{rules});
148
149	dpavlin	652	my $errors;
150	dpavlin	515
151	dpavlin	652	$log->debug("rec = ", sub { dump($rec) }, "keys = ", keys %{ $rec });
152	dpavlin	515
153	dpavlin	645	my $fields;
154
155	dpavlin	515	foreach my $f (keys %{ $rec }) {
156
157	dpavlin	516	next if (!defined($f) \|\| $f eq '' \|\| $f eq '000');
158	dpavlin	515
159	dpavlin	827	# first check delimiters
160			if ( my $regex = $self->{delimiters_regex} ) {
161
162			foreach my $v (@{ $rec->{$f} }) {
163	dpavlin	835	my $l = _pack_subfields_hash( $v, 1 );
164			my $subfield_dump = $l;
165			my $template = '';
166			$l =~ s/$regex/$template.=$1/eg;
167			#warn "## template: $template\n";
168
169			if ( $template ) {
170			$self->{_delimiters_templates}->{$f}->{$template}++;
171
172			if ( my $v = $self->{_validate_delimiters_templates} ) {
173			if ( ! defined( $v->{$template} ) ) {
174			$errors->{$f}->{invalid_delimiters_combination} = $template;
175			$errors->{$f}->{dump} = $subfield_dump;
176			} else {
177			warn "## $f $template ok\n";
178			}
179			}
180			}
181	dpavlin	827	}
182			}
183
184	dpavlin	677	next if (defined( $self->{dont_validate}->{$f} ));
185
186			# track field usage
187	dpavlin	645	$fields->{$f}++;
188
189			if ( ! defined($r->{$f}) ) {
190	dpavlin	666	$errors->{ $f }->{unexpected} = "this field is not expected";
191	dpavlin	515	next;
192			}
193
194	dpavlin	645
195	dpavlin	515	if (ref($rec->{$f}) ne 'ARRAY') {
196	dpavlin	666	$errors->{ $f }->{not_repeatable} = "probably bug in parsing input data";
197	dpavlin	515	next;
198			}
199
200			foreach my $v (@{ $rec->{$f} }) {
201			# can we have subfields?
202			if (ref($r->{$f}) eq 'ARRAY') {
203			# are values hashes? (has subfields)
204	dpavlin	652	if (! defined($v)) {
205	dpavlin	666	# $errors->{$f}->{empty} = undef;
206	dpavlin	656	# $errors->{dump} = $rec_dump if ($rec_dump);
207	dpavlin	652	} elsif (ref($v) ne 'HASH') {
208	dpavlin	666	$errors->{$f}->{missing_subfield} = join(",", @{ $r->{$f} }) . " required";
209	dpavlin	515	next;
210			} else {
211	dpavlin	643
212			my $h = dclone( $v );
213
214	dpavlin	645	my $sf_repeatable;
215
216	dpavlin	643	delete($v->{subfields}) if (defined($v->{subfields}));
217
218	dpavlin	646	my $subfields;
219
220	dpavlin	515	foreach my $sf (keys %{ $v }) {
221	dpavlin	643
222	dpavlin	646	$subfields->{ $sf }++;
223
224	dpavlin	645	# is non-repeatable but with multiple values?
225			if ( ! first { $_ eq $sf.'*' } @{$r->{$f}} ) {
226			if ( ref($v->{$sf}) eq 'ARRAY' ) {
227			$sf_repeatable->{$sf}++;
228			};
229			if (! first { $_ eq $sf } @{ $r->{$f} }) {
230	dpavlin	666	$errors->{ $f }->{subfield}->{extra}->{$sf}++;
231	dpavlin	645	}
232	dpavlin	515	}
233	dpavlin	643
234	dpavlin	515	}
235	dpavlin	645	if (my @r_sf = sort keys( %$sf_repeatable )) {
236
237	dpavlin	652	foreach my $sf (@r_sf) {
238	dpavlin	666	$errors->{$f}->{subfield}->{extra_repeatable}->{$sf}++;
239	dpavlin	670	$errors->{$f}->{dump} = _pack_subfields_hash( $h, 1 );
240	dpavlin	652	}
241
242	dpavlin	645	}
243	dpavlin	646
244			if ( defined( $self->{must_exist_sf}->{$f} ) ) {
245			foreach my $sf (sort keys %{ $self->{must_exist_sf}->{$f} }) {
246	dpavlin	647	#warn "====> $f $sf must exist\n";
247	dpavlin	666	$errors->{$f}->{subfield}->{missing}->{$sf}++
248	dpavlin	652	unless defined( $subfields->{$sf} );
249	dpavlin	646	}
250			}
251
252	dpavlin	515	}
253			} elsif (ref($v) eq 'HASH') {
254	dpavlin	666	$errors->{$f}->{unexpected_subfields}++;
255	dpavlin	670	$errors->{$f}->{dump} = _pack_subfields_hash( $v, 1 );
256	dpavlin	515	}
257			}
258			}
259
260	dpavlin	827	$log->debug("_delimiters_templates = ", dump( $self->{_delimiters_templates} ) );
261
262	dpavlin	645	foreach my $must (sort keys %{ $self->{must_exist} }) {
263			next if ($fields->{$must});
264	dpavlin	666	$errors->{$must}->{missing}++;
265	dpavlin	653	$errors->{dump} = $rec_dump if ($rec_dump);
266	dpavlin	645	}
267
268	dpavlin	652	if ($errors) {
269	dpavlin	671	$log->debug("errors: ", $self->report_error( $errors ) );
270	dpavlin	652
271	dpavlin	653	my $mfn = $rec->{'000'}->[0] \|\| $log->logconfess("record ", dump( $rec ), " doesn't have MFN");
272	dpavlin	652	$self->{errors}->{$mfn} = $errors;
273			}
274
275	dpavlin	515	#$log->logcluck("return from this function is ARRAY") unless wantarray;
276
277	dpavlin	652	return $errors;
278	dpavlin	515	}
279
280	dpavlin	653	=head2 reset_errors
281
282			Clean all accumulated errors for this input
283
284			$validate->reset_errors;
285
286			=cut
287
288			sub reset_errors {
289			my $self = shift;
290			delete ($self->{errors});
291			}
292
293			=head2 all_errors
294
295			Return hash with all errors
296
297			print dump( $validate->all_errors );
298
299			=cut
300
301			sub all_errors {
302			my $self = shift;
303			return $self->{errors};
304			}
305
306	dpavlin	671	=head2 report_error
307	dpavlin	664
308	dpavlin	671	Produce nice humanly readable report of single error
309	dpavlin	664
310	dpavlin	671	print $validate->report_error( $error_hash );
311	dpavlin	664
312			=cut
313
314	dpavlin	671	sub report_error {
315	dpavlin	664	my $self = shift;
316
317	dpavlin	671	my $h = shift \|\| die "no hash?";
318
319			sub _unroll {
320	dpavlin	666	my ($self, $tree, $accumulated) = @_;
321	dpavlin	664
322	dpavlin	666	my $log = $self->_get_logger();
323
324	dpavlin	665	$log->debug("# ",
325			( $tree ? "tree: $tree " : '' ),
326			( $accumulated ? "accumulated: $accumulated " : '' ),
327			);
328	dpavlin	664
329	dpavlin	665	my $results;
330	dpavlin	664
331	dpavlin	665	if (ref($tree) ne 'HASH') {
332			return ("$accumulated\t($tree)", undef);
333	dpavlin	664	}
334
335	dpavlin	665	my $dump;
336	dpavlin	664
337	dpavlin	665	foreach my $k (sort keys %{ $tree }) {
338
339	dpavlin	664	if ($k eq 'dump') {
340	dpavlin	665	$dump = $tree->{dump};
341	dpavlin	835	#warn "## dump ",dump($dump),"\n";
342	dpavlin	664	next;
343			}
344
345	dpavlin	665	$log->debug("current: $k");
346	dpavlin	664
347	dpavlin	671	my ($new_results, $new_dump) = $self->_unroll($tree->{$k},
348	dpavlin	665	$accumulated ? "$accumulated\t$k" : $k
349			);
350
351			$log->debug(
352			( $new_results ? "new_results: " . dump($new_results) ." " : '' ),
353			);
354
355			push @$results, $new_results if ($new_results);
356			$dump = $new_dump if ($new_dump);
357
358	dpavlin	664	}
359	dpavlin	665
360			$log->debug(
361			( $results ? "results: " . dump($results) ." " : '' ),
362			);
363
364			if ($#$results == 0) {
365			return ($results->[0], $dump);
366			} else {
367			return ($results, $dump);
368			}
369	dpavlin	664	}
370
371	dpavlin	666
372	dpavlin	671	sub _reformat {
373	dpavlin	666	my $l = shift;
374			$l =~ s/\t/ /g;
375	dpavlin	835	$l =~ s/_/ /g;
376	dpavlin	666	return $l;
377			}
378
379	dpavlin	671	my $out = '';
380	dpavlin	666
381	dpavlin	671	for my $f (sort keys %{ $h }) {
382			$out .= "$f: ";
383
384			my ($r, $d) = $self->_unroll( $h->{$f} );
385			my $e;
386			if (ref($r) eq 'ARRAY') {
387			$e .= join(", ", map { _reformat( $_ ) } @$r);
388			} else {
389			$e .= _reformat( $r );
390	dpavlin	666	}
391	dpavlin	671	$e .= "\n\t$d" if ($d);
392
393			$out .= $e . "\n";
394	dpavlin	664	}
395	dpavlin	671	return $out;
396			}
397	dpavlin	664
398	dpavlin	671
399			=head2 report
400
401			Produce nice humanly readable report of errors
402
403			print $validate->report;
404
405			=cut
406
407			sub report {
408			my $self = shift;
409			my $e = $self->{errors} \|\| return;
410
411			my $out;
412			foreach my $mfn (sort { $a <=> $b } keys %$e) {
413			$out .= "MFN $mfn\n" . $self->report_error( $e->{$mfn} ) . "\n";
414			}
415
416	dpavlin	664	return $out;
417	dpavlin	671
418	dpavlin	664	}
419
420	dpavlin	832	=head2 delimiters_templates
421
422	dpavlin	834	Generate report of delimiter tamplates
423	dpavlin	832
424	dpavlin	834	my $report = $validate->delimiter_teplates(
425			report => 1,
426			);
427
428			Options:
429
430			=over 4
431
432			=item report
433
434			Generate humanly readable report with single fields
435
436			=back
437
438	dpavlin	832	=cut
439
440			sub delimiters_templates {
441			my $self = shift;
442
443	dpavlin	834	my $args = {@_};
444
445	dpavlin	832	my $t = $self->{_delimiters_templates};
446
447			my $log = $self->_get_logger;
448
449			unless ($t) {
450	dpavlin	834	$log->error("called without delimiters");
451	dpavlin	832	return;
452			}
453
454			my $out;
455
456			foreach my $f (sort { $a <=> $b } keys %$t) {
457	dpavlin	834	$out .= "$f\n" if ( $args->{report} );
458			foreach my $template (sort { $a cmp $b } keys %{ $t->{$f} }) {
459			my $count = $t->{$f}->{$template};
460			$out .=
461			( $count ? "" : "# " ) .
462			( $args->{report} ? "" : "$f\t" ) .
463			"\t$count\t$template\n";
464	dpavlin	832	}
465			}
466
467			return $out;
468			}
469
470	dpavlin	514	=head1 AUTHOR
471
472			Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
473
474			=head1 COPYRIGHT & LICENSE
475
476			Copyright 2006 Dobrica Pavlinusic, All Rights Reserved.
477
478			This program is free software; you can redistribute it and/or modify it
479			under the same terms as Perl itself.
480
481			=cut
482
483			1; # End of WebPAC::Validate