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

Legend:
Removed from v.74  
changed lines
  Added in v.1206

  ViewVC Help
Powered by ViewVC 1.1.26