--- trunk/lib/WebPAC/Normalize.pm 2006/09/06 21:09:30 642 +++ trunk/lib/WebPAC/Normalize.pm 2007/11/03 12:37:43 979 @@ -2,21 +2,28 @@ use Exporter 'import'; @EXPORT = qw/ _set_rec _set_lookup + _set_load_row _get_ds _clean_ds _debug _pack_subfields_hash - tag search display + search_display search display sorted + marc marc_indicators marc_repeatable_subfield - marc_compose marc_leader - marc_duplicate marc_remove + marc_compose marc_leader marc_fixed + marc_duplicate marc_remove marc_count marc_original_order rec1 rec2 rec + frec regex prefix suffix surround first lookup join_with + save_into_lookup split_rec_on + + get set + count /; use warnings; @@ -24,8 +31,8 @@ #use base qw/WebPAC::Common/; use Data::Dump qw/dump/; -use Encode qw/from_to/; use Storable qw/dclone/; +use Carp qw/confess/; # debugging warn(s) my $debug = 0; @@ -35,13 +42,9 @@ WebPAC::Normalize - describe normalisaton rules using sets -=head1 VERSION - -Version 0.17 - =cut -our $VERSION = '0.17'; +our $VERSION = '0.31'; =head1 SYNOPSIS @@ -54,7 +57,7 @@ C. Normalisation can generate multiple output normalized data. For now, supported output -types (on the left side of definition) are: C, C, C and +types (on the left side of definition) are: C, C, C and C. =head1 FUNCTIONS @@ -67,16 +70,23 @@ Return data structure my $ds = WebPAC::Normalize::data_structure( - lookup => $lookup->lookup_hash, + lookup => $lookup_hash, row => $row, rules => $normalize_pl_config, marc_encoding => 'utf-8', config => $config, + load_row_coderef => sub { + my ($database,$input,$mfn) = @_; + $store->load_row( database => $database, input => $input, id => $mfn ); + }, ); -Options C, C, C and C are mandatory while all +Options C, C and C are mandatory while all other are optional. +C is closure only used when executing lookups, so they will +die if it's not defined. + This function will B if normalizastion can't be evaled. Since this function isn't exported you have to call it with @@ -84,17 +94,24 @@ =cut +my $load_row_coderef; + sub data_structure { my $arg = {@_}; die "need row argument" unless ($arg->{row}); die "need normalisation argument" unless ($arg->{rules}); + # FIXME load this conditionally +# use WebPAC::Normalize::ISBN; + no strict 'subs'; - _set_lookup( $arg->{lookup} ); + _set_lookup( $arg->{lookup} ) if defined($arg->{lookup}); _set_rec( $arg->{row} ); - _set_config( $arg->{config} ); + _set_config( $arg->{config} ) if defined($arg->{config}); _clean_ds( %{ $arg } ); + $load_row_coderef = $arg->{load_row_coderef}; + eval "$arg->{rules}"; die "error evaling $arg->{rules}: $@\n" if ($@); @@ -151,10 +168,13 @@ =cut -my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators); +my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader); my ($marc_record_offset, $marc_fetch_offset) = (0, 0); sub _get_ds { + +warn "## out = ",dump($out); + return $out; } @@ -168,7 +188,7 @@ sub _clean_ds { my $a = {@_}; - ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = (); + ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader) = (); ($marc_record_offset, $marc_fetch_offset) = (0,0); $marc_encoding = $a->{marc_encoding}; } @@ -187,6 +207,37 @@ $lookup = shift; } +=head2 _get_lookup + +Get current lookup hash + + my $lookup = _get_lookup(); + +=cut + +sub _get_lookup { + return $lookup; +} + +=head2 _set_load_row + +Setup code reference which will return L from +L + + _set_load_row(sub { + my ($database,$input,$mfn) = @_; + $store->load_row( database => $database, input => $input, id => $mfn ); + }); + +=cut + +sub _set_load_row { + my $coderef = shift; + confess "argument isn't CODE" unless ref($coderef) eq 'CODE'; + + $load_row_coderef = $coderef; +} + =head2 _get_marc_fields Get all fields defined by calls to C @@ -242,13 +293,15 @@ =cut +my $fetch_pos; + sub _get_marc_fields { my $arg = {@_}; warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2); - my $offset = $marc_fetch_offset; + $fetch_pos = $marc_fetch_offset; if ($arg->{offset}) { - $offset = $arg->{offset}; + $fetch_pos = $arg->{offset}; } elsif($arg->{fetch_next}) { $marc_fetch_offset++; } @@ -257,9 +310,9 @@ warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2); - my $marc_rec = $marc_record->[ $offset ]; + my $marc_rec = $marc_record->[ $fetch_pos ]; - warn "## _get_marc_fields (at offset: $offset) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1); + warn "## _get_marc_fields (at offset: $fetch_pos) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1); return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0); @@ -280,7 +333,7 @@ if ($debug) { warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield ); - warn "## marc_record[$offset] = ", dump( $marc_rec ), $/; + warn "## marc_record[$fetch_pos] = ", dump( $marc_rec ), $/; warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/; warn "## subfield count = ", dump( $u ), $/; } @@ -361,6 +414,19 @@ return \@m; } +=head2 _get_marc_leader + +Return leader from currently fetched record by L + + print WebPAC::Normalize::_get_marc_leader(); + +=cut + +sub _get_marc_leader { + die "no fetch_pos, did you called _get_marc_fields first?" unless ( defined( $fetch_pos ) ); + return $marc_leader->[ $fetch_pos ]; +} + =head2 _debug Change level of debug warnings @@ -380,40 +446,51 @@ Those functions generally have to first in your normalization file. -=head2 tag +=head2 search_display -Define new tag for I and I. +Define output for L and L at the same time - tag('Title', rec('200','a') ); + search_display('Title', rec('200','a') ); =cut -sub tag { - my $name = shift or die "tag needs name as first argument"; +sub search_display { + my $name = shift or die "search_display needs name as first argument"; my @o = grep { defined($_) && $_ ne '' } @_; return unless (@o); - $out->{$name}->{tag} = $name; $out->{$name}->{search} = \@o; $out->{$name}->{display} = \@o; } +=head2 tag + +Old name for L, but supported + +=cut + +sub tag { + search_display( @_ ); +} + =head2 display -Define tag just for I +Define output just for I @v = display('Title', rec('200','a') ); =cut -sub display { - my $name = shift or die "display needs name as first argument"; +sub _field { + my $type = shift or confess "need type -- BUG?"; + my $name = shift or confess "needs name as first argument"; my @o = grep { defined($_) && $_ ne '' } @_; return unless (@o); - $out->{$name}->{tag} = $name; - $out->{$name}->{display} = \@o; + $out->{$name}->{$type} = \@o; } +sub display { _field( 'display', @_ ) } + =head2 search Prepare values just for I @@ -422,13 +499,18 @@ =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; - $out->{$name}->{search} = \@o; -} +sub search { _field( 'search', @_ ) } + +=head2 sorted + +Insert into lists which will be automatically sorted + + sorted('Title', rec('200','a') ); + +=cut + +sub sorted { _field( 'sorted', @_ ) } + =head2 marc_leader @@ -443,9 +525,58 @@ my ($offset,$value) = @_; if ($offset) { - $out->{' leader'}->{ $offset } = $value; + $marc_leader->[ $marc_record_offset ]->{ $offset } = $value; } else { - return $out->{' leader'}; + + if (defined($marc_leader)) { + die "marc_leader not array = ", dump( $marc_leader ) unless (ref($marc_leader) eq 'ARRAY'); + return $marc_leader->[ $marc_record_offset ]; + } else { + return; + } + } +} + +=head2 marc_fixed + +Create control/indentifier fields with values in fixed positions + + marc_fixed('008', 00, '070402'); + marc_fixed('008', 39, '|'); + +Positions not specified will be filled with spaces (C<0x20>). + +There will be no effort to extend last specified value to full length of +field in standard. + +=cut + +sub marc_fixed { + my ($f, $pos, $val) = @_; + die "need marc(field, position, value)" unless defined($f) && defined($pos); + + confess "need val" unless defined $val; + + my $update = 0; + + map { + if ($_->[0] eq $f) { + my $old = $_->[1]; + if (length($old) <= $pos) { + $_->[1] .= ' ' x ( $pos - length($old) ) . $val; + warn "## marc_fixed($f,$pos,'$val') append '$old' -> '$_->[1]'\n" if ($debug > 1); + } else { + $_->[1] = substr($old, 0, $pos) . $val . substr($old, $pos + length($val)); + warn "## marc_fixed($f,$pos,'$val') update '$old' -> '$_->[1]'\n" if ($debug > 1); + } + $update++; + } + } @{ $marc_record->[ $marc_record_offset ] }; + + if (! $update) { + my $v = ' ' x $pos . $val; + push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ]; + warn "## marc_fixed($f,$pos,'val') created '$v'\n" if ($debug > 1); } } @@ -470,7 +601,6 @@ 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 ]; @@ -550,7 +680,6 @@ my $v = shift; next unless (defined($v) && $v !~ /^\s*$/); - from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding); warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1); if ($sf ne '+') { push @$m, ( $sf, $v ); @@ -579,9 +708,11 @@ 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); + push @{ $marc_leader }, dclone( marc_leader() ); + warn "## marc_duplicate = ", dump(@$marc_leader, @$marc_record), $/ if ($debug > 1); $marc_record_offset = $#{ $marc_record }; warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1); + } =head2 marc_remove @@ -593,6 +724,10 @@ This will erase field C<200> or C<200^a> from current MARC record. + marc_remove('*'); + +Will remove all fields in current MARC record. + This is useful after calling C or on it's own (but, you should probably just remove that subfield definition if you are not using C). @@ -610,39 +745,47 @@ 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--; - } 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--; - }; + if ($f eq '*') { + + delete( $marc_record->[ $marc_record_offset ] ); + warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1); + + } else { + + 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++; } - $i++; - } - warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2); + warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2); - $marc_record->[ $marc_record_offset ] = $marc; + $marc_record->[ $marc_record_offset ] = $marc; + } warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1); } @@ -717,6 +860,18 @@ warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1); } +=head2 marc_count + +Return number of MARC records created using L. + + print "created ", marc_count(), " records"; + +=cut + +sub marc_count { + return $#{ $marc_record }; +} + =head1 Functions to extract data from input @@ -725,7 +880,11 @@ =head2 _pack_subfields_hash - @values = _pack_subfields_hash( $h, $include_subfields ) + @subfields = _pack_subfields_hash( $h ); + $subfields = _pack_subfields_hash( $h, 1 ); + +Return each subfield value in array or pack them all together and return scalar +with subfields (denoted by C<^>) and values. =cut @@ -735,6 +894,8 @@ my ($h,$include_subfields) = @_; + # sanity and ease of use + return $h if (ref($h) ne 'HASH'); if ( defined($h->{subfields}) ) { my $sfs = delete $h->{subfields} || die "no subfields?"; @@ -745,16 +906,34 @@ my $o = shift @$sfs; if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) { # single element subfields are not arrays +#warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n"; + push @out, $h->{$sf}; } else { -#warn "====> $f $sf $o $#$sfs ", dump( $sfs ), "\n"; +#warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n"; push @out, $h->{$sf}->[$o]; } } - return @out; + if ($include_subfields) { + return join('', @out); + } else { + return @out; + } } else { - # FIXME this should probably be in alphabetical order instead of hash order - values %{$h}; + if ($include_subfields) { + my $out = ''; + foreach my $sf (sort keys %$h) { + if (ref($h->{$sf}) eq 'ARRAY') { + $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} }); + } else { + $out .= '^' . $sf . $h->{$sf}; + } + } + return $out; + } else { + # FIXME this should probably be in alphabetical order instead of hash order + values %{$h}; + } } } @@ -817,8 +996,17 @@ @v = rec('200') @v = rec('200','a') +If rec() returns just single value, it will +return scalar, not array. + =cut +sub frec { + my @out = rec(@_); + warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0; + return shift @out; +} + sub rec { my @out; if ($#_ == 0) { @@ -826,7 +1014,9 @@ } elsif ($#_ == 1) { @out = rec2(@_); } - if (@out) { + if ($#out == 0 && ! wantarray) { + return $out[0]; + } elsif (@out) { return @out; } else { return ''; @@ -862,7 +1052,8 @@ =cut sub prefix { - my $p = shift or return; + my $p = shift; + return @_ unless defined( $p ); return map { $p . $_ } grep { defined($_) } @_; } @@ -875,7 +1066,8 @@ =cut sub suffix { - my $s = shift or die "suffix needs string as first argument"; + my $s = shift; + return @_ unless defined( $s ); return map { $_ . $s } grep { defined($_) } @_; } @@ -888,8 +1080,10 @@ =cut sub surround { - my $p = shift or die "surround need prefix as first argument"; - my $s = shift or die "surround needs suffix as second argument"; + my $p = shift; + my $s = shift; + $p = '' unless defined( $p ); + $s = '' unless defined( $s ); return map { $p . $_ . $s } grep { defined($_) } @_; } @@ -910,21 +1104,152 @@ Consult lookup hashes for some value - @v = lookup( $v ); - @v = lookup( @v ); + @v = lookup( + sub { + 'ffkk/peri/mfn'.rec('000') + }, + 'ffkk','peri','200-a-200-e', + sub { + first(rec(200,'a')).' '.first(rec('200','e')) + } + ); + +Code like above will be B using L from +normal lookup definition in C which looks like: + + lookup( + # which results to return from record recorded in lookup + sub { 'ffkk/peri/mfn' . rec('000') }, + # from which database and input + 'ffkk','peri', + # such that following values match + sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) }, + # if this part is missing, we will try to match same fields + # from lookup record and current one, or you can override + # which records to use from current record using + sub { rec('900','x') . ' ' . rec('900','y') }, + ) + +You can think about this lookup as SQL (if that helps): + + select + sub { what } + from + database, input + where + sub { filter from lookuped record } + having + sub { optional filter on current record } + +Easy as pie, right? =cut sub lookup { - my $k = shift or return; - return unless (defined($lookup->{$k})); - if (ref($lookup->{$k}) eq 'ARRAY') { - return @{ $lookup->{$k} }; + my ($what, $database, $input, $key, $having) = @_; + + confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4); + + warn "## lookup ($database, $input, $key)", $/ if ($debug > 1); + return unless (defined($lookup->{$database}->{$input}->{$key})); + + confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef); + + my $mfns; + my @having = $having->(); + + warn "## having = ", dump( @having ) if ($debug > 2); + + foreach my $h ( @having ) { + if (defined($lookup->{$database}->{$input}->{$key}->{$h})) { + warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug); + $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} }; + } + } + + return unless ($mfns); + + my @mfns = sort keys %$mfns; + + warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug); + + my $old_rec = $rec; + my @out; + + foreach my $mfn (@mfns) { + $rec = $load_row_coderef->( $database, $input, $mfn ); + + warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug); + + my @vals = $what->(); + + push @out, ( @vals ); + + warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug); + } + +# if (ref($lookup->{$k}) eq 'ARRAY') { +# return @{ $lookup->{$k} }; +# } else { +# return $lookup->{$k}; +# } + + $rec = $old_rec; + + warn "## lookup returns = ", dump(@out), $/ if ($debug); + + if ($#out == 0) { + return $out[0]; } else { - return $lookup->{$k}; + return @out; } } +=head2 save_into_lookup + +Save value into lookup. It associates current database, input +and specific keys with one or more values which will be +associated over MFN. + +MFN will be extracted from first occurence current of field 000 +in current record, or if it doesn't exist from L<_set_config> C<_mfn>. + + my $nr = save_into_lookup($database,$input,$key,sub { + # code which produce one or more values + }); + +It returns number of items saved. + +This function shouldn't be called directly, it's called from code created by +L. + +=cut + +sub save_into_lookup { + my ($database,$input,$key,$coderef) = @_; + die "save_into_lookup needs database" unless defined($database); + die "save_into_lookup needs input" unless defined($input); + die "save_into_lookup needs key" unless defined($key); + die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' ); + + warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2); + + my $mfn = + defined($rec->{'000'}->[0]) ? $rec->{'000'}->[0] : + defined($config->{_mfn}) ? $config->{_mfn} : + die "mfn not defined or zero"; + + my $nr = 0; + + foreach my $v ( $coderef->() ) { + $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++; + warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1); + $nr++; + } + + return $nr; +} + =head2 config Consult config values stored in C @@ -933,7 +1258,6 @@ $database_code = config(); # use _ from hash $database_name = config('name'); $database_input_name = config('input name'); - $tag = config('input normalize tag'); Up to three levels are supported. @@ -1049,5 +1373,45 @@ } } +my $hash; + +=head2 set + + set( key => 'value' ); + +=cut + +sub set { + my ($k,$v) = @_; + warn "## set ( $k => ", dump($v), " )", $/ if ( $debug ); + $hash->{$k} = $v; +}; + +=head2 get + + get( 'key' ); + +=cut + +sub get { + my $k = shift || return; + my $v = $hash->{$k}; + warn "## get $k = ", dump( $v ), $/ if ( $debug ); + return $v; +} + +=head2 count + + if ( count( @result ) == 1 ) { + # do something if only 1 result is there + } + +=cut + +sub count { + warn "## count ",dump(@_),$/ if ( $debug ); + return @_ . ''; +} + # END 1;