/[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 586 by dpavlin, Thu Jul 6 10:31:13 2006 UTC revision 1037 by dpavlin, Mon Nov 12 11:17:19 2007 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          _debug
8            _pack_subfields_hash
9    
10          tag search display          search_display search display sorted
         marc marc_indicators marc_repeatable_subfield  
         marc_compose marc_leader  
         marc_duplicate marc_remove  
11    
12          rec1 rec2 rec          rec1 rec2 rec
13            frec frec_eq frec_ne
14          regex prefix suffix surround          regex prefix suffix surround
15          first lookup join_with          first lookup join_with
16            save_into_lookup
17    
18          split_rec_on          split_rec_on
19    
20            get set
21            count
22    
23  /;  /;
24    
25  use warnings;  use warnings;
# Line 22  use strict; Line 27  use strict;
27    
28  #use base qw/WebPAC::Common/;  #use base qw/WebPAC::Common/;
29  use Data::Dump qw/dump/;  use Data::Dump qw/dump/;
30  use Encode qw/from_to/;  use Carp qw/confess/;
 use Storable qw/dclone/;  
31    
32  # debugging warn(s)  # debugging warn(s)
33  my $debug = 0;  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 NAME  =head1 NAME
50    
51  WebPAC::Normalize - describe normalisaton rules using sets  WebPAC::Normalize - describe normalisaton rules using sets
52    
 =head1 VERSION  
   
 Version 0.11  
   
53  =cut  =cut
54    
55  our $VERSION = '0.11';  our $VERSION = '0.35';
56    
57  =head1 SYNOPSIS  =head1 SYNOPSIS
58    
# Line 52  means that you check it's validity befor Line 65  means that you check it's validity befor
65  C<perl -c normalize.pl>.  C<perl -c normalize.pl>.
66    
67  Normalisation can generate multiple output normalized data. For now, supported output  Normalisation can generate multiple output normalized data. For now, supported output
68  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
69  C<marc>.  C<marc>.
70    
71  =head1 FUNCTIONS  =head1 FUNCTIONS
# Line 65  All other functions are available for us Line 78  All other functions are available for us
78  Return data structure  Return data structure
79    
80    my $ds = WebPAC::Normalize::data_structure(    my $ds = WebPAC::Normalize::data_structure(
81          lookup => $lookup->lookup_hash,          lookup => $lookup_hash,
82          row => $row,          row => $row,
83          rules => $normalize_pl_config,          rules => $normalize_pl_config,
84          marc_encoding => 'utf-8',          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  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
93  other are optional.  other are optional.
94    
95    C<load_row_coderef> is closure only used when executing lookups, so they will
96    die if it's not defined.
97    
98  This function will B<die> if normalizastion can't be evaled.  This function will B<die> if normalizastion can't be evaled.
99    
100  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 81  C<WebPAC::Normalize::data_structure>. Line 102  C<WebPAC::Normalize::data_structure>.
102    
103  =cut  =cut
104    
105    my $load_row_coderef;
106    
107  sub data_structure {  sub data_structure {
108          my $arg = {@_};          my $arg = {@_};
109    
110          die "need row argument" unless ($arg->{row});          die "need row argument" unless ($arg->{row});
111          die "need normalisation argument" unless ($arg->{rules});          die "need normalisation argument" unless ($arg->{rules});
112    
113          no strict 'subs';          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
114          _set_lookup( $arg->{lookup} );          _set_ds( $arg->{row} );
115          _set_rec( $arg->{row} );          _set_config( $arg->{config} ) if defined($arg->{config});
116          _clean_ds( %{ $arg } );          _clean_ds( %{ $arg } );
117          eval "$arg->{rules}";          $load_row_coderef = $arg->{load_row_coderef};
118    
119            no strict 'subs';
120            no warnings 'redefine';
121            eval "$arg->{rules};";
122          die "error evaling $arg->{rules}: $@\n" if ($@);          die "error evaling $arg->{rules}: $@\n" if ($@);
123    
124          return _get_ds();          return _get_ds();
125  }  }
126    
127  =head2 _set_rec  =head2 _set_ds
128    
129  Set current record hash  Set current record hash
130    
131    _set_rec( $rec );    _set_ds( $rec );
132    
133  =cut  =cut
134    
135  my $rec;  my $rec;
136    
137  sub _set_rec {  sub _set_ds {
138          $rec = shift or die "no record hash";          $rec = shift or die "no record hash";
139            $WebPAC::Normalize::MARC::rec = $rec;
140    }
141    
142    =head2
143    
144      my $rec = _get_rec();
145    
146    =cut
147    
148    sub _get_rec { $rec };
149    
150    =head2 _set_config
151    
152    Set current config hash
153    
154      _set_config( $config );
155    
156    Magic keys are:
157    
158    =over 4
159    
160    =item _
161    
162    Code of current database
163    
164    =item _mfn
165    
166    Current MFN
167    
168    =back
169    
170    =cut
171    
172    my $config;
173    
174    sub _set_config {
175            $config = shift;
176  }  }
177    
178  =head2 _get_ds  =head2 _get_ds
# Line 119  Return hash formatted as data structure Line 183  Return hash formatted as data structure
183    
184  =cut  =cut
185    
186  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);  my $out;
 my ($marc_record_offset, $marc_fetch_offset) = (0, 0);  
187    
188  sub _get_ds {  sub _get_ds {
189    #warn "## out = ",dump($out);
190          return $out;          return $out;
191  }  }
192    
# Line 136  Clean data structure hash for next recor Line 200  Clean data structure hash for next recor
200    
201  sub _clean_ds {  sub _clean_ds {
202          my $a = {@_};          my $a = {@_};
203          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();          $out = undef;
204          ($marc_record_offset, $marc_fetch_offset) = (0,0);          WebPAC::Normalize::MARC::_clean();
         $marc_encoding = $a->{marc_encoding};  
205  }  }
206    
207  =head2 _set_lookup  =head2 _set_lookup
# Line 155  sub _set_lookup { Line 218  sub _set_lookup {
218          $lookup = shift;          $lookup = shift;
219  }  }
220    
221  =head2 _get_marc_fields  =head2 _get_lookup
   
 Get all fields defined by calls to C<marc>  
   
         $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );  
   
 We are using I<magic> which detect repeatable fields only from  
 sequence of field/subfield data generated by normalization.  
   
 Repeatable field is created when there is second occurence of same subfield or  
 if any of indicators are different.  
   
 This is sane for most cases. Something like:  
222    
223    900a-1 900b-1 900c-1  Get current lookup hash
   900a-2 900b-2  
   900a-3  
224    
225  will be created from any combination of:    my $lookup = _get_lookup();
   
   900a-1 900a-2 900a-3 900b-1 900b-2 900c-1  
   
 and following rules:  
   
   marc('900','a', rec('200','a') );  
   marc('900','b', rec('200','b') );  
   marc('900','c', rec('200','c') );  
   
 which might not be what you have in mind. If you need repeatable subfield,  
 define it using C<marc_repeatable_subfield> like this:  
   
   marc_repeatable_subfield('900','a');  
   marc('900','a', rec('200','a') );  
   marc('900','b', rec('200','b') );  
   marc('900','c', rec('200','c') );  
   
 will create:  
   
   900a-1 900a-2 900a-3 900b-1 900c-1  
   900b-2  
   
 There is also support for returning next or specific using:  
   
   while (my $mf = WebPAC::Normalize:_get_marc_fields( fetch_next => 1 ) ) {  
         # do something with $mf  
   }  
   
 will always return fields from next MARC record or  
   
   my $mf = WebPAC::Normalize::_get_marc_fields( offset => 42 );  
   
 will return 42th copy record (if it exists).  
226    
227  =cut  =cut
228    
229  sub _get_marc_fields {  sub _get_lookup {
230            return $lookup;
231          my $arg = {@_};  }
         warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2);  
         my $offset = $marc_fetch_offset;  
         if ($arg->{offset}) {  
                 $offset = $arg->{offset};  
         } elsif($arg->{fetch_next}) {  
                 $marc_fetch_offset++;  
         }  
   
         return if (! $marc_record || ref($marc_record) ne 'ARRAY');  
   
         warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);  
   
         my $marc_rec = $marc_record->[ $offset ];  
   
         warn "## _get_marc_fields (at offset: $offset) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);  
   
         return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);  
   
         # first, sort all existing fields  
         # 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_rec };  
   
         @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting  
           
         # output marc fields  
         my @m;  
   
         # count unique field-subfields (used for offset when walking to next subfield)  
         my $u;  
         map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;  
   
         if ($debug) {  
                 warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );  
                 warn "## marc_record[$offset] = ", dump( $marc_rec ), $/;  
                 warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;  
                 warn "## subfield count = ", dump( $u ), $/;  
         }  
   
         my $len = $#sorted_marc_record;  
         my $visited;  
         my $i = 0;  
         my $field;  
   
         foreach ( 0 .. $len ) {  
   
                 # find next element which isn't visited  
                 while ($visited->{$i}) {  
                         $i = ($i + 1) % ($len + 1);  
                 }  
   
                 # mark it visited  
                 $visited->{$i}++;  
   
                 my $row = dclone( $sorted_marc_record[$i] );  
232    
233                  # field and subfield which is key for  =head2 _set_load_row
                 # 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);  
234    
235                  }  Setup code reference which will return L<data_structure> from
236    L<WebPAC::Store>
237    
238                  # if field exists    _set_load_row(sub {
239                  if ( $#$field >= 0 ) {                  my ($database,$input,$mfn) = @_;
240                          if (                  $store->load_row( database => $database, input => $input, id => $mfn );
241                                  $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;  
242    
243                          } else {  =cut
                                 # append new subfields to existing field  
                                 push @$field, ( $row->[3], $row->[4] );  
                         }  
                 } else {  
                         # insert first field  
                         $field = $row;  
                 }  
   
                 if (! $marc_repeatable_subfield->{ $fsf }) {  
                         # make step to next subfield  
                         $i = ($i + $u->{ $fsf } ) % ($len + 1);  
                 }  
         }  
244    
245          if ($#$field >= 0) {  sub _set_load_row {
246                  push @m, $field;          my $coderef = shift;
247                  warn "## saved/3 ", dump( $field ),$/ if ($debug);          confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
         }  
248    
249          return \@m;          $load_row_coderef = $coderef;
250  }  }
251    
252  =head2 _debug  =head2 _debug
# Line 342  sub _debug { Line 262  sub _debug {
262          return $debug unless defined($l);          return $debug unless defined($l);
263          warn "debug level $l",$/ if ($l > 0);          warn "debug level $l",$/ if ($l > 0);
264          $debug = $l;          $debug = $l;
265            $WebPAC::Normalize::MARC::debug = $debug;
266    warn "#### MARC::debug = ",dump($WebPAC::Normalize::MARC::debug);
267  }  }
268    
269  =head1 Functions to create C<data_structure>  =head1 Functions to create C<data_structure>
270    
271  Those functions generally have to first in your normalization file.  Those functions generally have to first in your normalization file.
272    
273  =head2 tag  =head2 search_display
274    
275  Define new tag for I<search> and I<display>.  Define output for L<search> and L<display> at the same time
276    
277    tag('Title', rec('200','a') );    search_display('Title', rec('200','a') );
278    
279    
280  =cut  =cut
281    
282  sub tag {  sub search_display {
283          my $name = shift or die "tag needs name as first argument";          my $name = shift or die "search_display needs name as first argument";
284          my @o = grep { defined($_) && $_ ne '' } @_;          my @o = grep { defined($_) && $_ ne '' } @_;
285          return unless (@o);          return unless (@o);
         $out->{$name}->{tag} = $name;  
286          $out->{$name}->{search} = \@o;          $out->{$name}->{search} = \@o;
287          $out->{$name}->{display} = \@o;          $out->{$name}->{display} = \@o;
288  }  }
289    
290  =head2 display  =head2 tag
291    
292  Define tag just for I<display>  Old name for L<search_display>, but supported
   
   @v = display('Title', rec('200','a') );  
293    
294  =cut  =cut
295    
296  sub display {  sub tag {
297          my $name = shift or die "display needs name as first argument";          search_display( @_ );
         my @o = grep { defined($_) && $_ ne '' } @_;  
         return unless (@o);  
         $out->{$name}->{tag} = $name;  
         $out->{$name}->{display} = \@o;  
298  }  }
299    
300  =head2 search  =head2 display
301    
302  Prepare values just for I<search>  Define output just for I<display>
303    
304    @v = search('Title', rec('200','a') );    @v = display('Title', rec('200','a') );
305    
306  =cut  =cut
307    
308  sub search {  sub _field {
309          my $name = shift or die "search needs name as first argument";          my $type = shift or confess "need type -- BUG?";
310            my $name = shift or confess "needs name as first argument";
311          my @o = grep { defined($_) && $_ ne '' } @_;          my @o = grep { defined($_) && $_ ne '' } @_;
312          return unless (@o);          return unless (@o);
313          $out->{$name}->{tag} = $name;          $out->{$name}->{$type} = \@o;
         $out->{$name}->{search} = \@o;  
 }  
   
 =head2 marc_leader  
   
 Setup fields within MARC leader or get leader  
   
   marc_leader('05','c');  
   my $leader = marc_leader();  
   
 =cut  
   
 sub marc_leader {  
         my ($offset,$value) = @_;  
   
         if ($offset) {  
                 $out->{' leader'}->{ $offset } = $value;  
         } else {  
                 return $out->{' leader'};  
         }  
 }  
   
 =head2 marc  
   
 Save value for MARC field  
   
   marc('900','a', rec('200','a') );  
   marc('001', rec('000') );  
   
 =cut  
   
 sub marc {  
         my $f = shift or die "marc needs field";  
         die "marc field must be numer" unless ($f =~ /^\d+$/);  
   
         my $sf;  
         if ($f >= 10) {  
                 $sf = shift or die "marc needs subfield";  
         }  
   
         foreach (@_) {  
                 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} } : (' ',' ');  
                 if (defined $sf) {  
                         push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];  
                 } else {  
                         push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];  
                 }  
         }  
314  }  }
315    
316  =head2 marc_repeatable_subfield  sub display { _field( 'display', @_ ) }
   
 Save values for MARC repetable subfield  
   
   marc_repeatable_subfield('910', 'z', rec('909') );  
   
 =cut  
317    
318  sub marc_repeatable_subfield {  =head2 search
         my ($f,$sf) = @_;  
         die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);  
         $marc_repeatable_subfield->{ $f . $sf }++;  
         marc(@_);  
 }  
   
 =head2 marc_indicators  
   
 Set both indicators for MARC field  
319    
320    marc_indicators('900', ' ', 1);  Prepare values just for I<search>
321    
322  Any indicator value other than C<0-9> will be treated as undefined.    @v = search('Title', rec('200','a') );
323    
324  =cut  =cut
325    
326  sub marc_indicators {  sub search { _field( 'search', @_ ) }
         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));  
327    
328          $i1 = ' ' if ($i1 !~ /^\d$/);  =head2 sorted
         $i2 = ' ' if ($i2 !~ /^\d$/);  
         @{ $marc_indicators->{$f} } = ($i1,$i2);  
 }  
329    
330  =head2 marc_compose  Insert into lists which will be automatically sorted
331    
332  Save values for each MARC subfield explicitly   sorted('Title', rec('200','a') );
   
   marc_compose('900',  
         'a', rec('200','a')  
         'b', rec('201','a')  
         'a', rec('200','b')  
         'c', rec('200','c')  
   );  
333    
334  =cut  =cut
335    
336  sub marc_compose {  sub sorted { _field( 'sorted', @_ ) }
         my $f = shift or die "marc_compose needs field";  
         die "marc_compose field must be numer" unless ($f =~ /^\d+$/);  
337    
         my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');  
         my $m = [ $f, $i1, $i2 ];  
   
         warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);  
   
         while (@_) {  
                 my $sf = shift or die "marc_compose $f needs subfield";  
                 my $v = shift;  
   
                 next unless (defined($v) && $v !~ /^\s*$/);  
                 from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);  
                 push @$m, ( $sf, $v );  
                 warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);  
         }  
338    
         warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);  
339    
340          push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);  =head1 Functions to extract data from input
 }  
341    
342  =head2 marc_duplicate  This function should be used inside functions to create C<data_structure> described
343    above.
344    
345  Generate copy of current MARC record and continue working on copy  =head2 _pack_subfields_hash
346    
347    marc_duplicate();   @subfields = _pack_subfields_hash( $h );
348     $subfields = _pack_subfields_hash( $h, 1 );
349    
350  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or  Return each subfield value in array or pack them all together and return scalar
351  C<< _get_marc_fields( offset => 42 ) >>.  with subfields (denoted by C<^>) and values.
352    
353  =cut  =cut
354    
355  sub marc_duplicate {  sub _pack_subfields_hash {
          my $m = $marc_record->[ -1 ];  
          die "can't duplicate record which isn't defined" unless ($m);  
          push @{ $marc_record }, dclone( $m );  
          warn "## marc_duplicate = ", dump(@$marc_record), $/ if ($debug > 1);  
          $marc_record_offset = $#{ $marc_record };  
          warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1);  
 }  
356    
357  =head2 marc_remove          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
358    
359  Remove some field or subfield from MARC record.          my ($h,$include_subfields) = @_;
360    
361    marc_remove('200');          # sanity and ease of use
362    marc_remove('200','a');          return $h if (ref($h) ne 'HASH');
363    
364  This will erase field C<200> or C<200^a> from current MARC record.          if ( defined($h->{subfields}) ) {
365                    my $sfs = delete $h->{subfields} || die "no subfields?";
366  This is useful after calling C<marc_duplicate> or on it's own (but, you                  my @out;
367  should probably just remove that subfield definition if you are not                  while (@$sfs) {
368  using C<marc_duplicate>).                          my $sf = shift @$sfs;
369                            push @out, '^' . $sf if ($include_subfields);
370  FIXME: support fields < 10.                          my $o = shift @$sfs;
371                            if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
372  =cut                                  # single element subfields are not arrays
373    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
374    
375  sub marc_remove {                                  push @out, $h->{$sf};
         my ($f, $sf) = @_;  
   
         die "marc_remove needs record number" unless defined($f);  
   
         my $marc = $marc_record->[ $marc_record_offset ];  
   
         warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);  
   
         my $i = 0;  
         foreach ( 0 .. $#{ $marc } ) {  
                 last unless (defined $marc->[$i]);  
                 warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);  
                 if ($marc->[$i]->[0] eq $f) {  
                         if (! defined $sf) {  
                                 # remove whole field  
                                 splice @$marc, $i, 1;  
                                 warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);  
                                 $i--;  
376                          } else {                          } else {
377                                  foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
378                                          my $o = ($j * 2) + 3;                                  push @out, $h->{$sf}->[$o];
379                                          if ($marc->[$i]->[$o] eq $sf) {                          }
380                                                  # remove subfield                  }
381                                                  splice @{$marc->[$i]}, $o, 2;                  if ($include_subfields) {
382                                                  warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);                          return join('', @out);
383                                                  # is record now empty?                  } else {
384                                                  if ($#{ $marc->[$i] } == 2) {                          return @out;
385                                                          splice @$marc, $i, 1;                  }
386                                                          warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);          } else {
387                                                          $i--;                  if ($include_subfields) {
388                                                  };                          my $out = '';
389                                          }                          foreach my $sf (sort keys %$h) {
390                                    if (ref($h->{$sf}) eq 'ARRAY') {
391                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
392                                    } else {
393                                            $out .= '^' . $sf . $h->{$sf};
394                                  }                                  }
395                          }                          }
396                            return $out;
397                    } else {
398                            # FIXME this should probably be in alphabetical order instead of hash order
399                            values %{$h};
400                  }                  }
                 $i++;  
401          }          }
   
         warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);  
   
         $marc_record->[ $marc_record_offset ] = $marc;  
   
         warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);  
402  }  }
403    
 =head1 Functions to extract data from input  
   
 This function should be used inside functions to create C<data_structure> described  
 above.  
   
404  =head2 rec1  =head2 rec1
405    
406  Return all values in some field  Return all values in some field
# Line 625  sub rec1 { Line 417  sub rec1 {
417          return unless (defined($rec) && defined($rec->{$f}));          return unless (defined($rec) && defined($rec->{$f}));
418          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
419          if (ref($rec->{$f}) eq 'ARRAY') {          if (ref($rec->{$f}) eq 'ARRAY') {
420                  return map {                  my @out;
421                          if (ref($_) eq 'HASH') {                  foreach my $h ( @{ $rec->{$f} } ) {
422                                  values %{$_};                          if (ref($h) eq 'HASH') {
423                                    push @out, ( _pack_subfields_hash( $h ) );
424                          } else {                          } else {
425                                  $_;                                  push @out, $h;
426                          }                          }
427                  } @{ $rec->{$f} };                  }
428                    return @out;
429          } elsif( defined($rec->{$f}) ) {          } elsif( defined($rec->{$f}) ) {
430                  return $rec->{$f};                  return $rec->{$f};
431          }          }
# Line 649  sub rec2 { Line 443  sub rec2 {
443          my $f = shift;          my $f = shift;
444          return unless (defined($rec && $rec->{$f}));          return unless (defined($rec && $rec->{$f}));
445          my $sf = shift;          my $sf = shift;
446          return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };          warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
447            return map {
448                    if (ref($_->{$sf}) eq 'ARRAY') {
449                            @{ $_->{$sf} };
450                    } else {
451                            $_->{$sf};
452                    }
453            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
454  }  }
455    
456  =head2 rec  =head2 rec
# Line 659  syntaxtic sugar for Line 460  syntaxtic sugar for
460    @v = rec('200')    @v = rec('200')
461    @v = rec('200','a')    @v = rec('200','a')
462    
463    If rec() returns just single value, it will
464    return scalar, not array.
465    
466  =cut  =cut
467    
468  sub rec {  sub rec {
# Line 668  sub rec { Line 472  sub rec {
472          } elsif ($#_ == 1) {          } elsif ($#_ == 1) {
473                  @out = rec2(@_);                  @out = rec2(@_);
474          }          }
475          if (@out) {          if ($#out == 0 && ! wantarray) {
476                    return $out[0];
477            } elsif (@out) {
478                  return @out;                  return @out;
479          } else {          } else {
480                  return '';                  return '';
481          }          }
482  }  }
483    
484    =head2 frec
485    
486    Returns first value from field
487    
488      $v = frec('200');
489      $v = frec('200','a');
490    
491    =cut
492    
493    sub frec {
494            my @out = rec(@_);
495            warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0;
496            return shift @out;
497    }
498    
499    =head2 frec_eq
500    
501    =head2 frec_ne
502    
503    Check if first values from two fields are same or different
504    
505      if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
506            # values are same
507      } else {
508        # values are different
509      }
510    
511    Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
512    could write something like:
513    
514      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
515            # yada tada
516      }
517    
518    but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
519    in order to parse text and create invalid function C<eqfrec>.
520    
521    =cut
522    
523    sub frec_eq {
524            my ( $f1,$sf1, $f2, $sf2 ) = @_;
525            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
526    }
527    
528    sub frec_ne {
529            return ! frec_eq( @_ );
530    }
531    
532  =head2 regex  =head2 regex
533    
534  Apply regex to some or all values  Apply regex to some or all values
# Line 704  Prefix all values with a string Line 558  Prefix all values with a string
558  =cut  =cut
559    
560  sub prefix {  sub prefix {
561          my $p = shift or die "prefix needs string as first argument";          my $p = shift;
562            return @_ unless defined( $p );
563          return map { $p . $_ } grep { defined($_) } @_;          return map { $p . $_ } grep { defined($_) } @_;
564  }  }
565    
# Line 717  suffix all values with a string Line 572  suffix all values with a string
572  =cut  =cut
573    
574  sub suffix {  sub suffix {
575          my $s = shift or die "suffix needs string as first argument";          my $s = shift;
576            return @_ unless defined( $s );
577          return map { $_ . $s } grep { defined($_) } @_;          return map { $_ . $s } grep { defined($_) } @_;
578  }  }
579    
# Line 730  surround all values with a two strings Line 586  surround all values with a two strings
586  =cut  =cut
587    
588  sub surround {  sub surround {
589          my $p = shift or die "surround need prefix as first argument";          my $p = shift;
590          my $s = shift or die "surround needs suffix as second argument";          my $s = shift;
591            $p = '' unless defined( $p );
592            $s = '' unless defined( $s );
593          return map { $p . $_ . $s } grep { defined($_) } @_;          return map { $p . $_ . $s } grep { defined($_) } @_;
594  }  }
595    
# Line 752  sub first { Line 610  sub first {
610    
611  Consult lookup hashes for some value  Consult lookup hashes for some value
612    
613    @v = lookup( $v );    @v = lookup(
614    @v = lookup( @v );          sub {
615                    'ffkk/peri/mfn'.rec('000')
616            },
617            'ffkk','peri','200-a-200-e',
618            sub {
619                    first(rec(200,'a')).' '.first(rec('200','e'))
620            }
621      );
622    
623    Code like above will be B<automatically generated> using L<WebPAC::Parse> from
624    normal lookup definition in C<conf/lookup/something.pl> which looks like:
625    
626      lookup(
627            # which results to return from record recorded in lookup
628            sub { 'ffkk/peri/mfn' . rec('000') },
629            # from which database and input
630            'ffkk','peri',
631            # such that following values match
632            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
633            # if this part is missing, we will try to match same fields
634            # from lookup record and current one, or you can override
635            # which records to use from current record using
636            sub { rec('900','x') . ' ' . rec('900','y') },
637      )
638    
639    You can think about this lookup as SQL (if that helps):
640    
641      select
642            sub { what }
643      from
644            database, input
645      where
646        sub { filter from lookuped record }
647      having
648        sub { optional filter on current record }
649    
650    Easy as pie, right?
651    
652  =cut  =cut
653    
654  sub lookup {  sub lookup {
655          my $k = shift or return;          my ($what, $database, $input, $key, $having) = @_;
656          return unless (defined($lookup->{$k}));  
657          if (ref($lookup->{$k}) eq 'ARRAY') {          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
658                  return @{ $lookup->{$k} };  
659            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
660            return unless (defined($lookup->{$database}->{$input}->{$key}));
661    
662            confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
663    
664            my $mfns;
665            my @having = $having->();
666    
667            warn "## having = ", dump( @having ) if ($debug > 2);
668    
669            foreach my $h ( @having ) {
670                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
671                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
672                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
673                    }
674            }
675    
676            return unless ($mfns);
677    
678            my @mfns = sort keys %$mfns;
679    
680            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
681    
682            my $old_rec = $rec;
683            my @out;
684    
685            foreach my $mfn (@mfns) {
686                    $rec = $load_row_coderef->( $database, $input, $mfn );
687    
688                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
689    
690                    my @vals = $what->();
691    
692                    push @out, ( @vals );
693    
694                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
695            }
696    
697    #       if (ref($lookup->{$k}) eq 'ARRAY') {
698    #               return @{ $lookup->{$k} };
699    #       } else {
700    #               return $lookup->{$k};
701    #       }
702    
703            $rec = $old_rec;
704    
705            warn "## lookup returns = ", dump(@out), $/ if ($debug);
706    
707            if ($#out == 0) {
708                    return $out[0];
709            } else {
710                    return @out;
711            }
712    }
713    
714    =head2 save_into_lookup
715    
716    Save value into lookup. It associates current database, input
717    and specific keys with one or more values which will be
718    associated over MFN.
719    
720    MFN will be extracted from first occurence current of field 000
721    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
722    
723      my $nr = save_into_lookup($database,$input,$key,sub {
724            # code which produce one or more values
725      });
726    
727    It returns number of items saved.
728    
729    This function shouldn't be called directly, it's called from code created by
730    L<WebPAC::Parser>.
731    
732    =cut
733    
734    sub save_into_lookup {
735            my ($database,$input,$key,$coderef) = @_;
736            die "save_into_lookup needs database" unless defined($database);
737            die "save_into_lookup needs input" unless defined($input);
738            die "save_into_lookup needs key" unless defined($key);
739            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
740    
741            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
742    
743            my $mfn =
744                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
745                    defined($config->{_mfn})        ?       $config->{_mfn}         :
746                                                                                    die "mfn not defined or zero";
747    
748            my $nr = 0;
749    
750            foreach my $v ( $coderef->() ) {
751                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
752                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
753                    $nr++;
754            }
755    
756            return $nr;
757    }
758    
759    =head2 config
760    
761    Consult config values stored in C<config.yml>
762    
763      # return database code (key under databases in yaml)
764      $database_code = config();    # use _ from hash
765      $database_name = config('name');
766      $database_input_name = config('input name');
767    
768    Up to three levels are supported.
769    
770    =cut
771    
772    sub config {
773            return unless ($config);
774    
775            my $p = shift;
776    
777            $p ||= '';
778    
779            my $v;
780    
781            warn "### getting config($p)\n" if ($debug > 1);
782    
783            my @p = split(/\s+/,$p);
784            if ($#p < 0) {
785                    $v = $config->{ '_' };  # special, database code
786          } else {          } else {
787                  return $lookup->{$k};  
788                    my $c = dclone( $config );
789    
790                    foreach my $k (@p) {
791                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
792                            if (ref($c) eq 'ARRAY') {
793                                    $c = shift @$c;
794                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
795                                    last;
796                            }
797    
798                            if (! defined($c->{$k}) ) {
799                                    $c = undef;
800                                    last;
801                            } else {
802                                    $c = $c->{$k};
803                            }
804                    }
805                    $v = $c if ($c);
806    
807          }          }
808    
809            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
810            warn "config( '$p' ) is empty\n" if (! $v);
811    
812            return $v;
813    }
814    
815    =head2 id
816    
817    Returns unique id of this record
818    
819      $id = id();
820    
821    Returns C<42/2> for 2nd occurence of MFN 42.
822    
823    =cut
824    
825    sub id {
826            my $mfn = $config->{_mfn} || die "no _mfn in config data";
827            return $mfn . ( WebPAC::Normalize::MARC::_created_marc_records() || '' );
828  }  }
829    
830  =head2 join_with  =head2 join_with
# Line 808  sub split_rec_on { Line 868  sub split_rec_on {
868          my $v = shift @r;          my $v = shift @r;
869          warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);          warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
870    
871          return '' if( ! defined($v) || $v =~ /^\s*$/);          return '' if ( ! defined($v) || $v =~ /^\s*$/);
872    
873          my @s = split( $regex, $v );          my @s = split( $regex, $v );
874          warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);          warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
# Line 819  sub split_rec_on { Line 879  sub split_rec_on {
879          }          }
880  }  }
881    
882    my $hash;
883    
884    =head2 set
885    
886      set( key => 'value' );
887    
888    =cut
889    
890    sub set {
891            my ($k,$v) = @_;
892            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
893            $hash->{$k} = $v;
894    };
895    
896    =head2 get
897    
898      get( 'key' );
899    
900    =cut
901    
902    sub get {
903            my $k = shift || return;
904            my $v = $hash->{$k};
905            warn "## get $k = ", dump( $v ), $/ if ( $debug );
906            return $v;
907    }
908    
909    =head2 count
910    
911      if ( count( @result ) == 1 ) {
912            # do something if only 1 result is there
913      }
914    
915    =cut
916    
917    sub count {
918            warn "## count ",dump(@_),$/ if ( $debug );
919            return @_ . '';
920    }
921    
922  # END  # END
923  1;  1;

Legend:
Removed from v.586  
changed lines
  Added in v.1037

  ViewVC Help
Powered by ViewVC 1.1.26