/[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 668 by dpavlin, Mon Sep 11 14:28:56 2006 UTC revision 1367 by dpavlin, Thu Dec 15 21:40:37 2011 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          _pack_subfields_hash
9    
10          tag search display          to
11          marc marc_indicators marc_repeatable_subfield          search_display search display sorted
         marc_compose marc_leader  
         marc_duplicate marc_remove  
         marc_original_order  
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          split_rec_on
20    
21            get set
22            count
23    
24            row
25            rec_array
26    
27  /;  /;
28    
29  use warnings;  use warnings;
# Line 24  use strict; Line 31  use strict;
31    
32  #use base qw/WebPAC::Common/;  #use base qw/WebPAC::Common/;
33  use Data::Dump qw/dump/;  use Data::Dump qw/dump/;
34  use Storable qw/dclone/;  use Carp qw/confess/;
35    
36  # debugging warn(s)  # debugging warn(s)
37  my $debug = 0;  my $debug = 0;
38    _debug( $debug );
39    
40    # FIXME
41    use WebPAC::Normalize::ISBN;
42    push @EXPORT, ( 'isbn_10', 'isbn_13' );
43    
44  =head1 NAME  use WebPAC::Normalize::MARC;
45    push @EXPORT, ( qw/
46            marc marc_indicators marc_repeatable_subfield
47            marc_compose marc_leader marc_fixed
48            marc_duplicate marc_remove marc_count
49            marc_original_order
50            marc_template
51    /);
52    
53  WebPAC::Normalize - describe normalisaton rules using sets  use Storable qw/dclone/;
54    
55  =head1 VERSION  =head1 NAME
56    
57  Version 0.19  WebPAC::Normalize - describe normalisaton rules using sets
58    
59  =cut  =cut
60    
61  our $VERSION = '0.19';  our $VERSION = '0.36';
62    
63  =head1 SYNOPSIS  =head1 SYNOPSIS
64    
# Line 53  means that you check it's validity befor Line 71  means that you check it's validity befor
71  C<perl -c normalize.pl>.  C<perl -c normalize.pl>.
72    
73  Normalisation can generate multiple output normalized data. For now, supported output  Normalisation can generate multiple output normalized data. For now, supported output
74  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
75  C<marc>.  C<marc>.
76    
77  =head1 FUNCTIONS  =head1 FUNCTIONS
# Line 66  All other functions are available for us Line 84  All other functions are available for us
84  Return data structure  Return data structure
85    
86    my $ds = WebPAC::Normalize::data_structure(    my $ds = WebPAC::Normalize::data_structure(
87          lookup => $lookup->lookup_hash,          lookup => $lookup_hash,
88          row => $row,          row => $row,
89          rules => $normalize_pl_config,          rules => $normalize_pl_config,
90          marc_encoding => 'utf-8',          marc_encoding => 'utf-8',
91          config => $config,          config => $config,
92            load_row_coderef => sub {
93                    my ($database,$input,$mfn) = @_;
94                    $store->load_row( database => $database, input => $input, id => $mfn );
95            },
96    );    );
97    
98  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
99  other are optional.  other are optional.
100    
101    C<load_row_coderef> is closure only used when executing lookups, so they will
102    die if it's not defined.
103    
104  This function will B<die> if normalizastion can't be evaled.  This function will B<die> if normalizastion can't be evaled.
105    
106  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 83  C<WebPAC::Normalize::data_structure>. Line 108  C<WebPAC::Normalize::data_structure>.
108    
109  =cut  =cut
110    
111    my $load_row_coderef;
112    
113  sub data_structure {  sub data_structure {
114          my $arg = {@_};          my $arg = {@_};
115    
116          die "need row argument" unless ($arg->{row});          die "need row argument" unless ($arg->{row});
117          die "need normalisation argument" unless ($arg->{rules});          die "need normalisation argument" unless ($arg->{rules});
118    
119          no strict 'subs';          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
120          _set_lookup( $arg->{lookup} );          _set_ds( $arg->{row} );
121          _set_rec( $arg->{row} );          _set_config( $arg->{config} ) if defined($arg->{config});
         _set_config( $arg->{config} );  
122          _clean_ds( %{ $arg } );          _clean_ds( %{ $arg } );
123          eval "$arg->{rules}";          $load_row_coderef = $arg->{load_row_coderef};
124    
125            no strict 'subs';
126            no warnings 'all';
127            eval "$arg->{rules};";
128          die "error evaling $arg->{rules}: $@\n" if ($@);          die "error evaling $arg->{rules}: $@\n" if ($@);
129    
130          return _get_ds();          return _get_ds();
131  }  }
132    
133  =head2 _set_rec  =head2 _set_ds
134    
135  Set current record hash  Set current record hash
136    
137    _set_rec( $rec );    _set_ds( $rec );
138    
139  =cut  =cut
140    
141  my $rec;  my $rec;
142    
143  sub _set_rec {  sub _set_ds {
144          $rec = shift or die "no record hash";          $rec = shift or die "no record hash";
145            $WebPAC::Normalize::MARC::rec = $rec;
146  }  }
147    
148    =head2 _get_rec
149    
150      my $rec = _get_rec();
151    
152    =cut
153    
154    sub _get_rec { $rec };
155    
156    =head2 _set_rec
157    
158      _set_rec( $rec );
159    
160    =cut
161    
162    sub _set_rec { $rec = $_[0] }
163    
164  =head2 _set_config  =head2 _set_config
165    
166  Set current config hash  Set current config hash
# Line 150  Return hash formatted as data structure Line 197  Return hash formatted as data structure
197    
198  =cut  =cut
199    
200  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);  my $out;
 my ($marc_record_offset, $marc_fetch_offset) = (0, 0);  
201    
202  sub _get_ds {  sub _get_ds {
203    #warn "## out = ",dump($out);
204          return $out;          return $out;
205  }  }
206    
# Line 167  Clean data structure hash for next recor Line 214  Clean data structure hash for next recor
214    
215  sub _clean_ds {  sub _clean_ds {
216          my $a = {@_};          my $a = {@_};
217          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();          $out = undef;
218          ($marc_record_offset, $marc_fetch_offset) = (0,0);          WebPAC::Normalize::MARC::_clean();
         $marc_encoding = $a->{marc_encoding};  
219  }  }
220    
221  =head2 _set_lookup  =head2 _set_lookup
# Line 186  sub _set_lookup { Line 232  sub _set_lookup {
232          $lookup = shift;          $lookup = shift;
233  }  }
234    
235  =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:  
236    
237    900a-1 900b-1 900c-1  Get current lookup hash
   900a-2 900b-2  
   900a-3  
238    
239  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).  
240    
241  =cut  =cut
242    
243  sub _get_marc_fields {  sub _get_lookup {
244            return $lookup;
245          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] );  
   
                 # field and subfield which is key for  
                 # 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);  
246    
247                  }  =head2 _set_load_row
248    
249                  # if field exists  Setup code reference which will return L<data_structure> from
250                  if ( $#$field >= 0 ) {  L<WebPAC::Store>
                         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;  
251    
252                          } else {    _set_load_row(sub {
253                                  # append new subfields to existing field                  my ($database,$input,$mfn) = @_;
254                                  push @$field, ( $row->[3], $row->[4] );                  $store->load_row( database => $database, input => $input, id => $mfn );
255                          }    });
                 } else {  
                         # insert first field  
                         $field = $row;  
                 }  
256    
257                  if (! $marc_repeatable_subfield->{ $fsf }) {  =cut
                         # make step to next subfield  
                         $i = ($i + $u->{ $fsf } ) % ($len + 1);  
                 }  
         }  
258    
259          if ($#$field >= 0) {  sub _set_load_row {
260                  push @m, $field;          my $coderef = shift;
261                  warn "## saved/3 ", dump( $field ),$/ if ($debug);          confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
         }  
262    
263          return \@m;          $load_row_coderef = $coderef;
264  }  }
265    
266  =head2 _debug  =head2 _debug
# Line 373  sub _debug { Line 276  sub _debug {
276          return $debug unless defined($l);          return $debug unless defined($l);
277          warn "debug level $l",$/ if ($l > 0);          warn "debug level $l",$/ if ($l > 0);
278          $debug = $l;          $debug = $l;
279            $WebPAC::Normalize::MARC::debug = $debug;
280  }  }
281    
282  =head1 Functions to create C<data_structure>  =head1 Functions to create C<data_structure>
283    
284  Those functions generally have to first in your normalization file.  Those functions generally have to first in your normalization file.
285    
286  =head2 tag  =head2 to
287    
288  Define new tag for I<search> and I<display>.  Generic way to set values for some name
289    
290    tag('Title', rec('200','a') );    to('field-name', 'name-value' => rec('200','a') );
291    
292    There are many helpers defined below which might be easier to use.
293    
294  =cut  =cut
295    
296  sub tag {  sub to {
297          my $name = shift or die "tag needs name as first argument";          my $type = shift or confess "need type -- BUG?";
298            my $name = shift or confess "needs name as first argument";
299          my @o = grep { defined($_) && $_ ne '' } @_;          my @o = grep { defined($_) && $_ ne '' } @_;
300          return unless (@o);          return unless (@o);
301          $out->{$name}->{tag} = $name;          $out->{$name}->{$type} = \@o;
         $out->{$name}->{search} = \@o;  
         $out->{$name}->{display} = \@o;  
302  }  }
303    
304  =head2 display  =head2 search_display
305    
306  Define tag just for I<display>  Define output for L<search> and L<display> at the same time
307    
308    @v = display('Title', rec('200','a') );    search_display('Title', rec('200','a') );
309    
310  =cut  =cut
311    
312  sub display {  sub search_display {
313          my $name = shift or die "display needs name as first argument";          my $name = shift or die "search_display needs name as first argument";
314          my @o = grep { defined($_) && $_ ne '' } @_;          my @o = grep { defined($_) && $_ ne '' } @_;
315          return unless (@o);          return unless (@o);
         $out->{$name}->{tag} = $name;  
         $out->{$name}->{display} = \@o;  
 }  
   
 =head2 search  
   
 Prepare values just for I<search>  
   
   @v = search('Title', rec('200','a') );  
   
 =cut  
   
 sub search {  
         my $name = shift or die "search needs name as first argument";  
         my @o = grep { defined($_) && $_ ne '' } @_;  
         return unless (@o);  
         $out->{$name}->{tag} = $name;  
316          $out->{$name}->{search} = \@o;          $out->{$name}->{search} = \@o;
317            $out->{$name}->{display} = \@o;
318  }  }
319    
320  =head2 marc_leader  =head2 tag
   
 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*$/);  
                 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 ];  
                 }  
         }  
 }  
   
 =head2 marc_repeatable_subfield  
   
 Save values for MARC repetable subfield  
   
   marc_repeatable_subfield('910', 'z', rec('909') );  
   
 =cut  
   
 sub marc_repeatable_subfield {  
         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  
   
   marc_indicators('900', ' ', 1);  
321    
322  Any indicator value other than C<0-9> will be treated as undefined.  Old name for L<search_display>, it will probably be removed at one point.
323    
324  =cut  =cut
325    
326  sub marc_indicators {  sub tag {
327          my $f = shift || die "marc_indicators need field!\n";          search_display( @_ );
         my ($i1,$i2) = @_;  
         die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));  
         die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));  
   
         $i1 = ' ' if ($i1 !~ /^\d$/);  
         $i2 = ' ' if ($i2 !~ /^\d$/);  
         @{ $marc_indicators->{$f} } = ($i1,$i2);  
328  }  }
329    
330  =head2 marc_compose  =head2 display
   
 Save values for each MARC subfield explicitly  
331    
332    marc_compose('900',  Define output just for I<display>
         'a', rec('200','a')  
         'b', rec('201','a')  
         'a', rec('200','b')  
         'c', rec('200','c')  
   );  
333    
334  If you specify C<+> for subfield, value will be appended    @v = display('Title', rec('200','a') );
 to previous defined subfield.  
335    
336  =cut  =cut
337    
338  sub marc_compose {  sub display { to( 'display', @_ ) }
         my $f = shift or die "marc_compose needs field";  
         die "marc_compose field must be numer" unless ($f =~ /^\d+$/);  
   
         my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');  
         my $m = [ $f, $i1, $i2 ];  
339    
340          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);  =head2 search
   
         if ($#_ % 2 != 1) {  
                 die "ERROR: marc_compose",dump($f,@_)," not valid (must be even).\nDo you need to add first() or join() around some argument?\n";  
         }  
   
         while (@_) {  
                 my $sf = shift;  
                 my $v = shift;  
   
                 next unless (defined($v) && $v !~ /^\s*$/);  
                 warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);  
                 if ($sf ne '+') {  
                         push @$m, ( $sf, $v );  
                 } else {  
                         $m->[ $#$m ] .= $v;  
                 }  
         }  
   
         warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);  
   
         push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);  
 }  
   
 =head2 marc_duplicate  
   
 Generate copy of current MARC record and continue working on copy  
341    
342    marc_duplicate();  Prepare values just for I<search>
343    
344  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or    @v = search('Title', rec('200','a') );
 C<< _get_marc_fields( offset => 42 ) >>.  
345    
346  =cut  =cut
347    
348  sub marc_duplicate {  sub search { to( 'search', @_ ) }
          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);  
 }  
   
 =head2 marc_remove  
   
 Remove some field or subfield from MARC record.  
349    
350    marc_remove('200');  =head2 sorted
   marc_remove('200','a');  
351    
352  This will erase field C<200> or C<200^a> from current MARC record.  Insert into lists which will be automatically sorted
353    
354  This is useful after calling C<marc_duplicate> or on it's own (but, you   sorted('Title', rec('200','a') );
 should probably just remove that subfield definition if you are not  
 using C<marc_duplicate>).  
   
 FIXME: support fields < 10.  
355    
356  =cut  =cut
357    
358  sub marc_remove {  sub sorted { to( 'sorted', @_ ) }
         my ($f, $sf) = @_;  
   
         die "marc_remove needs record number" unless defined($f);  
359    
360          my $marc = $marc_record->[ $marc_record_offset ];  =head2 row
361    
362          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);  Insert new row of data into output module
   
         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--;  
                         } else {  
                                 foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {  
                                         my $o = ($j * 2) + 3;  
                                         if ($marc->[$i]->[$o] eq $sf) {  
                                                 # remove subfield  
                                                 splice @{$marc->[$i]}, $o, 2;  
                                                 warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);  
                                                 # is record now empty?  
                                                 if ($#{ $marc->[$i] } == 2) {  
                                                         splice @$marc, $i, 1;  
                                                         warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);  
                                                         $i--;  
                                                 };  
                                         }  
                                 }  
                         }  
                 }  
                 $i++;  
         }  
   
         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);  
 }  
   
 =head2 marc_original_order  
   
 Copy all subfields preserving original order to marc field.  
   
   marc_original_order( marc_field_number, original_input_field_number );  
   
 Please note that field numbers are consistent with other commands (marc  
 field number first), but somewhat counter-intuitive (destination and then  
 source).  
   
 You might want to use this command if you are just renaming subfields or  
 using pre-processing modify_record in C<config.yml> and don't need any  
 post-processing or want to preserve order of original subfields.  
363    
364      row( column => 'foo', column2 => 'bar' );
365    
366  =cut  =cut
367    
368  sub marc_original_order {  use Data::Dump qw/dump/;
   
         my ($to, $from) = @_;  
         die "marc_original_order needs from and to fields\n" unless ($from && $to);  
   
         return unless defined($rec->{$from});  
   
         my $r = $rec->{$from};  
         die "record field $from isn't array\n" unless (ref($r) eq 'ARRAY');  
   
         my ($i1,$i2) = defined($marc_indicators->{$to}) ? @{ $marc_indicators->{$to} } : (' ',' ');  
         warn "## marc_original_order($to,$from) source = ", dump( $r ),$/ if ($debug > 1);  
   
         foreach my $d (@$r) {  
   
                 if (! defined($d->{subfields}) && ref($d->{subfields}) ne 'ARRAY') {  
                         warn "# marc_original_order($to,$from): field $from doesn't have subfields specification\n";  
                         next;  
                 }  
           
                 my @sfs = @{ $d->{subfields} };  
   
                 die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);  
   
                 warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);  
   
                 my $m = [ $to, $i1, $i2 ];  
   
                 while (my $sf = shift @sfs) {  
   
                         warn "#--> sf: ",dump($sf), $/ if ($debug > 2);  
                         my $offset = shift @sfs;  
                         die "corrupted sufields specification for field $from\n" unless defined($offset);  
   
                         my $v;  
                         if (ref($d->{$sf}) eq 'ARRAY') {  
                                 $v = $d->{$sf}->[$offset] if (defined($d->{$sf}->[$offset]));  
                         } elsif ($offset == 0) {  
                                 $v = $d->{$sf};  
                         } else {  
                                 die "field $from subfield '$sf' need occurence $offset which doesn't exist", dump($d->{$sf});  
                         }  
                         push @$m, ( $sf, $v ) if (defined($v));  
                 }  
   
                 if ($#{$m} > 2) {  
                         push @{ $marc_record->[ $marc_record_offset ] }, $m;  
                 }  
         }  
369    
370          warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1);  sub row {
371            die "array doesn't have odd number of elements but $#_: ",dump( @_ ) if $#_ % 2 == 1;
372            my $table = shift @_;
373            push @{ $out->{'_rows'}->{$table} }, {@_};
374  }  }
375    
376    
# Line 722  above. Line 381  above.
381    
382  =head2 _pack_subfields_hash  =head2 _pack_subfields_hash
383    
384   @values = _pack_subfields_hash( $h, $include_subfields )   @subfields = _pack_subfields_hash( $h );
385     $subfields = _pack_subfields_hash( $h, 1 );
386    
387    Return each subfield value in array or pack them all together and return scalar
388    with subfields (denoted by C<^>) and values.
389    
390  =cut  =cut
391    
# Line 730  sub _pack_subfields_hash { Line 393  sub _pack_subfields_hash {
393    
394          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
395    
396          my ($h,$include_subfields) = @_;          my ($hash,$include_subfields) = @_;
397    
398            # sanity and ease of use
399            return $hash if (ref($hash) ne 'HASH');
400    
401            my $h = dclone( $hash );
402    
403          if ( defined($h->{subfields}) ) {          if ( defined($h->{subfields}) ) {
404                  my $sfs = delete $h->{subfields} || die "no subfields?";                  my $sfs = delete $h->{subfields} || die "no subfields?";
# Line 741  sub _pack_subfields_hash { Line 409  sub _pack_subfields_hash {
409                          my $o = shift @$sfs;                          my $o = shift @$sfs;
410                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
411                                  # single element subfields are not arrays                                  # single element subfields are not arrays
412  warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
413    
414                                  push @out, $h->{$sf};                                  push @out, $h->{$sf};
415                          } else {                          } else {
416  warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
417                                  push @out, $h->{$sf}->[$o];                                  push @out, $h->{$sf}->[$o];
418                          }                          }
419                  }                  }
# Line 821  sub rec2 { Line 489  sub rec2 {
489                  } else {                  } else {
490                          $_->{$sf};                          $_->{$sf};
491                  }                  }
492          } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };          } grep { ref($_) eq 'HASH' && defined $_->{$sf} } @{ $rec->{$f} };
493  }  }
494    
495  =head2 rec  =head2 rec
# Line 831  syntaxtic sugar for Line 499  syntaxtic sugar for
499    @v = rec('200')    @v = rec('200')
500    @v = rec('200','a')    @v = rec('200','a')
501    
502    If rec() returns just single value, it will
503    return scalar, not array.
504    
505  =cut  =cut
506    
507  sub rec {  sub rec {
# Line 840  sub rec { Line 511  sub rec {
511          } elsif ($#_ == 1) {          } elsif ($#_ == 1) {
512                  @out = rec2(@_);                  @out = rec2(@_);
513          }          }
514          if (@out) {          if ($#out == 0 && ! wantarray) {
515                    return $out[0];
516            } elsif (@out) {
517                  return @out;                  return @out;
518          } else {          } else {
519                  return '';                  return '';
520          }          }
521  }  }
522    
523    =head2 frec
524    
525    Returns first value from field
526    
527      $v = frec('200');
528      $v = frec('200','a');
529    
530    =cut
531    
532    sub frec {
533            my @out = rec(@_);
534            warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0;
535            return shift @out;
536    }
537    
538    =head2 frec_eq
539    
540    =head2 frec_ne
541    
542    Check if first values from two fields are same or different
543    
544      if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
545            # values are same
546      } else {
547        # values are different
548      }
549    
550    Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
551    could write something like:
552    
553      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
554            # yada tada
555      }
556    
557    but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
558    in order to parse text and create invalid function C<eqfrec>.
559    
560    =cut
561    
562    sub frec_eq {
563            my ( $f1,$sf1, $f2, $sf2 ) = @_;
564            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
565    }
566    
567    sub frec_ne {
568            return ! frec_eq( @_ );
569    }
570    
571  =head2 regex  =head2 regex
572    
573  Apply regex to some or all values  Apply regex to some or all values
# Line 876  Prefix all values with a string Line 597  Prefix all values with a string
597  =cut  =cut
598    
599  sub prefix {  sub prefix {
600          my $p = shift or return;          my $p = shift;
601            return @_ unless defined( $p );
602          return map { $p . $_ } grep { defined($_) } @_;          return map { $p . $_ } grep { defined($_) } @_;
603  }  }
604    
# Line 889  suffix all values with a string Line 611  suffix all values with a string
611  =cut  =cut
612    
613  sub suffix {  sub suffix {
614          my $s = shift or die "suffix needs string as first argument";          my $s = shift;
615            return @_ unless defined( $s );
616          return map { $_ . $s } grep { defined($_) } @_;          return map { $_ . $s } grep { defined($_) } @_;
617  }  }
618    
# Line 902  surround all values with a two strings Line 625  surround all values with a two strings
625  =cut  =cut
626    
627  sub surround {  sub surround {
628          my $p = shift or die "surround need prefix as first argument";          my $p = shift;
629          my $s = shift or die "surround needs suffix as second argument";          my $s = shift;
630            $p = '' unless defined( $p );
631            $s = '' unless defined( $s );
632          return map { $p . $_ . $s } grep { defined($_) } @_;          return map { $p . $_ . $s } grep { defined($_) } @_;
633  }  }
634    
# Line 924  sub first { Line 649  sub first {
649    
650  Consult lookup hashes for some value  Consult lookup hashes for some value
651    
652    @v = lookup( $v );    @v = lookup(
653    @v = lookup( @v );          sub {
654                    'ffkk/peri/mfn'.rec('000')
655            },
656            'ffkk','peri','200-a-200-e',
657            sub {
658                    first(rec(200,'a')).' '.first(rec('200','e'))
659            }
660      );
661    
662    Code like above will be B<automatically generated> using L<WebPAC::Parse> from
663    normal lookup definition in C<conf/lookup/something.pl> which looks like:
664    
665      lookup(
666            # which results to return from record recorded in lookup
667            sub { 'ffkk/peri/mfn' . rec('000') },
668            # from which database and input
669            'ffkk','peri',
670            # such that following values match
671            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
672            # if this part is missing, we will try to match same fields
673            # from lookup record and current one, or you can override
674            # which records to use from current record using
675            sub { rec('900','x') . ' ' . rec('900','y') },
676      )
677    
678    You can think about this lookup as SQL (if that helps):
679    
680      select
681            sub { what }
682      from
683            database, input
684      where
685        sub { filter from lookuped record }
686      having
687        sub { optional filter on current record }
688    
689    Easy as pie, right?
690    
691  =cut  =cut
692    
693  sub lookup {  sub lookup {
694          my $k = shift or return;          my ($what, $database, $input, $key, $having) = @_;
695          return unless (defined($lookup->{$k}));  
696          if (ref($lookup->{$k}) eq 'ARRAY') {          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
697                  return @{ $lookup->{$k} };  
698            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
699            return unless (defined($lookup->{$database}->{$input}->{$key}));
700    
701            confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
702    
703            my $mfns;
704            my @having = $having->();
705    
706            warn "## having = ", dump( @having ) if ($debug > 2);
707    
708            foreach my $h ( @having ) {
709                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
710                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
711                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
712                    }
713            }
714    
715            return unless ($mfns);
716    
717            my @mfns = sort keys %$mfns;
718    
719            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
720    
721            my $old_rec = $rec;
722            my @out;
723    
724            foreach my $mfn (@mfns) {
725                    $rec = $load_row_coderef->( $database, $input, $mfn );
726    
727                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
728    
729                    my @vals = $what->();
730    
731                    push @out, ( @vals );
732    
733                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
734            }
735    
736    #       if (ref($lookup->{$k}) eq 'ARRAY') {
737    #               return @{ $lookup->{$k} };
738    #       } else {
739    #               return $lookup->{$k};
740    #       }
741    
742            $rec = $old_rec;
743    
744            warn "## lookup returns = ", dump(@out), $/ if ($debug);
745    
746            if ($#out == 0) {
747                    return $out[0];
748          } else {          } else {
749                  return $lookup->{$k};                  return @out;
750          }          }
751  }  }
752    
753    =head2 save_into_lookup
754    
755    Save value into lookup. It associates current database, input
756    and specific keys with one or more values which will be
757    associated over MFN.
758    
759    MFN will be extracted from first occurence current of field 000
760    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
761    
762      my $nr = save_into_lookup($database,$input,$key,sub {
763            # code which produce one or more values
764      });
765    
766    It returns number of items saved.
767    
768    This function shouldn't be called directly, it's called from code created by
769    L<WebPAC::Parser>.
770    
771    =cut
772    
773    sub save_into_lookup {
774            my ($database,$input,$key,$coderef) = @_;
775            die "save_into_lookup needs database" unless defined($database);
776            die "save_into_lookup needs input" unless defined($input);
777            die "save_into_lookup needs key" unless defined($key);
778            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
779    
780            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
781    
782            my $mfn =
783                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
784                    defined($config->{_mfn})        ?       $config->{_mfn}         :
785                                                                                    die "mfn not defined or zero";
786    
787            my $nr = 0;
788    
789            foreach my $v ( $coderef->() ) {
790                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
791                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
792                    $nr++;
793            }
794    
795            return $nr;
796    }
797    
798  =head2 config  =head2 config
799    
800  Consult config values stored in C<config.yml>  Consult config values stored in C<config.yml>
# Line 947  Consult config values stored in C<config Line 803  Consult config values stored in C<config
803    $database_code = config();    # use _ from hash    $database_code = config();    # use _ from hash
804    $database_name = config('name');    $database_name = config('name');
805    $database_input_name = config('input name');    $database_input_name = config('input name');
   $tag = config('input normalize tag');  
806    
807  Up to three levels are supported.  Up to three levels are supported.
808    
# Line 1008  Returns C<42/2> for 2nd occurence of MFN Line 863  Returns C<42/2> for 2nd occurence of MFN
863    
864  sub id {  sub id {
865          my $mfn = $config->{_mfn} || die "no _mfn in config data";          my $mfn = $config->{_mfn} || die "no _mfn in config data";
866          return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';          return $mfn . ( WebPAC::Normalize::MARC::_created_marc_records() || '' );
867  }  }
868    
869  =head2 join_with  =head2 join_with
# Line 1063  sub split_rec_on { Line 918  sub split_rec_on {
918          }          }
919  }  }
920    
921    my $hash;
922    
923    =head2 set
924    
925      set( key => 'value' );
926    
927    =cut
928    
929    sub set {
930            my ($k,$v) = @_;
931            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
932            $hash->{$k} = $v;
933    };
934    
935    =head2 get
936    
937      get( 'key' );
938    
939    =cut
940    
941    sub get {
942            my $k = shift || return;
943            my $v = $hash->{$k};
944            warn "## get $k = ", dump( $v ), $/ if ( $debug );
945            return $v;
946    }
947    
948    =head2 count
949    
950      if ( count( @result ) == 1 ) {
951            # do something if only 1 result is there
952      }
953    
954    =cut
955    
956    sub count {
957            warn "## count ",dump(@_),$/ if ( $debug );
958            return @_ . '';
959    }
960    
961    =head2 rec_array
962    
963    Always return field as array
964    
965      foreach my $d ( rec_array('field') ) {
966            warn $d;
967      }
968    
969    =cut
970    
971    sub rec_array {
972            my $d = $rec->{ $_[0] };
973            return @$d if ref($d) eq 'ARRAY';
974            return ($d);
975    }
976    
977  # END  # END
978  1;  1;

Legend:
Removed from v.668  
changed lines
  Added in v.1367

  ViewVC Help
Powered by ViewVC 1.1.26