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

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

  ViewVC Help
Powered by ViewVC 1.1.26