/[webpac2]/trunk/lib/WebPAC/Normalize.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/Normalize.pm

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

revision 433 by dpavlin, Mon Apr 17 16:01:12 2006 UTC revision 1038 by dpavlin, Mon Nov 12 11:57:00 2007 UTC
# Line 1  Line 1 
1  package WebPAC::Normalize;  package WebPAC::Normalize;
2    use Exporter 'import';
3    our @EXPORT = qw/
4            _set_ds _set_lookup
5            _set_load_row
6            _get_ds _clean_ds
7            _debug
8            _pack_subfields_hash
9    
10            search_display search display sorted
11    
12            rec1 rec2 rec
13            frec frec_eq frec_ne
14            regex prefix suffix surround
15            first lookup join_with
16            save_into_lookup
17    
18            split_rec_on
19    
20            get set
21            count
22    
23    /;
24    
25  use warnings;  use warnings;
26  use strict;  use strict;
 use blib;  
 use WebPAC::Common;  
 use base 'WebPAC::Common';  
 use Data::Dumper;  
27    
28  =head1 NAME  #use base qw/WebPAC::Common/;
29    use Data::Dump qw/dump/;
30  WebPAC::Normalize - data mungling for normalisation  use Carp qw/confess/;
31    
32    # debugging warn(s)
33    my $debug = 0;
34    _debug( $debug );
35    
36    # FIXME
37    use WebPAC::Normalize::ISBN;
38    push @EXPORT, ( 'isbn_10', 'isbn_13' );
39    
40    use WebPAC::Normalize::MARC;
41    push @EXPORT, ( qw/
42            marc marc_indicators marc_repeatable_subfield
43            marc_compose marc_leader marc_fixed
44            marc_duplicate marc_remove marc_count
45            marc_original_order
46            marc_template
47    /);
48    
49  =head1 VERSION  =head1 NAME
50    
51  Version 0.09  WebPAC::Normalize - describe normalisaton rules using sets
52    
53  =cut  =cut
54    
55  our $VERSION = '0.09';  our $VERSION = '0.35';
56    
57  =head1 SYNOPSIS  =head1 SYNOPSIS
58    
59  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
60    from input records using perl functions which are specialized for set
61    processing.
62    
63    Sets are implemented as arrays, and normalisation file is valid perl, which
64    means that you check it's validity before running WebPAC using
65    C<perl -c normalize.pl>.
66    
67    Normalisation can generate multiple output normalized data. For now, supported output
68    types (on the left side of definition) are: C<search_display>, C<display>, C<search> and
69    C<marc>.
70    
71  It contains several assumptions:  =head1 FUNCTIONS
72    
73  =over  Functions which start with C<_> are private and used by WebPAC internally.
74    All other functions are available for use within normalisation rules.
75    
76  =item *  =head2 data_structure
77    
78  format of fields is defined using C<v123^a> notation for repeatable fields  Return data structure
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
79    
80  =item *    my $ds = WebPAC::Normalize::data_structure(
81            lookup => $lookup_hash,
82            row => $row,
83            rules => $normalize_pl_config,
84            marc_encoding => 'utf-8',
85            config => $config,
86            load_row_coderef => sub {
87                    my ($database,$input,$mfn) = @_;
88                    $store->load_row( database => $database, input => $input, id => $mfn );
89            },
90      );
91    
92  source data records (C<$rec>) have unique identifiers in field C<000>  Options C<row>, C<rules> and C<log> are mandatory while all
93    other are optional.
94    
95  =item *  C<load_row_coderef> is closure only used when executing lookups, so they will
96    die if it's not defined.
97    
98  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  This function will B<die> if normalizastion can't be evaled.
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
99    
100  =item *  Since this function isn't exported you have to call it with
101    C<WebPAC::Normalize::data_structure>.
102    
103  optional C<filter{filter_name}> at B<begining of format> will apply perl  =cut
 code defined as code ref on format after field substitution to producing  
 output  
104    
105  There is one built-in filter called C<regex> which can be use like this:  my $load_row_coderef;
106    
107    filter{regex(s/foo/bar/)}  sub data_structure {
108            my $arg = {@_};
109    
110  =item *          die "need row argument" unless ($arg->{row});
111            die "need normalisation argument" unless ($arg->{rules});
112    
113  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
114            _set_ds( $arg->{row} );
115            _set_config( $arg->{config} ) if defined($arg->{config});
116            _clean_ds( %{ $arg } );
117            $load_row_coderef = $arg->{load_row_coderef};
118    
119  =item *          no strict 'subs';
120            no warnings 'redefine';
121            eval "$arg->{rules};";
122            die "error evaling $arg->{rules}: $@\n" if ($@);
123    
124  at end, optional C<format>s rules are resolved. Format rules are similar to          return _get_ds();
125  C<sprintf> and can also contain C<lookup{...}> which is performed after  }
 values are inserted in format.  
126    
127  =back  =head2 _set_ds
128    
129  This also describes order in which transformations are applied (eval,  Set current record hash
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
130    
131      _set_ds( $rec );
132    
133    =cut
134    
135    my $rec;
136    
137  =head1 FUNCTIONS  sub _set_ds {
138            $rec = shift or die "no record hash";
139            $WebPAC::Normalize::MARC::rec = $rec;
140    }
141    
142  =head2 new  =head2
143    
144  Create new normalisation object    my $rec = _get_rec();
145    
146    my $n = new WebPAC::Normalize::Something(  =cut
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
147    
148  Parametar C<filter> defines user supplied snippets of perl code which can  sub _get_rec { $rec };
 be use with C<filter{...}> notation.  
149    
150  C<prefix> is used to form filename for database record (to support multiple  =head2 _set_config
 source files which are joined in one database).  
151    
152  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Set current config hash
 in structures. If you pass this parametar, you must also pass C<lookup>  
 which is C<WebPAC::Lookup> object.  
153    
154  =cut    _set_config( $config );
155    
156  sub new {  Magic keys are:
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
157    
158          my $r = $self->{'lookup_regex'} ? 1 : 0;  =over 4
         my $l = $self->{'lookup'} ? 1 : 0;  
159    
160          my $log = $self->_get_logger();  =item _
161    
162          # those two must be in pair  Code of current database
         if ( ($r & $l) != ($r || $l) ) {  
                 my $log = $self->_get_logger();  
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
163    
164          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  =item _mfn
165    
166          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  Current MFN
167    
168          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  =back
169    
170          if (! $self->{filter} || ! $self->{filter}->{regex}) {  =cut
171                  $log->debug("adding built-in filter regex");  
172                  $self->{filter}->{regex} = sub {  my $config;
                         my ($val, $regex) = @_;  
                         eval "\$val =~ $regex";  
                         return $val;  
                 };  
         }  
173    
174          $self ? return $self : return undef;  sub _set_config {
175            $config = shift;
176  }  }
177    
178  =head2 all_tags  =head2 _get_ds
179    
180  Returns all tags in document in specified order  Return hash formatted as data structure
181    
182    my $sorted_tags = $self->all_tags();    my $ds = _get_ds();
183    
184  =cut  =cut
185    
186  sub all_tags {  my $out;
         my $self = shift;  
   
         if (! $self->{_tags_by_order}) {  
187    
188                  my $log = $self->_get_logger;  sub _get_ds {
189                  # sanity check  #warn "## out = ",dump($out);
190                  $log->logdie("can't find self->{inport_xml}->{indexer}") unless ($self->{import_xml}->{indexer});          return $out;
191    }
192    
193                  my @tags = keys %{ $self->{'import_xml'}->{'indexer'}};  =head2 _clean_ds
                 $log->debug("unsorted tags: " . join(", ", @tags));  
194    
195                  @tags = sort { $self->_sort_by_order } @tags;  Clean data structure hash for next record
196    
197                  $log->debug("sorted tags: " . join(",", @tags) );    _clean_ds();
198    
199                  $self->{_tags_by_order} = \@tags;  =cut
         }  
200    
201          return $self->{_tags_by_order};  sub _clean_ds {
202            my $a = {@_};
203            $out = undef;
204            WebPAC::Normalize::MARC::_clean();
205  }  }
206    
207    =head2 _set_lookup
208    
209    Set current lookup hash
210    
211  =head2 data_structure    _set_lookup( $lookup );
   
 Create in-memory data structure which represents normalized layout from  
 C<conf/normalize/*.xml>.  
   
 This structures are used to produce output.  
   
  my $ds = $webpac->data_structure($rec);  
212    
213  =cut  =cut
214    
215  sub data_structure {  my $lookup;
         my $self = shift;  
216    
217          my $log = $self->_get_logger();  sub _set_lookup {
218            $lookup = shift;
219    }
220    
221          my $rec = shift;  =head2 _get_lookup
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
222    
223          $log->debug("data_structure rec = ", sub { Dumper($rec) });  Get current lookup hash
224    
225          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));    my $lookup = _get_lookup();
226    
227          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  =cut
228    
229          my $cache_file;  sub _get_lookup {
230            return $lookup;
231    }
232    
233          if ($self->{'db'}) {  =head2 _set_load_row
                 my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );  
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });  
                 return $ds if ($ds);  
                 $log->debug("cache miss, creating");  
         }  
234    
235          my $tags = $self->all_tags();  Setup code reference which will return L<data_structure> from
236    L<WebPAC::Store>
237    
238          $log->debug("tags: ",sub { join(", ",@{ $tags }) });    _set_load_row(sub {
239                    my ($database,$input,$mfn) = @_;
240                    $store->load_row( database => $database, input => $input, id => $mfn );
241      });
242    
243          my $ds;  =cut
244    
245          foreach my $field (@{ $tags }) {  sub _set_load_row {
246            my $coderef = shift;
247            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
248    
249                  my $row;          $load_row_coderef = $coderef;
250    }
251    
252  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  =head2 _debug
253    
254                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  Change level of debug warnings
                         my $format;  
255    
256                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');    _debug( 2 );
                         $format = $tag->{'value'} || $tag->{'content'};  
257    
258                          my @v;  =cut
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->_rec_to_arr($rec,$format,'fill_in');  
                         } else {  
                                 @v = $self->_rec_to_arr($rec,$format,'parse');  
                         }  
                         if (! @v) {  
                                 $log->debug("$field <",$self->{tag},"> format: $format no values");  
                                 next;  
                         } else {  
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
259    
260                          if ($tag->{'sort'}) {  sub _debug {
261                                  @v = $self->sort_arr(@v);          my $l = shift;
262                          }          return $debug unless defined($l);
263            warn "debug level $l",$/ if ($l > 0);
264            $debug = $l;
265            $WebPAC::Normalize::MARC::debug = $debug;
266    }
267    
268                          # use format?  =head1 Functions to create C<data_structure>
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
269    
270                          # delimiter will join repeatable fields  Those functions generally have to first in your normalization file.
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
271    
272                          # default types  =head2 search_display
                         my @types = qw(display search);  
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("tag $field / $type [",sub { join(",",@v) }, "] ", $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
273    
274                                  } else {  Define output for L<search> and L<display> at the same time
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
275    
276      search_display('Title', rec('200','a') );
277    
                 }  
278    
279                  if ($row) {  =cut
                         $row->{'tag'} = $field;  
280    
281                          # TODO: name_sigular, name_plural  sub search_display {
282                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};          my $name = shift or die "search_display needs name as first argument";
283                          my $row_name = $name ? $self->_x($name) : $field;          my @o = grep { defined($_) && $_ ne '' } @_;
284            return unless (@o);
285                          # post-sort all values in field          $out->{$name}->{search} = \@o;
286                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {          $out->{$name}->{display} = \@o;
287                                  $log->warn("sort at field tag not implemented");  }
                         }  
288    
289                          $ds->{$row_name} = $row;  =head2 tag
290    
291                          $log->debug("row $field: ",sub { Dumper($row) });  Old name for L<search_display>, but supported
                 }  
292    
293          }  =cut
294    
295    sub tag {
296            search_display( @_ );
297    }
298    
299          $self->{'db'}->save_ds(  =head2 display
                 id => $id,  
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
300    
301          $log->debug("ds: ", sub { Dumper($ds) });  Define output just for I<display>
302    
303          $log->logconfess("data structure returned is not array any more!") if wantarray;    @v = display('Title', rec('200','a') );
304    
305          return $ds;  =cut
306    
307    sub _field {
308            my $type = shift or confess "need type -- BUG?";
309            my $name = shift or confess "needs name as first argument";
310            my @o = grep { defined($_) && $_ ne '' } @_;
311            return unless (@o);
312            $out->{$name}->{$type} = \@o;
313  }  }
314    
315  =head2 parse  sub display { _field( 'display', @_ ) }
   
 Perform smart parsing of string, skipping delimiters for fields which aren't  
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
316    
317   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  =head2 search
318    
319  Filters are implemented here. While simple form of filters looks like this:  Prepare values just for I<search>
320    
321    filter{name_of_filter}    @v = search('Title', rec('200','a') );
322    
323  but, filters can also have variable number of parametars like this:  =cut
324    
325    filter{name_of_filter(param,param,param)}  sub search { _field( 'search', @_ ) }
326    
327  =cut  =head2 sorted
328    
329  my $warn_once;  Insert into lists which will be automatically sorted
330    
331  sub parse {   sorted('Title', rec('200','a') );
         my $self = shift;  
332    
333          my ($rec, $format_utf8, $i, $rec_size) = @_;  =cut
334    
335          return if (! $format_utf8);  sub sorted { _field( 'sorted', @_ ) }
336    
         my $log = $self->_get_logger();  
337    
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
338    
339          $i = 0 if (! $i);  =head1 Functions to extract data from input
340    
341          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  This function should be used inside functions to create C<data_structure> described
342    above.
343    
344          my @out;  =head2 _pack_subfields_hash
345    
346          $log->debug("format: $format [$i]");   @subfields = _pack_subfields_hash( $h );
347     $subfields = _pack_subfields_hash( $h, 1 );
348    
349          my $eval_code;  Return each subfield value in array or pack them all together and return scalar
350          # remove eval{...} from beginning  with subfields (denoted by C<^>) and values.
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
351    
352          my $filter_name;  =cut
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
353    
354          # did we found any (att all) field from format in row?  sub _pack_subfields_hash {
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
355    
356          my $f_step = 1;          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
357    
358          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {          my ($h,$include_subfields) = @_;
359    
360                  my $del = $1 || '';          # sanity and ease of use
361                  $prefix = $del if ($f_step == 1);          return $h if (ref($h) ne 'HASH');
362    
363                  my $fld_type = lc($2);          if ( defined($h->{subfields}) ) {
364                    my $sfs = delete $h->{subfields} || die "no subfields?";
365                    my @out;
366                    while (@$sfs) {
367                            my $sf = shift @$sfs;
368                            push @out, '^' . $sf if ($include_subfields);
369                            my $o = shift @$sfs;
370                            if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
371                                    # single element subfields are not arrays
372    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
373    
374                  # repeatable index                                  push @out, $h->{$sf};
                 my $r = $i;  
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
375                          } else {                          } else {
376                                  return;  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
377                                    push @out, $h->{$sf}->[$o];
378                          }                          }
379                  }                  }
380                    if ($include_subfields) {
381                  my $found = 0;                          return join('', @out);
382                  my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);                  } else {
383                            return @out;
384                  if ($found) {                  }
385                          $found_any->{$fld_type} += $found;          } else {
386                    if ($include_subfields) {
387                          # we will skip delimiter before first occurence of field!                          my $out = '';
388                          push @out, $del unless($found_any->{$fld_type} == 1);                          foreach my $sf (sort keys %$h) {
389                          push @out, $tmp;                                  if (ref($h->{$sf}) eq 'ARRAY') {
390                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
391                                    } else {
392                                            $out .= '^' . $sf . $h->{$sf};
393                                    }
394                            }
395                            return $out;
396                    } else {
397                            # FIXME this should probably be in alphabetical order instead of hash order
398                            values %{$h};
399                  }                  }
                 $f_step++;  
400          }          }
401    }
402    
403          # test if any fields found?  =head2 rec1
         return if (! $found_any->{'v'} && ! $found_any->{'s'});  
404    
405          my $out = join('',@out);  Return all values in some field
406    
407          if ($out) {    @v = rec1('200')
                 # add rest of format (suffix)  
                 $out .= $format;  
408    
409                  # add prefix if not there  TODO: order of values is probably same as in source data, need to investigate that
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
410    
411                  $log->debug("result: $out");  =cut
         }  
412    
413          if ($eval_code) {  sub rec1 {
414                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;          my $f = shift;
415                  $log->debug("about to eval{$eval} format: $out");          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
416                  return if (! $self->_eval($eval));          return unless (defined($rec) && defined($rec->{$f}));
417          }          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
418                    if (ref($rec->{$f}) eq 'ARRAY') {
419          if ($filter_name) {                  my @out;
420                  my @filter_args;                  foreach my $h ( @{ $rec->{$f} } ) {
421                  if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {                          if (ref($h) eq 'HASH') {
422                          @filter_args = split(/,/, $2);                                  push @out, ( _pack_subfields_hash( $h ) );
423                  }                          } else {
424                  if ($self->{'filter'}->{$filter_name}) {                                  push @out, $h;
425                          $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));                          }
                         unshift @filter_args, $out;  
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
426                  }                  }
427                    return @out;
428            } elsif( defined($rec->{$f}) ) {
429                    return $rec->{$f};
430          }          }
431    }
432    
433          return $out;  =head2 rec2
434    
435    Return all values in specific field and subfield
436    
437      @v = rec2('200','a')
438    
439    =cut
440    
441    sub rec2 {
442            my $f = shift;
443            return unless (defined($rec && $rec->{$f}));
444            my $sf = shift;
445            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
446            return map {
447                    if (ref($_->{$sf}) eq 'ARRAY') {
448                            @{ $_->{$sf} };
449                    } else {
450                            $_->{$sf};
451                    }
452            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
453  }  }
454    
455  =head2 fill_in  =head2 rec
456    
457  Workhourse of all: takes record from in-memory structure of database and  syntaxtic sugar for
 strings with placeholders and returns string or array of with substituted  
 values from record.  
458    
459   my $text = $webpac->fill_in($rec,'v250^a');    @v = rec('200')
460      @v = rec('200','a')
461    
462  Optional argument is ordinal number for repeatable fields. By default,  If rec() returns just single value, it will
463  it's assume to be first repeatable field (fields are perl array, so first  return scalar, not array.
 element is 0).  
 Following example will read second value from repeatable field.  
464    
465   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  =cut
466    
467  This function B<does not> perform parsing of format to inteligenty skip  sub rec {
468  delimiters before fields which aren't used.          my @out;
469            if ($#_ == 0) {
470                    @out = rec1(@_);
471            } elsif ($#_ == 1) {
472                    @out = rec2(@_);
473            }
474            if ($#out == 0 && ! wantarray) {
475                    return $out[0];
476            } elsif (@out) {
477                    return @out;
478            } else {
479                    return '';
480            }
481    }
482    
483  This method will automatically decode UTF-8 string to local code page  =head2 frec
 if needed.  
484    
485  There is optional parametar C<$record_size> which can be used to get sizes of  Returns first value from field
 all C<field^subfield> combinations in this format.  
486    
487   my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);    $v = frec('200');
488      $v = frec('200','a');
489    
490  =cut  =cut
491    
492  sub fill_in {  sub frec {
493          my $self = shift;          my @out = rec(@_);
494            warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0;
495            return shift @out;
496    }
497    
498          my $log = $self->_get_logger();  =head2 frec_eq
499    
500          my ($rec,$format,$i,$rec_size) = @_;  =head2 frec_ne
501    
502          $log->logconfess("need data record") unless ($rec);  Check if first values from two fields are same or different
         $log->logconfess("need format to parse") unless($format);  
503    
504          # iteration (for repeatable fields)    if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
505          $i ||= 0;          # values are same
506      } else {
507        # values are different
508      }
509    
510          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
511    could write something like:
512    
513          # FIXME remove for speedup?    if ( frec( '900','a' ) eq frec( '910','c' ) ) {
514          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          # yada tada
515      }
516    
517          if (utf8::is_utf8($format)) {  but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
518                  $format = $self->_x($format);  in order to parse text and create invalid function C<eqfrec>.
         }  
519    
520          my $found = 0;  =cut
521          my $just_single = 1;  
522    sub frec_eq {
523            my ( $f1,$sf1, $f2, $sf2 ) = @_;
524            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
525    }
526    
527          my $eval_code;  sub frec_ne {
528          # remove eval{...} from beginning          return ! frec_eq( @_ );
529          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  }
530    
531          my $filter_name;  =head2 regex
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
532    
533          {  Apply regex to some or all values
                 # fix warnings  
                 no warnings 'uninitialized';  
534    
535                  # do actual replacement of placeholders    @v = regex( 's/foo/bar/g', @v );
                 # repeatable fields  
                 if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                         $just_single = 0;  
                 }  
536    
537                  # non-repeatable fields  =cut
                 if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  
                         return if ($i > 0 && $just_single);  
                 }  
         }  
538    
539          if ($found) {  sub regex {
540                  $log->debug("format: $format");          my $r = shift;
541                  if ($eval_code) {          my @out;
542                          my $eval = $self->fill_in($rec,$eval_code,$i);          #warn "r: $r\n", dump(\@_);
543                          return if (! $self->_eval($eval));          foreach my $t (@_) {
544                  }                  next unless ($t);
545                  if ($filter_name && $self->{'filter'}->{$filter_name}) {                  eval "\$t =~ $r";
546                          $log->debug("filter '$filter_name' for $format");                  push @out, $t if ($t && $t ne '');
                         $format = $self->{'filter'}->{$filter_name}->($format);  
                         return unless(defined($format));  
                         $log->debug("filter result: $format");  
                 }  
                 # do we have lookups?  
                 if ($self->{'lookup'}) {  
                         if ($self->{'lookup'}->can('lookup')) {  
                                 my @lookup = $self->{lookup}->lookup($format);  
                                 $log->debug("lookup $format", join(", ", @lookup));  
                                 return @lookup;  
                         } else {  
                                 $log->warn("Have lookup object but can't invoke lookup method");  
                         }  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
547          }          }
548            return @out;
549  }  }
550    
551    =head2 prefix
552    
553    Prefix all values with a string
554    
555      @v = prefix( 'my_', @v );
556    
557    =cut
558    
559    sub prefix {
560            my $p = shift;
561            return @_ unless defined( $p );
562            return map { $p . $_ } grep { defined($_) } @_;
563    }
564    
565  =head2 _rec_to_arr  =head2 suffix
566    
567  Similar to C<parse> and C<fill_in>, but returns array of all repeatable fields. Usable  suffix all values with a string
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<paste>d or C<fill_id>ed. Last argument is name of operation: C<paste> or C<fill_in>.  
568    
569   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]','paste');    @v = suffix( '_my', @v );
570    
571  =cut  =cut
572    
573  sub _rec_to_arr {  sub suffix {
574          my $self = shift;          my $s = shift;
575            return @_ unless defined( $s );
576            return map { $_ . $s } grep { defined($_) } @_;
577    }
578    
579          my ($rec, $format_utf8, $code) = @_;  =head2 surround
580    
581          my $log = $self->_get_logger();  surround all values with a two strings
582    
583          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = surround( 'prefix_', '_suffix', @v );
         return if (! $format_utf8);  
584    
585          $log->debug("using $code on $format_utf8");  =cut
586    
587          my $i = 0;  sub surround {
588          my $max = 0;          my $p = shift;
589          my @arr;          my $s = shift;
590          my $rec_size = {};          $p = '' unless defined( $p );
591            $s = '' unless defined( $s );
592            return map { $p . $_ . $s } grep { defined($_) } @_;
593    }
594    
595          while ($i <= $max) {  =head2 first
                 my @v = $self->$code($rec,$format_utf8,$i++,\$rec_size);  
                 if ($rec_size) {  
                         foreach my $f (keys %{ $rec_size }) {  
                                 $max = $rec_size->{$f} if ($rec_size->{$f} > $max);  
                         }  
                         $log->debug("max set to $max");  
                         undef $rec_size;  
                 }  
                 if (@v) {  
                         push @arr, @v;  
                 } else {  
                         push @arr, '' if ($max > $i);  
                 }  
         }  
596    
597          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  Return first element
598    
599      $v = first( @v );
600    
601    =cut
602    
603          return @arr;  sub first {
604            my $r = shift;
605            return $r;
606  }  }
607    
608    =head2 lookup
609    
610  =head2 get_data  Consult lookup hashes for some value
611    
612  Returns value from record.    @v = lookup(
613            sub {
614                    'ffkk/peri/mfn'.rec('000')
615            },
616            'ffkk','peri','200-a-200-e',
617            sub {
618                    first(rec(200,'a')).' '.first(rec('200','e'))
619            }
620      );
621    
622   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  Code like above will be B<automatically generated> using L<WebPAC::Parse> from
623    normal lookup definition in C<conf/lookup/something.pl> which looks like:
624    
625  Required arguments are:    lookup(
626            # which results to return from record recorded in lookup
627            sub { 'ffkk/peri/mfn' . rec('000') },
628            # from which database and input
629            'ffkk','peri',
630            # such that following values match
631            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
632            # if this part is missing, we will try to match same fields
633            # from lookup record and current one, or you can override
634            # which records to use from current record using
635            sub { rec('900','x') . ' ' . rec('900','y') },
636      )
637    
638  =over 8  You can think about this lookup as SQL (if that helps):
639    
640  =item C<$rec>    select
641            sub { what }
642      from
643            database, input
644      where
645        sub { filter from lookuped record }
646      having
647        sub { optional filter on current record }
648    
649  record reference  Easy as pie, right?
650    
651  =item C<$f>  =cut
652    
653  field  sub lookup {
654            my ($what, $database, $input, $key, $having) = @_;
655    
656  =item C<$sf>          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
657    
658  optional subfield          warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
659            return unless (defined($lookup->{$database}->{$input}->{$key}));
660    
661  =item C<$i>          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
662    
663  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )          my $mfns;
664            my @having = $having->();
665    
666  =item C<$found>          warn "## having = ", dump( @having ) if ($debug > 2);
667    
668  optional variable that will be incremeted if preset          foreach my $h ( @having ) {
669                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
670                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
671                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
672                    }
673            }
674    
675  =item C<$rec_size>          return unless ($mfns);
676    
677  hash to hold maximum occurances of C<field^subfield> combinations          my @mfns = sort keys %$mfns;
 (which can be accessed using keys in same format)  
678    
679  =back          warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
680    
681  Returns value or empty string, updates C<$found> and C<rec_size>          my $old_rec = $rec;
682  if present.          my @out;
683    
684  =cut          foreach my $mfn (@mfns) {
685                    $rec = $load_row_coderef->( $database, $input, $mfn );
686    
687  sub get_data {                  warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
         my $self = shift;  
688    
689          my ($rec,$f,$sf,$i,$found,$cache) = @_;                  my @vals = $what->();
690    
691          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');                  push @out, ( @vals );
692    
693          if (defined($$cache)) {                  warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
694          }          }
695    
696          return '' unless ($$rec->{$f}->[$i]);  #       if (ref($lookup->{$k}) eq 'ARRAY') {
697    #               return @{ $lookup->{$k} };
698    #       } else {
699    #               return $lookup->{$k};
700    #       }
701    
702          {          $rec = $old_rec;
703                  no strict 'refs';  
704                  if (defined($sf)) {          warn "## lookup returns = ", dump(@out), $/ if ($debug);
705                          $$found++ if (defined($$found) && $$rec->{$f}->[$i]->{$sf});  
706                          return $$rec->{$f}->[$i]->{$sf};          if ($#out == 0) {
707                  } else {                  return $out[0];
708                          $$found++ if (defined($$found));          } else {
709                          # it still might have subfields, just                  return @out;
                         # not specified, so we'll dump some debug info  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= '$' . $k .':' . $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 }  
710          }          }
711  }  }
712    
713    =head2 save_into_lookup
714    
715  =head2 apply_format  Save value into lookup. It associates current database, input
716    and specific keys with one or more values which will be
717    associated over MFN.
718    
719  Apply format specified in tag with C<format_name="name"> and  MFN will be extracted from first occurence current of field 000
720  C<format_delimiter=";;">.  in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
721    
722   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    my $nr = save_into_lookup($database,$input,$key,sub {
723            # code which produce one or more values
724      });
725    
726  Formats can contain C<lookup{...}> if you need them.  It returns number of items saved.
727    
728    This function shouldn't be called directly, it's called from code created by
729    L<WebPAC::Parser>.
730    
731  =cut  =cut
732    
733  sub apply_format {  sub save_into_lookup {
734          my $self = shift;          my ($database,$input,$key,$coderef) = @_;
735            die "save_into_lookup needs database" unless defined($database);
736            die "save_into_lookup needs input" unless defined($input);
737            die "save_into_lookup needs key" unless defined($key);
738            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
739    
740            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
741    
742          my ($name,$delimiter,$data) = @_;          my $mfn =
743                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
744                    defined($config->{_mfn})        ?       $config->{_mfn}         :
745                                                                                    die "mfn not defined or zero";
746    
747          my $log = $self->_get_logger();          my $nr = 0;
748    
749          if (! $self->{'import_xml'}->{'format'}->{$name}) {          foreach my $v ( $coderef->() ) {
750                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});                  $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
751                  return $data;                  warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
752                    $nr++;
753          }          }
754    
755          $log->warn("no delimiter for format $name") if (! $delimiter);          return $nr;
756    }
757    
758    =head2 config
759    
760    Consult config values stored in C<config.yml>
761    
762      # return database code (key under databases in yaml)
763      $database_code = config();    # use _ from hash
764      $database_name = config('name');
765      $database_input_name = config('input name');
766    
767          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Up to three levels are supported.
768    
769          my @data = split(/\Q$delimiter\E/, $data);  =cut
770    
771    sub config {
772            return unless ($config);
773    
774            my $p = shift;
775    
776          my $out = sprintf($format, @data);          $p ||= '';
         $log->debug("using format $name [$format] on $data to produce: $out");  
777    
778          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          my $v;
779                  return $self->{'lookup'}->lookup($out);  
780            warn "### getting config($p)\n" if ($debug > 1);
781    
782            my @p = split(/\s+/,$p);
783            if ($#p < 0) {
784                    $v = $config->{ '_' };  # special, database code
785          } else {          } else {
786                  return $out;  
787                    my $c = dclone( $config );
788    
789                    foreach my $k (@p) {
790                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
791                            if (ref($c) eq 'ARRAY') {
792                                    $c = shift @$c;
793                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
794                                    last;
795                            }
796    
797                            if (! defined($c->{$k}) ) {
798                                    $c = undef;
799                                    last;
800                            } else {
801                                    $c = $c->{$k};
802                            }
803                    }
804                    $v = $c if ($c);
805    
806          }          }
807    
808            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
809            warn "config( '$p' ) is empty\n" if (! $v);
810    
811            return $v;
812  }  }
813    
814  =head2 sort_arr  =head2 id
815    
816    Returns unique id of this record
817    
818  Sort array ignoring case and html in data    $id = id();
819    
820   my @sorted = $webpac->sort_arr(@unsorted);  Returns C<42/2> for 2nd occurence of MFN 42.
821    
822  =cut  =cut
823    
824  sub sort_arr {  sub id {
825          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
826            return $mfn . ( WebPAC::Normalize::MARC::_created_marc_records() || '' );
827    }
828    
829    =head2 join_with
830    
831          my $log = $self->_get_logger();  Joins walues with some delimiter
832    
833          # FIXME add Schwartzian Transformation?    $v = join_with(", ", @v);
834    
835          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
836    
837          return @sorted;  sub join_with {
838            my $d = shift;
839            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
840            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
841            return '' unless defined($v);
842            return $v;
843  }  }
844    
845    =head2 split_rec_on
846    
847  =head1 INTERNAL METHODS  Split record subfield on some regex and take one of parts out
848    
849  =head2 _sort_by_order    $a_before_semi_column =
850            split_rec_on('200','a', /\s*;\s*/, $part);
851    
852  Sort xml tags data structure accoding to C<order=""> attribute.  C<$part> is optional number of element. First element is
853    B<1>, not 0!
854    
855    If there is no C<$part> parameter or C<$part> is 0, this function will
856    return all values produced by splitting.
857    
858  =cut  =cut
859    
860  sub _sort_by_order {  sub split_rec_on {
861          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
862    
863          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          my ($fld, $sf, $regex, $part) = @_;
864                  $self->{'import_xml'}->{'indexer'}->{$a};          warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
865    
866          return $va <=> $vb;          my @r = rec( $fld, $sf );
867  }          my $v = shift @r;
868            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
869    
870            return '' if ( ! defined($v) || $v =~ /^\s*$/);
871    
872  =head2 _x          my @s = split( $regex, $v );
873            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
874            if ($part && $part > 0) {
875                    return $s[ $part - 1 ];
876            } else {
877                    return @s;
878            }
879    }
880    
881  Convert strings from C<conf/normalize/*.xml> encoding into application  my $hash;
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
882    
883   my $text = $n->_x('normalize text string');  =head2 set
884    
885  This is a stub so that other modules doesn't have to implement it.    set( key => 'value' );
886    
887  =cut  =cut
888    
889  sub _x {  sub set {
890          my $self = shift;          my ($k,$v) = @_;
891          return shift;          warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
892  }          $hash->{$k} = $v;
893    };
894    
895    =head2 get
896    
897  =head1 AUTHOR    get( 'key' );
898    
899  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
900    
901  =head1 COPYRIGHT & LICENSE  sub get {
902            my $k = shift || return;
903            my $v = $hash->{$k};
904            warn "## get $k = ", dump( $v ), $/ if ( $debug );
905            return $v;
906    }
907    
908  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 count
909    
910  This program is free software; you can redistribute it and/or modify it    if ( count( @result ) == 1 ) {
911  under the same terms as Perl itself.          # do something if only 1 result is there
912      }
913    
914  =cut  =cut
915    
916  1; # End of WebPAC::Normalize  sub count {
917            warn "## count ",dump(@_),$/ if ( $debug );
918            return @_ . '';
919    }
920    
921    # END
922    1;

Legend:
Removed from v.433  
changed lines
  Added in v.1038

  ViewVC Help
Powered by ViewVC 1.1.26