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

Legend:
Removed from v.371  
changed lines
  Added in v.1210

  ViewVC Help
Powered by ViewVC 1.1.26