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

Legend:
Removed from v.125  
changed lines
  Added in v.1205

  ViewVC Help
Powered by ViewVC 1.1.26