/[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 661 by dpavlin, Fri Sep 8 17:47:58 2006 UTC revision 788 by dpavlin, Sun Dec 10 12:56:59 2006 UTC
# Line 2  package WebPAC::Normalize; Line 2  package WebPAC::Normalize;
2  use Exporter 'import';  use Exporter 'import';
3  @EXPORT = qw/  @EXPORT = qw/
4          _set_rec _set_lookup          _set_rec _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
# Line 15  use Exporter 'import'; Line 16  use Exporter 'import';
16          rec1 rec2 rec          rec1 rec2 rec
17          regex prefix suffix surround          regex prefix suffix surround
18          first lookup join_with          first lookup join_with
19            save_into_lookup
20    
21          split_rec_on          split_rec_on
22    
23            get set
24  /;  /;
25    
26  use warnings;  use warnings;
# Line 25  use strict; Line 29  use strict;
29  #use base qw/WebPAC::Common/;  #use base qw/WebPAC::Common/;
30  use Data::Dump qw/dump/;  use Data::Dump qw/dump/;
31  use Storable qw/dclone/;  use Storable qw/dclone/;
32    use Carp qw/confess/;
33    
34  # debugging warn(s)  # debugging warn(s)
35  my $debug = 0;  my $debug = 0;
# Line 36  WebPAC::Normalize - describe normalisato Line 41  WebPAC::Normalize - describe normalisato
41    
42  =head1 VERSION  =head1 VERSION
43    
44  Version 0.18  Version 0.25
45    
46  =cut  =cut
47    
48  our $VERSION = '0.18';  our $VERSION = '0.25';
49    
50  =head1 SYNOPSIS  =head1 SYNOPSIS
51    
# Line 66  All other functions are available for us Line 71  All other functions are available for us
71  Return data structure  Return data structure
72    
73    my $ds = WebPAC::Normalize::data_structure(    my $ds = WebPAC::Normalize::data_structure(
74          lookup => $lookup->lookup_hash,          lookup => $lookup_hash,
75          row => $row,          row => $row,
76          rules => $normalize_pl_config,          rules => $normalize_pl_config,
77          marc_encoding => 'utf-8',          marc_encoding => 'utf-8',
78          config => $config,          config => $config,
79            load_row_coderef => sub {
80                    my ($database,$input,$mfn) = shift;
81                    $store->load_row( database => $database, input => $input, id => $mfn );
82            },
83    );    );
84    
85  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
86  other are optional.  other are optional.
87    
88    C<load_row_coderef> is closure only used when executing lookups, so they will
89    die if it's not defined.
90    
91  This function will B<die> if normalizastion can't be evaled.  This function will B<die> if normalizastion can't be evaled.
92    
93  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 95  C<WebPAC::Normalize::data_structure>.
95    
96  =cut  =cut
97    
98    my $load_row_coderef;
99    
100  sub data_structure {  sub data_structure {
101          my $arg = {@_};          my $arg = {@_};
102    
# Line 90  sub data_structure { Line 104  sub data_structure {
104          die "need normalisation argument" unless ($arg->{rules});          die "need normalisation argument" unless ($arg->{rules});
105    
106          no strict 'subs';          no strict 'subs';
107          _set_lookup( $arg->{lookup} );          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
108          _set_rec( $arg->{row} );          _set_rec( $arg->{row} );
109          _set_config( $arg->{config} );          _set_config( $arg->{config} ) if defined($arg->{config});
110          _clean_ds( %{ $arg } );          _clean_ds( %{ $arg } );
111            $load_row_coderef = $arg->{load_row_coderef};
112    
113          eval "$arg->{rules}";          eval "$arg->{rules}";
114          die "error evaling $arg->{rules}: $@\n" if ($@);          die "error evaling $arg->{rules}: $@\n" if ($@);
115    
# Line 150  Return hash formatted as data structure Line 166  Return hash formatted as data structure
166    
167  =cut  =cut
168    
169  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $leader);
170  my ($marc_record_offset, $marc_fetch_offset) = (0, 0);  my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
171    
172  sub _get_ds {  sub _get_ds {
# Line 167  Clean data structure hash for next recor Line 183  Clean data structure hash for next recor
183    
184  sub _clean_ds {  sub _clean_ds {
185          my $a = {@_};          my $a = {@_};
186          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $leader) = ();
187          ($marc_record_offset, $marc_fetch_offset) = (0,0);          ($marc_record_offset, $marc_fetch_offset) = (0,0);
188          $marc_encoding = $a->{marc_encoding};          $marc_encoding = $a->{marc_encoding};
189  }  }
# Line 186  sub _set_lookup { Line 202  sub _set_lookup {
202          $lookup = shift;          $lookup = shift;
203  }  }
204    
205    =head2 _get_lookup
206    
207    Get current lookup hash
208    
209      my $lookup = _get_lookup();
210    
211    =cut
212    
213    sub _get_lookup {
214            return $lookup;
215    }
216    
217    =head2 _set_load_row
218    
219    Setup code reference which will return L<data_structure> from
220    L<WebPAC::Store>
221    
222      _set_load_row(sub {
223                    my ($database,$input,$mfn) = @_;
224                    $store->load_row( database => $database, input => $input, id => $mfn );
225      });
226    
227    =cut
228    
229    sub _set_load_row {
230            my $coderef = shift;
231            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
232    
233            $load_row_coderef = $coderef;
234    }
235    
236  =head2 _get_marc_fields  =head2 _get_marc_fields
237    
238  Get all fields defined by calls to C<marc>  Get all fields defined by calls to C<marc>
# Line 442  sub marc_leader { Line 489  sub marc_leader {
489          my ($offset,$value) = @_;          my ($offset,$value) = @_;
490    
491          if ($offset) {          if ($offset) {
492                  $out->{' leader'}->{ $offset } = $value;                  $leader->{ $offset } = $value;
493          } else {          } else {
494                  return $out->{' leader'};                  return $leader;
495          }          }
496  }  }
497    
# Line 590  Remove some field or subfield from MARC Line 637  Remove some field or subfield from MARC
637    
638  This will erase field C<200> or C<200^a> from current MARC record.  This will erase field C<200> or C<200^a> from current MARC record.
639    
640      marc_remove('*');
641    
642    Will remove all fields in current MARC record.
643    
644  This is useful after calling C<marc_duplicate> or on it's own (but, you  This is useful after calling C<marc_duplicate> or on it's own (but, you
645  should probably just remove that subfield definition if you are not  should probably just remove that subfield definition if you are not
646  using C<marc_duplicate>).  using C<marc_duplicate>).
# Line 607  sub marc_remove { Line 658  sub marc_remove {
658    
659          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
660    
661          my $i = 0;          if ($f eq '*') {
662          foreach ( 0 .. $#{ $marc } ) {  
663                  last unless (defined $marc->[$i]);                  delete( $marc_record->[ $marc_record_offset ] );
664                  warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);                  warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
665                  if ($marc->[$i]->[0] eq $f) {  
666                          if (! defined $sf) {          } else {
667                                  # remove whole field  
668                                  splice @$marc, $i, 1;                  my $i = 0;
669                                  warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);                  foreach ( 0 .. $#{ $marc } ) {
670                                  $i--;                          last unless (defined $marc->[$i]);
671                          } else {                          warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
672                                  foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {                          if ($marc->[$i]->[0] eq $f) {
673                                          my $o = ($j * 2) + 3;                                  if (! defined $sf) {
674                                          if ($marc->[$i]->[$o] eq $sf) {                                          # remove whole field
675                                                  # remove subfield                                          splice @$marc, $i, 1;
676                                                  splice @{$marc->[$i]}, $o, 2;                                          warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
677                                                  warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);                                          $i--;
678                                                  # is record now empty?                                  } else {
679                                                  if ($#{ $marc->[$i] } == 2) {                                          foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
680                                                          splice @$marc, $i, 1;                                                  my $o = ($j * 2) + 3;
681                                                          warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);                                                  if ($marc->[$i]->[$o] eq $sf) {
682                                                          $i--;                                                          # remove subfield
683                                                  };                                                          splice @{$marc->[$i]}, $o, 2;
684                                                            warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
685                                                            # is record now empty?
686                                                            if ($#{ $marc->[$i] } == 2) {
687                                                                    splice @$marc, $i, 1;
688                                                                    warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
689                                                                    $i--;
690                                                            };
691                                                    }
692                                          }                                          }
693                                  }                                  }
694                          }                          }
695                            $i++;
696                  }                  }
                 $i++;  
         }  
697    
698          warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);                  warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
699    
700          $marc_record->[ $marc_record_offset ] = $marc;                  $marc_record->[ $marc_record_offset ] = $marc;
701            }
702    
703          warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);          warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
704  }  }
# Line 722  above. Line 781  above.
781    
782  =head2 _pack_subfields_hash  =head2 _pack_subfields_hash
783    
784   @values = _pack_subfields_hash( $h, $include_subfields )   @subfields = _pack_subfields_hash( $h );
785     $subfields = _pack_subfields_hash( $h, 1 );
786    
787    Return each subfield value in array or pack them all together and return scalar
788    with subfields (denoted by C<^>) and values.
789    
790  =cut  =cut
791    
# Line 732  sub _pack_subfields_hash { Line 795  sub _pack_subfields_hash {
795    
796          my ($h,$include_subfields) = @_;          my ($h,$include_subfields) = @_;
797    
   
798          if ( defined($h->{subfields}) ) {          if ( defined($h->{subfields}) ) {
799                  my $sfs = delete $h->{subfields} || die "no subfields?";                  my $sfs = delete $h->{subfields} || die "no subfields?";
800                  my @out;                  my @out;
# Line 742  sub _pack_subfields_hash { Line 804  sub _pack_subfields_hash {
804                          my $o = shift @$sfs;                          my $o = shift @$sfs;
805                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
806                                  # single element subfields are not arrays                                  # single element subfields are not arrays
807    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
808    
809                                  push @out, $h->{$sf};                                  push @out, $h->{$sf};
810                          } else {                          } else {
811  #warn "====> $f $sf $o $#$sfs ", dump( $sfs ), "\n";  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
812                                  push @out, $h->{$sf}->[$o];                                  push @out, $h->{$sf}->[$o];
813                          }                          }
814                  }                  }
815                  return @out;                  if ($include_subfields) {
816                            return join('', @out);
817                    } else {
818                            return @out;
819                    }
820          } else {          } else {
821                  # FIXME this should probably be in alphabetical order instead of hash order                  if ($include_subfields) {
822                  values %{$h};                          my $out = '';
823                            foreach my $sf (sort keys %$h) {
824                                    if (ref($h->{$sf}) eq 'ARRAY') {
825                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
826                                    } else {
827                                            $out .= '^' . $sf . $h->{$sf};
828                                    }
829                            }
830                            return $out;
831                    } else {
832                            # FIXME this should probably be in alphabetical order instead of hash order
833                            values %{$h};
834                    }
835          }          }
836  }  }
837    
# Line 814  syntaxtic sugar for Line 894  syntaxtic sugar for
894    @v = rec('200')    @v = rec('200')
895    @v = rec('200','a')    @v = rec('200','a')
896    
897    If rec() returns just single value, it will
898    return scalar, not array.
899    
900  =cut  =cut
901    
902  sub rec {  sub rec {
# Line 823  sub rec { Line 906  sub rec {
906          } elsif ($#_ == 1) {          } elsif ($#_ == 1) {
907                  @out = rec2(@_);                  @out = rec2(@_);
908          }          }
909          if (@out) {          if ($#out == 0 && ! wantarray) {
910                    return $out[0];
911            } elsif (@out) {
912                  return @out;                  return @out;
913          } else {          } else {
914                  return '';                  return '';
# Line 907  sub first { Line 992  sub first {
992    
993  Consult lookup hashes for some value  Consult lookup hashes for some value
994    
995    @v = lookup( $v );    @v = lookup(
996    @v = lookup( @v );          sub {
997                    'ffkk/peri/mfn'.rec('000')
998            },
999            'ffkk','peri','200-a-200-e',
1000            sub {
1001                    first(rec(200,'a')).' '.first(rec('200','e'))
1002            }
1003      );
1004    
1005    Code like above will be B<automatically generated> using L<WebPAC::Parse> from
1006    normal lookup definition in C<conf/lookup/something.pl> which looks like:
1007    
1008      lookup(
1009            # which results to return from record recorded in lookup
1010            sub { 'ffkk/peri/mfn' . rec('000') },
1011            # from which database and input
1012            'ffkk','peri',
1013            # such that following values match
1014            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
1015            # if this part is missing, we will try to match same fields
1016            # from lookup record and current one, or you can override
1017            # which records to use from current record using
1018            sub { rec('900','x') . ' ' . rec('900','y') },
1019      )
1020    
1021    You can think about this lookup as SQL (if that helps):
1022    
1023      select
1024            sub { what }
1025      from
1026            database, input
1027      where
1028        sub { filter from lookuped record }
1029      having
1030        sub { optional filter on current record }
1031    
1032    Easy as pie, right?
1033    
1034  =cut  =cut
1035    
1036  sub lookup {  sub lookup {
1037          my $k = shift or return;          my ($what, $database, $input, $key, $having) = @_;
1038          return unless (defined($lookup->{$k}));  
1039          if (ref($lookup->{$k}) eq 'ARRAY') {          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
1040                  return @{ $lookup->{$k} };  
1041            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
1042            return unless (defined($lookup->{$database}->{$input}->{$key}));
1043    
1044            confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
1045    
1046            my $mfns;
1047            my @having = $having->();
1048    
1049            warn "## having = ", dump( @having ) if ($debug > 2);
1050    
1051            foreach my $h ( @having ) {
1052                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
1053                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
1054                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
1055                    }
1056            }
1057    
1058            return unless ($mfns);
1059    
1060            my @mfns = sort keys %$mfns;
1061    
1062            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
1063    
1064            my $old_rec = $rec;
1065            my @out;
1066    
1067            foreach my $mfn (@mfns) {
1068                    $rec = $load_row_coderef->( $database, $input, $mfn );
1069    
1070                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
1071    
1072                    my @vals = $what->();
1073    
1074                    push @out, ( @vals );
1075    
1076                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1077            }
1078    
1079    #       if (ref($lookup->{$k}) eq 'ARRAY') {
1080    #               return @{ $lookup->{$k} };
1081    #       } else {
1082    #               return $lookup->{$k};
1083    #       }
1084    
1085            $rec = $old_rec;
1086    
1087            warn "## lookup returns = ", dump(@out), $/ if ($debug);
1088    
1089            if ($#out == 0) {
1090                    return $out[0];
1091          } else {          } else {
1092                  return $lookup->{$k};                  return @out;
1093          }          }
1094  }  }
1095    
1096    =head2 save_into_lookup
1097    
1098    Save value into lookup. It associates current database, input
1099    and specific keys with one or more values which will be
1100    associated over MFN.
1101    
1102    MFN will be extracted from first occurence current of field 000
1103    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
1104    
1105      my $nr = save_into_lookup($database,$input,$key,sub {
1106            # code which produce one or more values
1107      });
1108    
1109    It returns number of items saved.
1110    
1111    This function shouldn't be called directly, it's called from code created by
1112    L<WebPAC::Parser>.
1113    
1114    =cut
1115    
1116    sub save_into_lookup {
1117            my ($database,$input,$key,$coderef) = @_;
1118            die "save_into_lookup needs database" unless defined($database);
1119            die "save_into_lookup needs input" unless defined($input);
1120            die "save_into_lookup needs key" unless defined($key);
1121            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
1122    
1123            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
1124    
1125            my $mfn =
1126                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
1127                    defined($config->{_mfn})        ?       $config->{_mfn}         :
1128                                                                                    die "mfn not defined or zero";
1129    
1130            my $nr = 0;
1131    
1132            foreach my $v ( $coderef->() ) {
1133                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
1134                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
1135                    $nr++;
1136            }
1137    
1138            return $nr;
1139    }
1140    
1141  =head2 config  =head2 config
1142    
1143  Consult config values stored in C<config.yml>  Consult config values stored in C<config.yml>
# Line 1046  sub split_rec_on { Line 1262  sub split_rec_on {
1262          }          }
1263  }  }
1264    
1265    my $hash;
1266    
1267    =head2 set
1268    
1269      set( key => 'value' );
1270    
1271    =cut
1272    
1273    sub set {
1274            my ($k,$v) = @_;
1275            warn "## set ( $k => ", dump($v), " )", $/;
1276            $hash->{$k} = $v;
1277    };
1278    
1279    =head2 get
1280    
1281      get( 'key' );
1282    
1283    =cut
1284    
1285    sub get {
1286            my $k = shift || return;
1287            my $v = $hash->{$k};
1288            warn "## get $k = ", dump( $v ), $/;
1289            return $v;
1290    }
1291    
1292    
1293  # END  # END
1294  1;  1;

Legend:
Removed from v.661  
changed lines
  Added in v.788

  ViewVC Help
Powered by ViewVC 1.1.26