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

Legend:
Removed from v.29  
changed lines
  Added in v.1048

  ViewVC Help
Powered by ViewVC 1.1.26