/[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 550 by dpavlin, Fri Jun 30 18:48:33 2006 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';  use Exporter 'import';
3  @EXPORT = qw/  our @EXPORT = qw/
4          _set_rec _set_lookup          _set_ds _set_lookup
5            _set_load_row
6          _get_ds _clean_ds          _get_ds _clean_ds
7            _debug
8            _pack_subfields_hash
9    
10          tag search display          to
11          marc marc_indicators marc_repeatable_subfield          search_display search display sorted
12    
13          rec1 rec2 rec          rec1 rec2 rec
14            frec frec_eq frec_ne
15          regex prefix suffix surround          regex prefix suffix surround
16          first lookup join_with          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;
# Line 17  use strict; Line 28  use strict;
28    
29  #use base qw/WebPAC::Common/;  #use base qw/WebPAC::Common/;
30  use Data::Dump qw/dump/;  use Data::Dump qw/dump/;
31  use Encode qw/from_to/;  use Carp qw/confess/;
32    
33  # debugging warn(s)  # debugging warn(s)
34  my $debug = 0;  my $debug = 0;
35    _debug( $debug );
36    
37    # FIXME
38    use WebPAC::Normalize::ISBN;
39    push @EXPORT, ( 'isbn_10', 'isbn_13' );
40    
41  =head1 NAME  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 - describe normalisaton rules using sets  use Storable qw/dclone/;
51    
52  =head1 VERSION  =head1 NAME
53    
54  Version 0.06  WebPAC::Normalize - describe normalisaton rules using sets
55    
56  =cut  =cut
57    
58  our $VERSION = '0.06';  our $VERSION = '0.36';
59    
60  =head1 SYNOPSIS  =head1 SYNOPSIS
61    
# Line 46  means that you check it's validity befor Line 68  means that you check it's validity befor
68  C<perl -c normalize.pl>.  C<perl -c normalize.pl>.
69    
70  Normalisation can generate multiple output normalized data. For now, supported output  Normalisation can generate multiple output normalized data. For now, supported output
71  types (on the left side of definition) are: C<tag>, C<display>, C<search> and  types (on the left side of definition) are: C<search_display>, C<display>, C<search> and
72  C<marc>.  C<marc>.
73    
74  =head1 FUNCTIONS  =head1 FUNCTIONS
# Line 59  All other functions are available for us Line 81  All other functions are available for us
81  Return data structure  Return data structure
82    
83    my $ds = WebPAC::Normalize::data_structure(    my $ds = WebPAC::Normalize::data_structure(
84          lookup => $lookup->lookup_hash,          lookup => $lookup_hash,
85          row => $row,          row => $row,
86          rules => $normalize_pl_config,          rules => $normalize_pl_config,
87          marc_encoding => 'utf-8',          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<lookup>, C<row>, C<rules> and C<log> are mandatory while all  Options C<row>, C<rules> and C<log> are mandatory while all
96  other are optional.  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.  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  Since this function isn't exported you have to call it with
# Line 75  C<WebPAC::Normalize::data_structure>. Line 105  C<WebPAC::Normalize::data_structure>.
105    
106  =cut  =cut
107    
108    my $load_row_coderef;
109    
110  sub data_structure {  sub data_structure {
111          my $arg = {@_};          my $arg = {@_};
112    
113          die "need row argument" unless ($arg->{row});          die "need row argument" unless ($arg->{row});
114          die "need normalisation argument" unless ($arg->{rules});          die "need normalisation argument" unless ($arg->{rules});
115    
116          no strict 'subs';          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
117          _set_lookup( $arg->{lookup} );          _set_ds( $arg->{row} );
118          _set_rec( $arg->{row} );          _set_config( $arg->{config} ) if defined($arg->{config});
119          _clean_ds( %{ $arg } );          _clean_ds( %{ $arg } );
120          eval "$arg->{rules}";          $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 ($@);          die "error evaling $arg->{rules}: $@\n" if ($@);
126    
127          return _get_ds();          return _get_ds();
128  }  }
129    
130  =head2 _set_rec  =head2 _set_ds
131    
132  Set current record hash  Set current record hash
133    
134    _set_rec( $rec );    _set_ds( $rec );
135    
136  =cut  =cut
137    
138  my $rec;  my $rec;
139    
140  sub _set_rec {  sub _set_ds {
141          $rec = shift or die "no record hash";          $rec = shift or die "no record hash";
142            $WebPAC::Normalize::MARC::rec = $rec;
143    }
144    
145    =head2
146    
147      my $rec = _get_rec();
148    
149    =cut
150    
151    sub _get_rec { $rec };
152    
153    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    =head2 _set_config
160    
161    Set current config hash
162    
163      _set_config( $config );
164    
165    Magic keys are:
166    
167    =over 4
168    
169    =item _
170    
171    Code of current database
172    
173    =item _mfn
174    
175    Current MFN
176    
177    =back
178    
179    =cut
180    
181    my $config;
182    
183    sub _set_config {
184            $config = shift;
185  }  }
186    
187  =head2 _get_ds  =head2 _get_ds
# Line 113  Return hash formatted as data structure Line 192  Return hash formatted as data structure
192    
193  =cut  =cut
194    
195  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);  my $out;
196    
197  sub _get_ds {  sub _get_ds {
198    #warn "## out = ",dump($out);
199          return $out;          return $out;
200  }  }
201    
# Line 129  Clean data structure hash for next recor Line 209  Clean data structure hash for next recor
209    
210  sub _clean_ds {  sub _clean_ds {
211          my $a = {@_};          my $a = {@_};
212          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();          $out = undef;
213          $marc_encoding = $a->{marc_encoding};          WebPAC::Normalize::MARC::_clean();
214  }  }
215    
216  =head2 _set_lookup  =head2 _set_lookup
# Line 147  sub _set_lookup { Line 227  sub _set_lookup {
227          $lookup = shift;          $lookup = shift;
228  }  }
229    
230  =head2 _get_marc_fields  =head2 _get_lookup
231    
232  Get all fields defined by calls to C<marc>  Get current lookup hash
233    
234          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );    my $lookup = _get_lookup();
235    
236    =cut
237    
238    sub _get_lookup {
239            return $lookup;
240    }
241    
242  We are using I<magic> which detect repeatable fields only from  =head2 _set_load_row
 sequence of field/subfield data generated by normalization.  
243    
244  Repeatable field is created if there is second occurence of same subfield or  Setup code reference which will return L<data_structure> from
245  if any of indicators are different. This is sane for most cases except for  L<WebPAC::Store>
 non-repeatable fields with repeatable subfields.  
246    
247  You can change behaviour of that using C<marc_repeatable_subfield>.    _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 _get_marc_fields {  sub _set_load_row {
255            my $coderef = shift;
256            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
257    
258            $load_row_coderef = $coderef;
259    }
260    
261          # first, sort all existing fields  =head2 _debug
         # XXX might not be needed, but modern perl might randomize elements in hash  
         my @sorted_marc_record = sort {  
                 $a->[0] . $a->[3] cmp $b->[0] . $b->[3]  
         } @{ $marc_record };  
262    
263          # output marc fields  Change level of debug warnings
         my @m;  
264    
265          # count unique field-subfields (used for offset when walking to next subfield)    _debug( 2 );
         my $u;  
         map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;  
266    
267          if ($debug) {  =cut
                 warn "## marc_repeatable_subfield ", dump( $marc_repeatable_subfield ), $/;  
                 warn "## marc_record ", dump( $marc_record ), $/;  
                 warn "## sorted_marc_record ", dump( \@sorted_marc_record ), $/;  
                 warn "## subfield count ", dump( $u ), $/;  
         }  
268    
269          my $len = $#sorted_marc_record;  sub _debug {
270          my $visited;          my $l = shift;
271          my $i = 0;          return $debug unless defined($l);
272          my $field;          warn "debug level $l",$/ if ($l > 0);
273            $debug = $l;
274            $WebPAC::Normalize::MARC::debug = $debug;
275    }
276    
277          foreach ( 0 .. $len ) {  =head1 Functions to create C<data_structure>
278    
279                  # find next element which isn't visited  Those functions generally have to first in your normalization file.
                 while ($visited->{$i}) {  
                         $i = ($i + 1) % ($len + 1);  
                 }  
280    
281                  # mark it visited  =head2 to
                 $visited->{$i}++;  
282    
283                  my $row = $sorted_marc_record[$i];  Generic way to set values for some name
284    
285                  # field and subfield which is key for    to('field-name', 'name-value' => rec('200','a') );
                 # marc_repeatable_subfield and u  
                 my $fsf = $row->[0] . $row->[3];  
   
                 if ($debug > 1) {  
   
                         print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;  
                         print "### this [$i]: ", dump( $row ),$/;  
                         print "### sf: ", $row->[3], " vs ", $field->[3],  
                                 $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,  
                                 if ($#$field >= 0);  
286    
287                  }  There are many helpers defined below which might be easier to use.
288    
289                  # if field exists  =cut
                 if ( $#$field >= 0 ) {  
                         if (  
                                 $row->[0] ne $field->[0] ||             # field  
                                 $row->[1] ne $field->[1] ||             # i1  
                                 $row->[2] ne $field->[2]                # i2  
                         ) {  
                                 push @m, $field;  
                                 warn "## saved/1 ", dump( $field ),$/ if ($debug);  
                                 $field = $row;  
   
                         } elsif (  
                                 ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)  
                                 ||  
                                 ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable  
                                         ! $marc_repeatable_subfield->{ $fsf }  
                                 )  
                         ) {  
                                 push @m, $field;  
                                 warn "## saved/2 ", dump( $field ),$/ if ($debug);  
                                 $field = $row;  
290    
291                          } else {  sub to {
292                                  # append new subfields to existing field          my $type = shift or confess "need type -- BUG?";
293                                  push @$field, ( $row->[3], $row->[4] );          my $name = shift or confess "needs name as first argument";
294                          }          my @o = grep { defined($_) && $_ ne '' } @_;
295                  } else {          return unless (@o);
296                          # insert first field          $out->{$name}->{$type} = \@o;
297                          $field = $row;  }
                 }  
298    
299                  if (! $marc_repeatable_subfield->{ $fsf }) {  =head2 search_display
                         # make step to next subfield  
                         $i = ($i + $u->{ $fsf } ) % ($len + 1);  
                 }  
         }  
300    
301          if ($#$field >= 0) {  Define output for L<search> and L<display> at the same time
                 push @m, $field;  
                 warn "## saved/3 ", dump( $field ),$/ if ($debug);  
         }  
302    
303          return @m;    search_display('Title', rec('200','a') );
 }  
304    
305  =head1 Functions to create C<data_structure>  =cut
306    
307  Those functions generally have to first in your normalization file.  sub search_display {
308            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  =head2 tag  =head2 tag
316    
317  Define new tag for I<search> and I<display>.  Old name for L<search_display>, it will probably be removed at one point.
   
   tag('Title', rec('200','a') );  
   
318    
319  =cut  =cut
320    
321  sub tag {  sub tag {
322          my $name = shift or die "tag needs name as first argument";          search_display( @_ );
         my @o = grep { defined($_) && $_ ne '' } @_;  
         return unless (@o);  
         $out->{$name}->{tag} = $name;  
         $out->{$name}->{search} = \@o;  
         $out->{$name}->{display} = \@o;  
323  }  }
324    
325  =head2 display  =head2 display
326    
327  Define tag just for I<display>  Define output just for I<display>
328    
329    @v = display('Title', rec('200','a') );    @v = display('Title', rec('200','a') );
330    
331  =cut  =cut
332    
333  sub display {  sub display { to( 'display', @_ ) }
         my $name = shift or die "display needs name as first argument";  
         my @o = grep { defined($_) && $_ ne '' } @_;  
         return unless (@o);  
         $out->{$name}->{tag} = $name;  
         $out->{$name}->{display} = \@o;  
 }  
334    
335  =head2 search  =head2 search
336    
# Line 311  Prepare values just for I<search> Line 340  Prepare values just for I<search>
340    
341  =cut  =cut
342    
343  sub search {  sub search { to( 'search', @_ ) }
         my $name = shift or die "search needs name as first argument";  
         my @o = grep { defined($_) && $_ ne '' } @_;  
         return unless (@o);  
         $out->{$name}->{tag} = $name;  
         $out->{$name}->{search} = \@o;  
 }  
344    
345  =head2 marc  =head2 sorted
346    
347  Save value for MARC field  Insert into lists which will be automatically sorted
348    
349    marc('900','a', rec('200','a') );   sorted('Title', rec('200','a') );
350    
351  =cut  =cut
352    
353  sub marc {  sub sorted { to( 'sorted', @_ ) }
         my $f = shift or die "marc needs field";  
         die "marc field must be numer" unless ($f =~ /^\d+$/);  
354    
355          my $sf = shift or die "marc needs subfield";  =head2 row
356    
357          foreach (@_) {  Insert new row of data into output module
                 my $v = $_;             # make var read-write for Encode  
                 next unless (defined($v) && $v !~ /^\s*$/);  
                 from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);  
                 my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');  
                 push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];  
         }  
 }  
358    
359  =head2 marc_repeatable_subfield    row( column => 'foo', column2 => 'bar' );
360    
361  Save values for MARC repetable subfield  =cut
362    
363    marc_repeatable_subfield('910', 'z', rec('909') );  use Data::Dump qw/dump/;
364    
365  =cut  sub row {
366            die "array doesn't have even number of elements but $#_: ",dump( @_ ) if $#_ % 2 != 1;
367    
368  sub marc_repeatable_subfield {          push @{ $out->{'_rows'} }, {@_};
         my ($f,$sf) = @_;  
         die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);  
         $marc_repeatable_subfield->{ $f . $sf }++;  
         marc(@_);  
369  }  }
370    
 =head2 marc_indicators  
371    
372  Set both indicators for MARC field  =head1 Functions to extract data from input
373    
374    This function should be used inside functions to create C<data_structure> described
375    above.
376    
377    marc_indicators('900', ' ', 1);  =head2 _pack_subfields_hash
378    
379  Any indicator value other than C<0-9> will be treated as undefined.   @subfields = _pack_subfields_hash( $h );
380     $subfields = _pack_subfields_hash( $h, 1 );
381    
382    Return each subfield value in array or pack them all together and return scalar
383    with subfields (denoted by C<^>) and values.
384    
385  =cut  =cut
386    
387  sub marc_indicators {  sub _pack_subfields_hash {
         my $f = shift || die "marc_indicators need field!\n";  
         my ($i1,$i2) = @_;  
         die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));  
         die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));  
388    
389          $i1 = ' ' if ($i1 !~ /^\d$/);          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
         $i2 = ' ' if ($i2 !~ /^\d$/);  
         @{ $marc_indicators->{$f} } = ($i1,$i2);  
 }  
390    
391            my ($hash,$include_subfields) = @_;
392    
393  =head1 Functions to extract data from input          # sanity and ease of use
394            return $hash if (ref($hash) ne 'HASH');
395    
396  This function should be used inside functions to create C<data_structure> described          my $h = dclone( $hash );
397  above.  
398            if ( defined($h->{subfields}) ) {
399                    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                                    push @out, $h->{$sf};
410                            } else {
411    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
412                                    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  =head2 rec1  =head2 rec1
439    
# Line 396  TODO: order of values is probably same a Line 447  TODO: order of values is probably same a
447    
448  sub rec1 {  sub rec1 {
449          my $f = shift;          my $f = shift;
450            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
451          return unless (defined($rec) && defined($rec->{$f}));          return unless (defined($rec) && defined($rec->{$f}));
452            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
453          if (ref($rec->{$f}) eq 'ARRAY') {          if (ref($rec->{$f}) eq 'ARRAY') {
454                  return map {                  my @out;
455                          if (ref($_) eq 'HASH') {                  foreach my $h ( @{ $rec->{$f} } ) {
456                                  values %{$_};                          if (ref($h) eq 'HASH') {
457                                    push @out, ( _pack_subfields_hash( $h ) );
458                          } else {                          } else {
459                                  $_;                                  push @out, $h;
460                          }                          }
461                  } @{ $rec->{$f} };                  }
462                    return @out;
463          } elsif( defined($rec->{$f}) ) {          } elsif( defined($rec->{$f}) ) {
464                  return $rec->{$f};                  return $rec->{$f};
465          }          }
# Line 422  sub rec2 { Line 477  sub rec2 {
477          my $f = shift;          my $f = shift;
478          return unless (defined($rec && $rec->{$f}));          return unless (defined($rec && $rec->{$f}));
479          my $sf = shift;          my $sf = shift;
480          return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };          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  =head2 rec
# Line 432  syntaxtic sugar for Line 494  syntaxtic sugar for
494    @v = rec('200')    @v = rec('200')
495    @v = rec('200','a')    @v = rec('200','a')
496    
497    If rec() returns just single value, it will
498    return scalar, not array.
499    
500  =cut  =cut
501    
502  sub rec {  sub rec {
503            my @out;
504          if ($#_ == 0) {          if ($#_ == 0) {
505                  return rec1(@_);                  @out = rec1(@_);
506          } elsif ($#_ == 1) {          } elsif ($#_ == 1) {
507                  return rec2(@_);                  @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    =head2 frec
519    
520    Returns first value from field
521    
522      $v = frec('200');
523      $v = frec('200','a');
524    
525    =cut
526    
527    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    =head2 frec_eq
534    
535    =head2 frec_ne
536    
537    Check if first values from two fields are same or different
538    
539      if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
540            # values are same
541      } else {
542        # values are different
543      }
544    
545    Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
546    could write something like:
547    
548      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
549            # 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
556    
557    sub frec_eq {
558            my ( $f1,$sf1, $f2, $sf2 ) = @_;
559            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
560    }
561    
562    sub frec_ne {
563            return ! frec_eq( @_ );
564    }
565    
566  =head2 regex  =head2 regex
567    
568  Apply regex to some or all values  Apply regex to some or all values
# Line 471  Prefix all values with a string Line 592  Prefix all values with a string
592  =cut  =cut
593    
594  sub prefix {  sub prefix {
595          my $p = shift or die "prefix needs string as first argument";          my $p = shift;
596            return @_ unless defined( $p );
597          return map { $p . $_ } grep { defined($_) } @_;          return map { $p . $_ } grep { defined($_) } @_;
598  }  }
599    
# Line 484  suffix all values with a string Line 606  suffix all values with a string
606  =cut  =cut
607    
608  sub suffix {  sub suffix {
609          my $s = shift or die "suffix needs string as first argument";          my $s = shift;
610            return @_ unless defined( $s );
611          return map { $_ . $s } grep { defined($_) } @_;          return map { $_ . $s } grep { defined($_) } @_;
612  }  }
613    
# Line 497  surround all values with a two strings Line 620  surround all values with a two strings
620  =cut  =cut
621    
622  sub surround {  sub surround {
623          my $p = shift or die "surround need prefix as first argument";          my $p = shift;
624          my $s = shift or die "surround needs suffix as second argument";          my $s = shift;
625            $p = '' unless defined( $p );
626            $s = '' unless defined( $s );
627          return map { $p . $_ . $s } grep { defined($_) } @_;          return map { $p . $_ . $s } grep { defined($_) } @_;
628  }  }
629    
# Line 519  sub first { Line 644  sub first {
644    
645  Consult lookup hashes for some value  Consult lookup hashes for some value
646    
647    @v = lookup( $v );    @v = lookup(
648    @v = lookup( @v );          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      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    You can think about this lookup as SQL (if that helps):
674    
675      select
676            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    Easy as pie, right?
685    
686  =cut  =cut
687    
688  sub lookup {  sub lookup {
689          my $k = shift or return;          my ($what, $database, $input, $key, $having) = @_;
690          return unless (defined($lookup->{$k}));  
691          if (ref($lookup->{$k}) eq 'ARRAY') {          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
692                  return @{ $lookup->{$k} };  
693            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
694            return unless (defined($lookup->{$database}->{$input}->{$key}));
695    
696            confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
697    
698            my $mfns;
699            my @having = $having->();
700    
701            warn "## having = ", dump( @having ) if ($debug > 2);
702    
703            foreach my $h ( @having ) {
704                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
705                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
706                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
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 {
744                    return @out;
745            }
746    }
747    
748    =head2 save_into_lookup
749    
750    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    MFN will be extracted from first occurence current of field 000
755    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
756    
757      my $nr = save_into_lookup($database,$input,$key,sub {
758            # code which produce one or more values
759      });
760    
761    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
767    
768    sub save_into_lookup {
769            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 $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 $nr = 0;
783    
784            foreach my $v ( $coderef->() ) {
785                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
786                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
787                    $nr++;
788            }
789    
790            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    sub config {
807            return unless ($config);
808    
809            my $p = shift;
810    
811            $p ||= '';
812    
813            my $v;
814    
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 $lookup->{$k};  
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 id
850    
851    Returns unique id of this record
852    
853      $id = id();
854    
855    Returns C<42/2> for 2nd occurence of MFN 42.
856    
857    =cut
858    
859    sub id {
860            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  =head2 join_with
# Line 544  Joins walues with some delimiter Line 871  Joins walues with some delimiter
871    
872  sub join_with {  sub join_with {
873          my $d = shift;          my $d = shift;
874          return join($d, grep { defined($_) && $_ ne '' } @_);          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    Split record subfield on some regex and take one of parts out
883    
884      $a_before_semi_column =
885            split_rec_on('200','a', /\s*;\s*/, $part);
886    
887    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
894    
895    sub split_rec_on {
896            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
897    
898            my ($fld, $sf, $regex, $part) = @_;
899            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
900    
901            my @r = rec( $fld, $sf );
902            my $v = shift @r;
903            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
904    
905            return '' if ( ! defined($v) || $v =~ /^\s*$/);
906    
907            my @s = split( $regex, $v );
908            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
909            if ($part && $part > 0) {
910                    return $s[ $part - 1 ];
911            } else {
912                    return @s;
913            }
914    }
915    
916    my $hash;
917    
918    =head2 set
919    
920      set( key => 'value' );
921    
922    =cut
923    
924    sub set {
925            my ($k,$v) = @_;
926            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
927            $hash->{$k} = $v;
928    };
929    
930    =head2 get
931    
932      get( 'key' );
933    
934    =cut
935    
936    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    =head2 count
944    
945      if ( count( @result ) == 1 ) {
946            # do something if only 1 result is there
947      }
948    
949    =cut
950    
951    sub count {
952            warn "## count ",dump(@_),$/ if ( $debug );
953            return @_ . '';
954  }  }
955    
956  # END  # END

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

  ViewVC Help
Powered by ViewVC 1.1.26