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

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

  ViewVC Help
Powered by ViewVC 1.1.26