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

Legend:
Removed from v.436  
changed lines
  Added in v.1037

  ViewVC Help
Powered by ViewVC 1.1.26