/[webpac2]/trunk/lib/WebPAC/Normalize.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Normalize.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

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

  ViewVC Help
Powered by ViewVC 1.1.26