/[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 317 by dpavlin, Fri Dec 23 21:37:05 2005 UTC revision 1118 by dpavlin, Sun Oct 26 15:57:37 2008 UTC
# Line 1  Line 1 
1  package WebPAC::Normalize;  package WebPAC::Normalize;
2    use Exporter 'import';
3    our @EXPORT = qw/
4            _set_ds _set_lookup
5            _set_load_row
6            _get_ds _clean_ds
7            _debug
8            _pack_subfields_hash
9    
10            to
11            search_display search display sorted
12    
13            rec1 rec2 rec
14            frec frec_eq frec_ne
15            regex prefix suffix surround
16            first lookup join_with
17            save_into_lookup
18    
19            split_rec_on
20    
21            get set
22            count
23    
24    /;
25    
26  use warnings;  use warnings;
27  use strict;  use strict;
 use base 'WebPAC::Common';  
 use Data::Dumper;  
28    
29  =head1 NAME  #use base qw/WebPAC::Common/;
30    use Data::Dump qw/dump/;
31    use Carp qw/confess/;
32    
33    # debugging warn(s)
34    my $debug = 0;
35    _debug( $debug );
36    
37    # FIXME
38    use WebPAC::Normalize::ISBN;
39    push @EXPORT, ( 'isbn_10', 'isbn_13' );
40    
41    use WebPAC::Normalize::MARC;
42    push @EXPORT, ( qw/
43            marc marc_indicators marc_repeatable_subfield
44            marc_compose marc_leader marc_fixed
45            marc_duplicate marc_remove marc_count
46            marc_original_order
47            marc_template
48    /);
49    
50  WebPAC::Normalize - data mungling for normalisation  use Storable qw/dclone/;
51    
52  =head1 VERSION  =head1 NAME
53    
54  Version 0.08  WebPAC::Normalize - describe normalisaton rules using sets
55    
56  =cut  =cut
57    
58  our $VERSION = '0.08';  our $VERSION = '0.36';
59    
60  =head1 SYNOPSIS  =head1 SYNOPSIS
61    
62  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
63    from input records using perl functions which are specialized for set
64    processing.
65    
66    Sets are implemented as arrays, and normalisation file is valid perl, which
67    means that you check it's validity before running WebPAC using
68    C<perl -c normalize.pl>.
69    
70    Normalisation can generate multiple output normalized data. For now, supported output
71    types (on the left side of definition) are: C<search_display>, C<display>, C<search> and
72    C<marc>.
73    
74  It contains several assumptions:  =head1 FUNCTIONS
75    
76  =over  Functions which start with C<_> are private and used by WebPAC internally.
77    All other functions are available for use within normalisation rules.
78    
79  =item *  =head2 data_structure
80    
81  format of fields is defined using C<v123^a> notation for repeatable fields  Return data structure
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
82    
83  =item *    my $ds = WebPAC::Normalize::data_structure(
84            lookup => $lookup_hash,
85            row => $row,
86            rules => $normalize_pl_config,
87            marc_encoding => 'utf-8',
88            config => $config,
89            load_row_coderef => sub {
90                    my ($database,$input,$mfn) = @_;
91                    $store->load_row( database => $database, input => $input, id => $mfn );
92            },
93      );
94    
95  source data records (C<$rec>) have unique identifiers in field C<000>  Options C<row>, C<rules> and C<log> are mandatory while all
96    other are optional.
97    
98  =item *  C<load_row_coderef> is closure only used when executing lookups, so they will
99    die if it's not defined.
100    
101  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  This function will B<die> if normalizastion can't be evaled.
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
102    
103  =item *  Since this function isn't exported you have to call it with
104    C<WebPAC::Normalize::data_structure>.
105    
106  optional C<filter{filter_name}> at B<begining of format> will apply perl  =cut
 code defined as code ref on format after field substitution to producing  
 output  
107    
108  There is one built-in filter called C<regex> which can be use like this:  my $load_row_coderef;
109    
110    filter{regex(s/foo/bar/)}  sub data_structure {
111            my $arg = {@_};
112    
113  =item *          die "need row argument" unless ($arg->{row});
114            die "need normalisation argument" unless ($arg->{rules});
115    
116  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.          _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
117            _set_ds( $arg->{row} );
118            _set_config( $arg->{config} ) if defined($arg->{config});
119            _clean_ds( %{ $arg } );
120            $load_row_coderef = $arg->{load_row_coderef};
121    
122  =item *          no strict 'subs';
123            no warnings 'redefine';
124            eval "$arg->{rules};";
125            die "error evaling $arg->{rules}: $@\n" if ($@);
126    
127  at end, optional C<format>s rules are resolved. Format rules are similar to          return _get_ds();
128  C<sprintf> and can also contain C<lookup{...}> which is performed after  }
 values are inserted in format.  
129    
130  =back  =head2 _set_ds
131    
132  This also describes order in which transformations are applied (eval,  Set current record hash
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
133    
134      _set_ds( $rec );
135    
136    =cut
137    
138    my $rec;
139    
140  =head1 FUNCTIONS  sub _set_ds {
141            $rec = shift or die "no record hash";
142            $WebPAC::Normalize::MARC::rec = $rec;
143    }
144    
145  =head2 new  =head2
146    
147  Create new normalisation object    my $rec = _get_rec();
148    
149    my $n = new WebPAC::Normalize::Something(  =cut
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
150    
151  Parametar C<filter> defines user supplied snippets of perl code which can  sub _get_rec { $rec };
 be use with C<filter{...}> notation.  
152    
153  C<prefix> is used to form filename for database record (to support multiple  =head2 _set_config
 source files which are joined in one database).  
154    
155  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Set current config hash
 in structures. If you pass this parametar, you must also pass C<lookup>  
 which is C<WebPAC::Lookup> object.  
156    
157  =cut    _set_config( $config );
158    
159  sub new {  Magic keys are:
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
160    
161          my $r = $self->{'lookup_regex'} ? 1 : 0;  =over 4
         my $l = $self->{'lookup'} ? 1 : 0;  
162    
163          my $log = $self->_get_logger();  =item _
164    
165          # those two must be in pair  Code of current database
166          if ( ($r & $l) != ($r || $l) ) {  
167                  my $log = $self->_get_logger();  =item _mfn
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
168    
169          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  Current MFN
170    
171          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  =back
172    
173          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  =cut
174    
175          if (! $self->{filter} || ! $self->{filter}->{regex}) {  my $config;
                 $log->debug("adding built-in filter regex");  
                 $self->{filter}->{regex} = sub {  
                         my ($val, $regex) = @_;  
                         eval "\$val =~ $regex";  
                         return $val;  
                 };  
         }  
176    
177          $self ? return $self : return undef;  sub _set_config {
178            $config = shift;
179  }  }
180    
181    =head2 _get_ds
182    
183  =head2 data_structure  Return hash formatted as data structure
184    
185      my $ds = _get_ds();
186    
187    =cut
188    
189    my $out;
190    
191    sub _get_ds {
192    #warn "## out = ",dump($out);
193            return $out;
194    }
195    
196  Create in-memory data structure which represents normalized layout from  =head2 _clean_ds
 C<conf/normalize/*.xml>.  
197    
198  This structures are used to produce output.  Clean data structure hash for next record
199    
200   my $ds = $webpac->data_structure($rec);    _clean_ds();
201    
202  =cut  =cut
203    
204  sub data_structure {  sub _clean_ds {
205          my $self = shift;          my $a = {@_};
206            $out = undef;
207            WebPAC::Normalize::MARC::_clean();
208    }
209    
210          my $log = $self->_get_logger();  =head2 _set_lookup
211    
212          my $rec = shift;  Set current lookup hash
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
213    
214          $log->debug("data_structure rec = ", sub { Dumper($rec) });    _set_lookup( $lookup );
215    
216          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));  =cut
217    
218          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  my $lookup;
219    
220          my $cache_file;  sub _set_lookup {
221            $lookup = shift;
222    }
223    
224          if ($self->{'db'}) {  =head2 _get_lookup
                 my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );  
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });  
                 return $ds if ($ds);  
                 $log->debug("cache miss, creating");  
         }  
225    
226          my @sorted_tags;  Get current lookup hash
         if ($self->{tags_by_order}) {  
                 @sorted_tags = @{$self->{tags_by_order}};  
         } else {  
                 @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
                 $self->{tags_by_order} = \@sorted_tags;  
         }  
227    
228          my $ds;    my $lookup = _get_lookup();
229    
230          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  =cut
231    
232          foreach my $field (@sorted_tags) {  sub _get_lookup {
233            return $lookup;
234    }
235    
236                  my $row;  =head2 _set_load_row
237    
238  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  Setup code reference which will return L<data_structure> from
239    L<WebPAC::Store>
240    
241                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {    _set_load_row(sub {
242                          my $format;                  my ($database,$input,$mfn) = @_;
243                    $store->load_row( database => $database, input => $input, id => $mfn );
244      });
245    
246                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');  =cut
                         $format = $tag->{'value'} || $tag->{'content'};  
247    
248                          $log->debug("format: $format");  sub _set_load_row {
249            my $coderef = shift;
250            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
251    
252                          my @v;          $load_row_coderef = $coderef;
253                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  }
                                 @v = $self->fill_in_to_arr($rec,$format);  
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
254    
255                          if ($tag->{'sort'}) {  =head2 _debug
                                 @v = $self->sort_arr(@v);  
                         }  
256    
257                          # use format?  Change level of debug warnings
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
258    
259                          # delimiter will join repeatable fields    _debug( 2 );
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
260    
261                          # default types  =cut
                         my @types = qw(display search);  
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, " ", $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
262    
263                                  } else {  sub _debug {
264                                          push @{$row->{$type}}, @v;          my $l = shift;
265                                  }          return $debug unless defined($l);
266                          }          warn "debug level $l",$/ if ($l > 0);
267            $debug = $l;
268            $WebPAC::Normalize::MARC::debug = $debug;
269    }
270    
271    =head1 Functions to create C<data_structure>
272    
273                  }  Those functions generally have to first in your normalization file.
274    
275                  if ($row) {  =head2 to
                         $row->{'tag'} = $field;  
276    
277                          # TODO: name_sigular, name_plural  Generic way to set values for some name
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         my $row_name = $name ? $self->_x($name) : $field;  
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
278    
279                          $ds->{$row_name} = $row;    to('field-name', 'name-value' => rec('200','a') );
280    
281                          $log->debug("row $field: ",sub { Dumper($row) });  There are many helpers defined below which might be easier to use.
                 }  
282    
283          }  =cut
284    
285    sub to {
286            my $type = shift or confess "need type -- BUG?";
287            my $name = shift or confess "needs name as first argument";
288            my @o = grep { defined($_) && $_ ne '' } @_;
289            return unless (@o);
290            $out->{$name}->{$type} = \@o;
291    }
292    
293          $self->{'db'}->save_ds(  =head2 search_display
                 id => $id,  
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
294    
295          $log->debug("ds: ", sub { Dumper($ds) });  Define output for L<search> and L<display> at the same time
296    
297          $log->logconfess("data structure returned is not array any more!") if wantarray;    search_display('Title', rec('200','a') );
298    
299          return $ds;  =cut
300    
301    sub search_display {
302            my $name = shift or die "search_display needs name as first argument";
303            my @o = grep { defined($_) && $_ ne '' } @_;
304            return unless (@o);
305            $out->{$name}->{search} = \@o;
306            $out->{$name}->{display} = \@o;
307  }  }
308    
309  =head2 parse  =head2 tag
310    
311  Perform smart parsing of string, skipping delimiters for fields which aren't  Old name for L<search_display>, it will probably be removed at one point.
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
312    
313   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  =cut
314    
315  Filters are implemented here. While simple form of filters looks like this:  sub tag {
316            search_display( @_ );
317    }
318    
319    filter{name_of_filter}  =head2 display
320    
321  but, filters can also have variable number of parametars like this:  Define output just for I<display>
322    
323    filter{name_of_filter(param,param,param)}    @v = display('Title', rec('200','a') );
324    
325  =cut  =cut
326    
327  my $warn_once;  sub display { to( 'display', @_ ) }
328    
329  sub parse {  =head2 search
         my $self = shift;  
330    
331          my ($rec, $format_utf8, $i) = @_;  Prepare values just for I<search>
332    
333          return if (! $format_utf8);    @v = search('Title', rec('200','a') );
334    
335          my $log = $self->_get_logger();  =cut
336    
337          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  sub search { to( 'search', @_ ) }
338    
339          $i = 0 if (! $i);  =head2 sorted
340    
341          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  Insert into lists which will be automatically sorted
342    
343     sorted('Title', rec('200','a') );
344    
345    =cut
346    
347    sub sorted { to( 'sorted', @_ ) }
348    
         my @out;  
349    
350          $log->debug("format: $format");  =head1 Functions to extract data from input
351    
352          my $eval_code;  This function should be used inside functions to create C<data_structure> described
353          # remove eval{...} from beginning  above.
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
354    
355          my $filter_name;  =head2 _pack_subfields_hash
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
356    
357          # did we found any (att all) field from format in row?   @subfields = _pack_subfields_hash( $h );
358          my $found_any = 0;   $subfields = _pack_subfields_hash( $h, 1 );
359          # prefix before first field which we preserve it $found_any  
360          my $prefix;  Return each subfield value in array or pack them all together and return scalar
361    with subfields (denoted by C<^>) and values.
362    
363    =cut
364    
365          my $f_step = 1;  sub _pack_subfields_hash {
366    
367          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
368    
369                  my $del = $1 || '';          my ($hash,$include_subfields) = @_;
                 $prefix = $del if ($f_step == 1);  
370    
371                  # repeatable index          # sanity and ease of use
372                  my $r = $i;          return $hash if (ref($hash) ne 'HASH');
                 $r = 0 if (lc("$2") eq 's');  
373    
374                  my $found = 0;          my $h = dclone( $hash );
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
375    
376                  if ($found) {          if ( defined($h->{subfields}) ) {
377                          $found_any += $found;                  my $sfs = delete $h->{subfields} || die "no subfields?";
378                    my @out;
379                    while (@$sfs) {
380                            my $sf = shift @$sfs;
381                            push @out, '^' . $sf if ($include_subfields);
382                            my $o = shift @$sfs;
383                            if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
384                                    # single element subfields are not arrays
385    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
386    
387                          # we will skip delimiter before first occurence of field!                                  push @out, $h->{$sf};
388                          push @out, $del unless($found_any == 1);                          } else {
389                          push @out, $tmp;  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
390                                    push @out, $h->{$sf}->[$o];
391                            }
392                    }
393                    if ($include_subfields) {
394                            return join('', @out);
395                    } else {
396                            return @out;
397                    }
398            } else {
399                    if ($include_subfields) {
400                            my $out = '';
401                            foreach my $sf (sort keys %$h) {
402                                    if (ref($h->{$sf}) eq 'ARRAY') {
403                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
404                                    } else {
405                                            $out .= '^' . $sf . $h->{$sf};
406                                    }
407                            }
408                            return $out;
409                    } else {
410                            # FIXME this should probably be in alphabetical order instead of hash order
411                            values %{$h};
412                  }                  }
                 $f_step++;  
413          }          }
414    }
415    
416          return if (! $found_any);  =head2 rec1
417    
418          my $out = join('',@out);  Return all values in some field
419    
420          if ($out) {    @v = rec1('200')
                 # add rest of format (suffix)  
                 $out .= $format;  
421    
422                  # add prefix if not there  TODO: order of values is probably same as in source data, need to investigate that
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
423    
424                  $log->debug("result: $out");  =cut
         }  
425    
426          if ($eval_code) {  sub rec1 {
427                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;          my $f = shift;
428                  $log->debug("about to eval{$eval} format: $out");          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
429                  return if (! $self->_eval($eval));          return unless (defined($rec) && defined($rec->{$f}));
430          }          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
431                    if (ref($rec->{$f}) eq 'ARRAY') {
432          if ($filter_name) {                  my @out;
433                  my @filter_args;                  foreach my $h ( @{ $rec->{$f} } ) {
434                  if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {                          if (ref($h) eq 'HASH') {
435                          @filter_args = split(/,/, $2);                                  push @out, ( _pack_subfields_hash( $h ) );
436                  }                          } else {
437                  if ($self->{'filter'}->{$filter_name}) {                                  push @out, $h;
438                          $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));                          }
                         unshift @filter_args, $out;  
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
439                  }                  }
440                    return @out;
441            } elsif( defined($rec->{$f}) ) {
442                    return $rec->{$f};
443          }          }
   
         return $out;  
444  }  }
445    
446  =head2 parse_to_arr  =head2 rec2
447    
448  Similar to C<parse>, but returns array of all repeatable fields  Return all values in specific field and subfield
449    
450   my @arr = $webpac->parse_to_arr($rec,'v250^a');    @v = rec2('200','a')
451    
452  =cut  =cut
453    
454  sub parse_to_arr {  sub rec2 {
455          my $self = shift;          my $f = shift;
456            return unless (defined($rec && $rec->{$f}));
457            my $sf = shift;
458            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
459            return map {
460                    if (ref($_->{$sf}) eq 'ARRAY') {
461                            @{ $_->{$sf} };
462                    } else {
463                            $_->{$sf};
464                    }
465            } grep { ref($_) eq 'HASH' && defined $_->{$sf} } @{ $rec->{$f} };
466    }
467    
468    =head2 rec
469    
470          my ($rec, $format_utf8) = @_;  syntaxtic sugar for
471    
472          my $log = $self->_get_logger();    @v = rec('200')
473      @v = rec('200','a')
474    
475          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  If rec() returns just single value, it will
476          return if (! $format_utf8);  return scalar, not array.
477    
478          my $i = 0;  =cut
         my @arr;  
479    
480          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  sub rec {
481                  push @arr, $v;          my @out;
482            if ($#_ == 0) {
483                    @out = rec1(@_);
484            } elsif ($#_ == 1) {
485                    @out = rec2(@_);
486            }
487            if ($#out == 0 && ! wantarray) {
488                    return $out[0];
489            } elsif (@out) {
490                    return @out;
491            } else {
492                    return '';
493          }          }
494    }
495    
496          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =head2 frec
497    
498          return @arr;  Returns first value from field
 }  
499    
500      $v = frec('200');
501      $v = frec('200','a');
502    
503  =head2 fill_in  =cut
504    
505  Workhourse of all: takes record from in-memory structure of database and  sub frec {
506  strings with placeholders and returns string or array of with substituted          my @out = rec(@_);
507  values from record.          warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0;
508            return shift @out;
509    }
510    
511   my $text = $webpac->fill_in($rec,'v250^a');  =head2 frec_eq
512    
513  Optional argument is ordinal number for repeatable fields. By default,  =head2 frec_ne
 it's assume to be first repeatable field (fields are perl array, so first  
 element is 0).  
 Following example will read second value from repeatable field.  
514    
515   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  Check if first values from two fields are same or different
516    
517  This function B<does not> perform parsing of format to inteligenty skip    if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
518  delimiters before fields which aren't used.          # values are same
519      } else {
520        # values are different
521      }
522    
523  This method will automatically decode UTF-8 string to local code page  Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
524  if needed.  could write something like:
525    
526      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
527            # yada tada
528      }
529    
530    but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
531    in order to parse text and create invalid function C<eqfrec>.
532    
533  =cut  =cut
534    
535  sub fill_in {  sub frec_eq {
536          my $self = shift;          my ( $f1,$sf1, $f2, $sf2 ) = @_;
537            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
538    }
539    
540    sub frec_ne {
541            return ! frec_eq( @_ );
542    }
543    
544          my $log = $self->_get_logger();  =head2 regex
545    
546          my $rec = shift || $log->logconfess("need data record");  Apply regex to some or all values
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
547    
548          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));    @v = regex( 's/foo/bar/g', @v );
549    
550          # FIXME remove for speedup?  =cut
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
551    
552          if (utf8::is_utf8($format)) {  sub regex {
553                  $format = $self->_x($format);          my $r = shift;
554            my @out;
555            #warn "r: $r\n", dump(\@_);
556            foreach my $t (@_) {
557                    next unless ($t);
558                    eval "\$t =~ $r";
559                    push @out, $t if ($t && $t ne '');
560          }          }
561            return @out;
562    }
563    
564          my $found = 0;  =head2 prefix
565    
566          my $eval_code;  Prefix all values with a string
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
567    
568          my $filter_name;    @v = prefix( 'my_', @v );
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
569    
570          # do actual replacement of placeholders  =cut
         # repeatable fields  
         $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;  
         # non-repeatable fields  
         $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;  
571    
572          if ($found) {  sub prefix {
573                  $log->debug("format: $format");          my $p = shift;
574                  if ($eval_code) {          return @_ unless defined( $p );
575                          my $eval = $self->fill_in($rec,$eval_code,$i);          return map { $p . $_ } grep { defined($_) } @_;
                         return if (! $self->_eval($eval));  
                 }  
                 if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                         $log->debug("filter '$filter_name' for $format");  
                         $format = $self->{'filter'}->{$filter_name}->($format);  
                         return unless(defined($format));  
                         $log->debug("filter result: $format");  
                 }  
                 # do we have lookups?  
                 if ($self->{'lookup'}) {  
                         if ($self->{'lookup'}->can('lookup')) {  
                                 my @lookup = $self->{lookup}->lookup($format);  
                                 $log->debug("lookup $format", join(", ", @lookup));  
                                 return @lookup;  
                         } else {  
                                 $log->warn("Have lookup object but can't invoke lookup method");  
                         }  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
576  }  }
577    
578    =head2 suffix
579    
580  =head2 fill_in_to_arr  suffix all values with a string
   
 Similar to C<fill_in>, but returns array of all repeatable fields. Usable  
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
581    
582   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = suffix( '_my', @v );
583    
584  =cut  =cut
585    
586  sub fill_in_to_arr {  sub suffix {
587          my $self = shift;          my $s = shift;
588            return @_ unless defined( $s );
589            return map { $_ . $s } grep { defined($_) } @_;
590    }
591    
592          my ($rec, $format_utf8) = @_;  =head2 surround
593    
594          my $log = $self->_get_logger();  surround all values with a two strings
595    
596          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = surround( 'prefix_', '_suffix', @v );
         return if (! $format_utf8);  
597    
598          my $i = 0;  =cut
         my @arr;  
599    
600          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub surround {
601                  push @arr, @v;          my $p = shift;
602          }          my $s = shift;
603            $p = '' unless defined( $p );
604            $s = '' unless defined( $s );
605            return map { $p . $_ . $s } grep { defined($_) } @_;
606    }
607    
608    =head2 first
609    
610    Return first element
611    
612          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);    $v = first( @v );
613    
614          return @arr;  =cut
615    
616    sub first {
617            my $r = shift;
618            return $r;
619  }  }
620    
621    =head2 lookup
622    
623    Consult lookup hashes for some value
624    
625  =head2 get_data    @v = lookup(
626            sub {
627                    'ffkk/peri/mfn'.rec('000')
628            },
629            'ffkk','peri','200-a-200-e',
630            sub {
631                    first(rec(200,'a')).' '.first(rec('200','e'))
632            }
633      );
634    
635  Returns value from record.  Code like above will be B<automatically generated> using L<WebPAC::Parse> from
636    normal lookup definition in C<conf/lookup/something.pl> which looks like:
637    
638   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);    lookup(
639            # which results to return from record recorded in lookup
640            sub { 'ffkk/peri/mfn' . rec('000') },
641            # from which database and input
642            'ffkk','peri',
643            # such that following values match
644            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
645            # if this part is missing, we will try to match same fields
646            # from lookup record and current one, or you can override
647            # which records to use from current record using
648            sub { rec('900','x') . ' ' . rec('900','y') },
649      )
650    
651  Arguments are:  You can think about this lookup as SQL (if that helps):
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
652    
653  Optinal variable C<$found> will be incremeted if there    select
654  is field.          sub { what }
655      from
656            database, input
657      where
658        sub { filter from lookuped record }
659      having
660        sub { optional filter on current record }
661    
662  Returns value or empty string.  Easy as pie, right?
663    
664  =cut  =cut
665    
666  sub get_data {  sub lookup {
667          my $self = shift;          my ($what, $database, $input, $key, $having) = @_;
668    
669          my ($rec,$f,$sf,$i,$found) = @_;          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
670    
671          if ($$rec->{$f}) {          warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
672                  return '' if (! $$rec->{$f}->[$i]);          return unless (defined($lookup->{$database}->{$input}->{$key}));
673                  no strict 'refs';  
674                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
675                          $$found++ if (defined($$found));  
676                          return $$rec->{$f}->[$i]->{$sf};          my $mfns;
677                  } elsif (! $sf && $$rec->{$f}->[$i]) {          my @having = $having->();
678                          $$found++ if (defined($$found));  
679                          # it still might have subfield, just          warn "## having = ", dump( @having ) if ($debug > 2);
680                          # not specified, so we'll dump all  
681                          if ($$rec->{$f}->[$i] =~ /HASH/o) {          foreach my $h ( @having ) {
682                                  my $out;                  if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
683                                  foreach my $k (keys %{$$rec->{$f}->[$i]}) {                          warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
684                                          $out .= $$rec->{$f}->[$i]->{$k}." ";                          $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 } else {  
                         return '';  
685                  }                  }
686            }
687    
688            return unless ($mfns);
689    
690            my @mfns = sort keys %$mfns;
691    
692            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
693    
694            my $old_rec = $rec;
695            my @out;
696    
697            foreach my $mfn (@mfns) {
698                    $rec = $load_row_coderef->( $database, $input, $mfn );
699    
700                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
701    
702                    my @vals = $what->();
703    
704                    push @out, ( @vals );
705    
706                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
707            }
708    
709    #       if (ref($lookup->{$k}) eq 'ARRAY') {
710    #               return @{ $lookup->{$k} };
711    #       } else {
712    #               return $lookup->{$k};
713    #       }
714    
715            $rec = $old_rec;
716    
717            warn "## lookup returns = ", dump(@out), $/ if ($debug);
718    
719            if ($#out == 0) {
720                    return $out[0];
721          } else {          } else {
722                  return '';                  return @out;
723          }          }
724  }  }
725    
726    =head2 save_into_lookup
727    
728    Save value into lookup. It associates current database, input
729    and specific keys with one or more values which will be
730    associated over MFN.
731    
732  =head2 apply_format  MFN will be extracted from first occurence current of field 000
733    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
734    
735  Apply format specified in tag with C<format_name="name"> and    my $nr = save_into_lookup($database,$input,$key,sub {
736  C<format_delimiter=";;">.          # code which produce one or more values
737      });
738    
739   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  It returns number of items saved.
740    
741  Formats can contain C<lookup{...}> if you need them.  This function shouldn't be called directly, it's called from code created by
742    L<WebPAC::Parser>.
743    
744  =cut  =cut
745    
746  sub apply_format {  sub save_into_lookup {
747          my $self = shift;          my ($database,$input,$key,$coderef) = @_;
748            die "save_into_lookup needs database" unless defined($database);
749            die "save_into_lookup needs input" unless defined($input);
750            die "save_into_lookup needs key" unless defined($key);
751            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
752    
753            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
754    
755          my ($name,$delimiter,$data) = @_;          my $mfn =
756                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
757                    defined($config->{_mfn})        ?       $config->{_mfn}         :
758                                                                                    die "mfn not defined or zero";
759    
760          my $log = $self->_get_logger();          my $nr = 0;
761    
762          if (! $self->{'import_xml'}->{'format'}->{$name}) {          foreach my $v ( $coderef->() ) {
763                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});                  $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
764                  return $data;                  warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
765                    $nr++;
766          }          }
767    
768          $log->warn("no delimiter for format $name") if (! $delimiter);          return $nr;
769    }
770    
771    =head2 config
772    
773    Consult config values stored in C<config.yml>
774    
775      # return database code (key under databases in yaml)
776      $database_code = config();    # use _ from hash
777      $database_name = config('name');
778      $database_input_name = config('input name');
779    
780    Up to three levels are supported.
781    
782    =cut
783    
784    sub config {
785            return unless ($config);
786    
787            my $p = shift;
788    
789          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");          $p ||= '';
790    
791          my @data = split(/\Q$delimiter\E/, $data);          my $v;
792    
793          my $out = sprintf($format, @data);          warn "### getting config($p)\n" if ($debug > 1);
         $log->debug("using format $name [$format] on $data to produce: $out");  
794    
795          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          my @p = split(/\s+/,$p);
796                  return $self->{'lookup'}->lookup($out);          if ($#p < 0) {
797                    $v = $config->{ '_' };  # special, database code
798          } else {          } else {
799                  return $out;  
800                    my $c = dclone( $config );
801    
802                    foreach my $k (@p) {
803                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
804                            if (ref($c) eq 'ARRAY') {
805                                    $c = shift @$c;
806                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
807                                    last;
808                            }
809    
810                            if (! defined($c->{$k}) ) {
811                                    $c = undef;
812                                    last;
813                            } else {
814                                    $c = $c->{$k};
815                            }
816                    }
817                    $v = $c if ($c);
818    
819          }          }
820    
821            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
822            warn "config( '$p' ) is empty\n" if (! $v);
823    
824            return $v;
825  }  }
826    
827  =head2 sort_arr  =head2 id
828    
829  Sort array ignoring case and html in data  Returns unique id of this record
830    
831   my @sorted = $webpac->sort_arr(@unsorted);    $id = id();
832    
833    Returns C<42/2> for 2nd occurence of MFN 42.
834    
835  =cut  =cut
836    
837  sub sort_arr {  sub id {
838          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
839            return $mfn . ( WebPAC::Normalize::MARC::_created_marc_records() || '' );
840    }
841    
842    =head2 join_with
843    
844          my $log = $self->_get_logger();  Joins walues with some delimiter
845    
846          # FIXME add Schwartzian Transformation?    $v = join_with(", ", @v);
847    
848          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
849    
850          return @sorted;  sub join_with {
851            my $d = shift;
852            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
853            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
854            return '' unless defined($v);
855            return $v;
856  }  }
857    
858    =head2 split_rec_on
859    
860    Split record subfield on some regex and take one of parts out
861    
862  =head1 INTERNAL METHODS    $a_before_semi_column =
863            split_rec_on('200','a', /\s*;\s*/, $part);
864    
865  =head2 _sort_by_order  C<$part> is optional number of element. First element is
866    B<1>, not 0!
867    
868  Sort xml tags data structure accoding to C<order=""> attribute.  If there is no C<$part> parameter or C<$part> is 0, this function will
869    return all values produced by splitting.
870    
871  =cut  =cut
872    
873  sub _sort_by_order {  sub split_rec_on {
874          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
875    
876          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          my ($fld, $sf, $regex, $part) = @_;
877                  $self->{'import_xml'}->{'indexer'}->{$a};          warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
878    
879          return $va <=> $vb;          my @r = rec( $fld, $sf );
880  }          my $v = shift @r;
881            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
882    
883  =head2 _x          return '' if ( ! defined($v) || $v =~ /^\s*$/);
884    
885            my @s = split( $regex, $v );
886            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
887            if ($part && $part > 0) {
888                    return $s[ $part - 1 ];
889            } else {
890                    return @s;
891            }
892    }
893    
894  Convert strings from C<conf/normalize/*.xml> encoding into application  my $hash;
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
895    
896   my $text = $n->_x('normalize text string');  =head2 set
897    
898  This is a stub so that other modules doesn't have to implement it.    set( key => 'value' );
899    
900  =cut  =cut
901    
902  sub _x {  sub set {
903          my $self = shift;          my ($k,$v) = @_;
904          return shift;          warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
905  }          $hash->{$k} = $v;
906    };
907    
908    =head2 get
909    
910  =head1 AUTHOR    get( 'key' );
911    
912  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
913    
914  =head1 COPYRIGHT & LICENSE  sub get {
915            my $k = shift || return;
916            my $v = $hash->{$k};
917            warn "## get $k = ", dump( $v ), $/ if ( $debug );
918            return $v;
919    }
920    
921  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 count
922    
923  This program is free software; you can redistribute it and/or modify it    if ( count( @result ) == 1 ) {
924  under the same terms as Perl itself.          # do something if only 1 result is there
925      }
926    
927  =cut  =cut
928    
929  1; # End of WebPAC::Normalize  sub count {
930            warn "## count ",dump(@_),$/ if ( $debug );
931            return @_ . '';
932    }
933    
934    # END
935    1;

Legend:
Removed from v.317  
changed lines
  Added in v.1118

  ViewVC Help
Powered by ViewVC 1.1.26