9 use base qw/WebPAC::Common/;
10 use Data::Dump qw/dump/;
11 use Encode qw/decode from_to/;
16 WebPAC::Input - read different file formats into WebPAC
20 our $VERSION = '0.19';
24 This module implements input as database which have fixed and known
25 I<size> while indexing and single unique numeric identifier for database
26 position ranging from 1 to I<size>.
28 Simply, something that is indexed by unmber from 1 .. I<size>.
30 Examples of such databases are CDS/ISIS files, MARC files, lines in
33 Specific file formats are implemented using low-level interface modules,
34 located in C<WebPAC::Input::*> namespace which export C<open_db>,
35 C<fetch_rec> and optional C<init> functions.
37 Perhaps a little code snippet.
41 my $db = WebPAC::Input->new(
42 module => 'WebPAC::Input::ISIS',
45 $db->open( path => '/path/to/database' );
46 print "database size: ",$db->size,"\n";
47 while (my $rec = $db->fetch) {
48 # do something with $rec
57 Create new input database object.
59 my $db = new WebPAC::Input(
60 module => 'WebPAC::Input::MARC',
61 recode => 'char pairs',
64 mapping => [ 'foo', 'bar', 'baz' ],
68 C<module> is low-level file format module. See L<WebPAC::Input::ISIS> and
69 L<WebPAC::Input::MARC>.
71 C<recode> is optional string constisting of character or words pairs that
72 should be replaced in input stream.
74 C<no_progress_bar> disables progress bar output on C<STDOUT>
76 This function will also call low-level C<init> if it exists with same
86 my $log = $self->_get_logger;
88 $log->logconfess("code_page argument is not suppored any more.") if $self->{code_page};
89 $log->logconfess("encoding argument is not suppored any more.") if $self->{encoding};
90 $log->logconfess("lookup argument is not suppored any more. rewrite call to lookup_ref") if $self->{lookup};
91 $log->logconfess("low_mem argument is not suppored any more. rewrite it to load_row and save_row") if $self->{low_mem};
93 $log->logconfess("specify low-level file format module") unless ($self->{module});
94 my $module_path = $self->{module};
95 $module_path =~ s#::#/#g;
96 $module_path .= '.pm';
97 $log->debug("require low-level module $self->{module} from $module_path");
101 $self ? return $self : return undef;
106 This function will read whole database in memory and produce lookups.
108 my $store; # simple in-memory hash
111 path => '/path/to/database/file',
112 input_encoding => 'cp852',
113 strict_encoding => 0,
117 lookup_coderef => sub {
122 900 => { '^a' => { ' : ' => '^b' } },
123 901 => { '*' => { '^b' => ' ; ' } },
125 modify_file => 'conf/modify/mapping.map',
128 $store->{ $a->{id} } = $a->{row};
132 return defined($store->{ $a->{id} }) &&
133 $store->{ $a->{id} };
138 By default, C<input_encoding> is assumed to be C<cp852>.
140 C<offset> is optional parametar to position at some offset before reading from database.
142 C<limit> is optional parametar to read just C<limit> records from database
144 C<stats> create optional report about usage of fields and subfields
146 C<lookup_coderef> is closure to called to save data into lookups
148 C<modify_records> specify mapping from subfields to delimiters or from
149 delimiters to subfields, as well as oprations on fields (if subfield is
152 C<modify_file> is alternative for C<modify_records> above which preserves order and offers
153 (hopefully) simplier sintax than YAML or perl (see L</modify_file_regex>). This option
154 overrides C<modify_records> if both exists for same input.
156 C<save_row> and C<load_row> are low-level implementation of store engine. Calling convention
157 is documented in example above.
159 C<strict_encoding> should really default to 1, but it doesn't for now.
161 Returns size of database, regardless of C<offset> and C<limit>
162 parametars, see also C<size>.
170 my $log = $self->_get_logger();
171 $log->debug( "arguments: ",dump( $arg ));
173 $log->logconfess("encoding argument is not suppored any more.") if $self->{encoding};
174 $log->logconfess("code_page argument is not suppored any more.") if $self->{code_page};
175 $log->logconfess("lookup argument is not suppored any more. rewrite call to lookup_coderef") if ($arg->{lookup});
176 $log->logconfess("lookup_coderef must be CODE, not ",ref($arg->{lookup_coderef}))
177 if ($arg->{lookup_coderef} && ref($arg->{lookup_coderef}) ne 'CODE');
179 $log->debug( $arg->{lookup_coderef} ? '' : 'not ', "using lookup_coderef");
181 $log->logcroak("need path") if (! $arg->{'path'});
182 my $input_encoding = $arg->{'input_encoding'} || $self->{'input_encoding'} || 'cp852';
184 # store data in object
185 foreach my $v (qw/path offset limit/) {
186 $self->{$v} = $arg->{$v} if ($arg->{$v});
189 if ($arg->{load_row} || $arg->{save_row}) {
190 $log->logconfess("save_row and load_row must be defined in pair and be CODE") unless (
191 ref($arg->{load_row}) eq 'CODE' &&
192 ref($arg->{save_row}) eq 'CODE'
194 $self->{load_row} = $arg->{load_row};
195 $self->{save_row} = $arg->{save_row};
196 $log->debug("using load_row and save_row instead of in-memory hash");
203 if ($self->{recode}) {
204 my @r = split(/\s/, $self->{recode});
206 $log->logwarn("recode needs even number of elements (some number of valid pairs)");
211 $recode_map->{$from} = $to;
214 $recode_regex = join '|' => keys %{ $recode_map };
216 $log->debug("using recode regex: $recode_regex");
222 if (my $p = $arg->{modify_file}) {
223 $log->debug("using modify_file $p");
224 $rec_regex = $self->modify_file_regexps( $p );
225 } elsif (my $h = $arg->{modify_records}) {
226 $log->debug("using modify_records ", sub { dump( $h ) });
227 $rec_regex = $self->modify_record_regexps(%{ $h });
229 $log->debug("rec_regex: ", sub { dump($rec_regex) }) if ($rec_regex);
231 my $class = $self->{module} || $log->logconfess("can't get low-level module name!");
233 my $ll_db = $class->new(
234 path => $arg->{path},
235 input_config => $arg->{input_config} || $self->{input_config},
237 # my ($l,$f_nr) = @_;
238 # return unless defined($l);
239 # $l = decode($input_encoding, $l);
240 # $l =~ s/($recode_regex)/$recode_map->{$1}/g if ($recode_regex && $recode_map);
246 unless (defined($ll_db)) {
247 $log->logwarn("can't open database $arg->{path}, skipping...");
251 my $size = $ll_db->size;
254 $log->logwarn("no records in database $arg->{path}, skipping...");
261 if (my $s = $self->{offset}) {
262 $log->debug("skipping to MFN $s");
265 $self->{offset} = $from_rec;
268 if ($self->{limit}) {
269 $log->debug("limiting to ",$self->{limit}," records");
270 $to_rec = $from_rec + $self->{limit} - 1;
271 $to_rec = $size if ($to_rec > $size);
274 # store size for later
275 $self->{size} = ($to_rec - $from_rec) ? ($to_rec - $from_rec + 1) : 0;
277 my $strict_encoding = $arg->{strict_encoding} || $self->{strict_encoding}; ## FIXME should be 1 really
279 $log->info("processing $self->{size}/$size records [$from_rec-$to_rec]",
280 " encoding $input_encoding ", $strict_encoding ? ' [strict]' : '',
281 $self->{stats} ? ' [stats]' : '',
285 for (my $pos = $from_rec; $pos <= $to_rec; $pos++) {
287 $log->debug("position: $pos\n");
289 my $rec = $ll_db->fetch_rec($pos, sub {
290 my ($l,$f_nr,$debug) = @_;
291 # return unless defined($l);
292 # return $l unless ($rec_regex && $f_nr);
294 return unless ( defined($l) && defined($f_nr) );
296 warn "-=> $f_nr ## |$l|\n" if ($debug);
297 $log->debug("-=> $f_nr ## $l");
299 # codepage conversion and recode_regex
300 $l = decode($input_encoding, $l, 1);
301 $l =~ s/($recode_regex)/$recode_map->{$1}/g if ($recode_regex && $recode_map);
304 if ($rec_regex && defined($rec_regex->{$f_nr})) {
305 $log->logconfess("regexps->{$f_nr} must be ARRAY") if (ref($rec_regex->{$f_nr}) ne 'ARRAY');
307 foreach my $r (@{ $rec_regex->{$f_nr} }) {
309 $log->logconfess("expected regex in ", dump( $r )) unless defined($r->{regex});
310 eval '$l =~ ' . $r->{regex};
312 my $d = "|$old_l| -> |$l| "; # . $r->{regex};
313 $d .= ' +' . $r->{line} . ' ' . $r->{file} if defined($r->{line});
314 $d .= ' ' . $r->{debug} if defined($r->{debug});
315 $log->debug("MODIFY $d");
316 warn "*** $d\n" if ($debug);
319 $log->error("error applying regex: ",dump($r), $@) if $@;
323 $log->debug("<=- $f_nr ## |$l|");
324 warn "<=- $f_nr ## $l\n" if ($debug);
328 $log->debug(sub { dump($rec) });
331 $log->warn("record $pos empty? skipping...");
336 if ($self->{save_row}) {
337 $self->{save_row}->({
342 $self->{data}->{$pos} = $rec;
346 $arg->{'lookup_coderef'}->( $rec ) if ($rec && $arg->{'lookup_coderef'});
348 # update counters for statistics
349 if ($self->{stats}) {
351 # fetch clean record with regexpes applied for statistics
352 my $rec = $ll_db->fetch_rec($pos);
354 foreach my $fld (keys %{ $rec }) {
355 $self->{_stats}->{fld}->{ $fld }++;
357 #$log->logdie("invalid record fild $fld, not ARRAY")
358 next unless (ref($rec->{ $fld }) eq 'ARRAY');
360 foreach my $row (@{ $rec->{$fld} }) {
362 if (ref($row) eq 'HASH') {
364 foreach my $sf (keys %{ $row }) {
365 next if ($sf eq 'subfields');
366 $self->{_stats}->{sf}->{ $fld }->{ $sf }->{count}++;
367 $self->{_stats}->{sf}->{ $fld }->{ $sf }->{repeatable}++
368 if (ref($row->{$sf}) eq 'ARRAY');
372 $self->{_stats}->{repeatable}->{ $fld }++;
378 $self->progress_bar($pos,$to_rec) unless ($self->{no_progress_bar});
383 $self->{last_pcnt} = 0;
385 # store max mfn and return it.
386 $self->{max_pos} = $to_rec;
387 $log->debug("max_pos: $to_rec");
390 $self->{ll_db} = $ll_db;
397 Fetch next record from database. It will also displays progress bar.
399 my $rec = $isis->fetch;
401 Record from this function should probably go to C<data_structure> for
409 my $log = $self->_get_logger();
411 $log->logconfess("it seems that you didn't load database!") unless ($self->{pos});
413 if ($self->{pos} == -1) {
414 $self->{pos} = $self->{offset};
419 my $mfn = $self->{pos};
421 if ($mfn > $self->{max_pos}) {
422 $self->{pos} = $self->{max_pos};
423 $log->debug("at EOF");
427 $self->progress_bar($mfn,$self->{max_pos}) unless ($self->{no_progress_bar});
431 if ($self->{load_row}) {
432 $rec = $self->{load_row}->({ id => $mfn });
434 $rec = $self->{data}->{$mfn};
442 Returns current record number (MFN).
446 First record in database has position 1.
458 Returns number of records in database
462 Result from this function can be used to loop through all records
464 foreach my $mfn ( 1 ... $isis->size ) { ... }
466 because it takes into account C<offset> and C<limit>.
472 return $self->{size};
477 Seek to specified MFN in file.
481 First record in database has position 1.
489 my $log = $self->_get_logger();
491 $log->logconfess("called without pos") unless defined($pos);
494 $log->warn("seek before first record");
496 } elsif ($pos > $self->{max_pos}) {
497 $log->warn("seek beyond last record");
498 $pos = $self->{max_pos};
501 return $self->{pos} = (($pos - 1) || -1);
506 Dump statistics about field and subfield usage
515 my $log = $self->_get_logger();
517 my $s = $self->{_stats};
519 $log->warn("called stats, but there is no statistics collected");
528 die "no field in ", dump( $s->{fld} ) unless defined( $f );
529 my $v = $s->{fld}->{$f} || die "no s->{fld}->{$f}";
530 $max_fld = $v if ($v > $max_fld);
532 my $o = sprintf("%4s %d ~", $f, $v);
534 if (defined($s->{sf}->{$f})) {
535 my @subfields = keys %{ $s->{sf}->{$f} };
537 $o .= sprintf(" %s:%d%s", $_,
538 $s->{sf}->{$f}->{$_}->{count},
539 $s->{sf}->{$f}->{$_}->{repeatable} ? '*' : '',
542 # first indicators and other special subfields
543 sort( grep { length($_) > 1 } @subfields ),
544 # then subfileds (single char)
545 sort( grep { length($_) == 1 } @subfields ),
549 if (my $v_r = $s->{repeatable}->{$f}) {
550 $o .= " ($v_r)" if ($v_r != $v);
555 if ( $a =~ m/^\d+$/ && $b =~ m/^\d+$/ ) {
560 } keys %{ $s->{fld} }
563 $log->debug( sub { dump($s) } );
565 my $path = 'var/stats.yml';
566 YAML::DumpFile( $path, $s );
567 $log->info( 'created ', $path, ' with ', -s $path, ' bytes' );
574 Display humanly readable dump of record
581 return unless $self->{ll_db};
583 if ($self->{ll_db}->can('dump_ascii')) {
584 return $self->{ll_db}->dump_ascii( $self->{pos} );
586 return dump( $self->{ll_db}->fetch_rec( $self->{pos} ) );
592 Helper function called which create regexps to be execute on code.
594 _get_regex( 900, 'regex:[0-9]+' ,'numbers' );
595 _get_regex( 900, '^b', ' : ^b' );
597 It supports perl regexps with C<regex:> prefix to from value and has
598 additional logic to skip empty subfields.
603 my ($sf,$from,$to) = @_;
609 if ($from =~ m/^regex:(.+)$/) {
612 $from = '\Q' . $from . '\E';
615 my $need_subfield_data = '*'; # no
616 # if from is also subfield, require some data in between
617 # to correctly skip empty subfields
618 $need_subfield_data = '+' if ($from =~ m/^\\Q\^/);
620 's/\Q'. $sf .'\E([^\^]' . $need_subfield_data . '?)'. $from .'([^\^]*?)/'. $sf .'$1'. $to .'$2/';
623 's/'. $from .'/'. $to .'/g';
628 =head2 modify_record_regexps
630 Generate hash with regexpes to be applied using L<filter>.
632 my $regexpes = $input->modify_record_regexps(
633 900 => { '^a' => { ' : ' => '^b' } },
634 901 => { '*' => { '^b' => ' ; ' } },
639 sub modify_record_regexps {
641 my $modify_record = {@_};
645 my $log = $self->_get_logger();
647 foreach my $f (keys %$modify_record) {
648 $log->debug("field: $f");
650 foreach my $sf (keys %{ $modify_record->{$f} }) {
651 $log->debug("subfield: $sf");
653 foreach my $from (keys %{ $modify_record->{$f}->{$sf} }) {
654 my $to = $modify_record->{$f}->{$sf}->{$from};
655 #die "no field?" unless defined($to);
656 my $d = "|$from| -> |$to|";
657 $log->debug("transform: $d");
659 my $regex = _get_regex($sf,$from,$to);
660 push @{ $regexpes->{$f} }, { regex => $regex, debug => $d };
661 $log->debug("regex: $regex");
669 =head2 modify_file_regexps
671 Generate hash with regexpes to be applied using L<filter> from
672 pseudo hash/yaml format for regex mappings.
674 It should be obvious:
681 In field I<200> find C<'^a'> and then C<' : '>, and replace it with C<'^e'>.
682 In field I<200> find C<'^a'> and then C<' = '>, and replace it with C<'^d'>.
684 my $regexpes = $input->modify_file_regexps( 'conf/modify/common.pl' );
686 On undef path it will just return.
690 sub modify_file_regexps {
693 my $modify_path = shift || return;
695 my $log = $self->_get_logger();
699 CORE::open(my $fh, $modify_path) || $log->logdie("can't open modify file $modify_path: $!");
705 next if (/^#/ || /^\s*$/);
707 if (/^\s*(\d+)\s*$/) {
709 $log->debug("field: $f");
711 } elsif (/^\s*'([^']*)'\s*$/) {
713 $log->die("can't define subfiled before field in: $_") unless ($f);
714 $log->debug("subfield: $sf");
715 } elsif (/^\s*'([^']*)'\s*=>\s*'([^']*)'\s*$/) {
716 my ($from,$to) = ($1, $2);
718 $log->debug("transform: |$from| -> |$to|");
720 my $regex = _get_regex($sf,$from,$to);
721 push @{ $regexpes->{$f} }, {
723 file => $modify_path,
726 $log->debug("regex: $regex");
728 die "can't parse: $_";
737 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>
739 =head1 COPYRIGHT & LICENSE
741 Copyright 2005-2006 Dobrica Pavlinusic, All Rights Reserved.
743 This program is free software; you can redistribute it and/or modify it
744 under the same terms as Perl itself.
748 1; # End of WebPAC::Input