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

Legend:
Removed from v.372  
changed lines
  Added in v.1205

  ViewVC Help
Powered by ViewVC 1.1.26