/[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 13 by dpavlin, Sat Jul 16 23:56:14 2005 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 Data::Dumper;  
   
 =head1 NAME  
28    
29  WebPAC::Normalize - normalisation of source file  #use base qw/WebPAC::Common/;
30    use Data::Dump qw/dump/;
31    use Carp qw/confess/;
32    
33    # debugging warn(s)
34    my $debug = 0;
35    _debug( $debug );
36    
37    # FIXME
38    use WebPAC::Normalize::ISBN;
39    push @EXPORT, ( 'isbn_10', 'isbn_13' );
40    
41    use WebPAC::Normalize::MARC;
42    push @EXPORT, ( qw/
43            marc marc_indicators marc_repeatable_subfield
44            marc_compose marc_leader marc_fixed
45            marc_duplicate marc_remove marc_count
46            marc_original_order
47            marc_template
48    /);
49    
50  =head1 VERSION  =head1 NAME
51    
52  Version 0.01  WebPAC::Normalize - describe normalisaton rules using sets
53    
54  =cut  =cut
55    
56  our $VERSION = '0.01';  our $VERSION = '0.36';
57    
58  =head1 SYNOPSIS  =head1 SYNOPSIS
59    
60  This package contains code that could be helpful in implementing different  This module uses C<conf/normalize/*.pl> files to perform normalisation
61  normalisation front-ends.  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  =head1 FUNCTIONS  =head1 FUNCTIONS
73    
74  =head2 new  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    =head2 data_structure
78    
79  Create new normalisation object  Return data structure
80    
81    my $n = new WebPAC::Normalize::Something(    my $ds = WebPAC::Normalize::data_structure(
82          cache_data_structure => './cache/ds/',          lookup => $lookup_hash,
83          lookup_regex => $lookup->regex,          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  Optional parameter C<cache_data_structure> defines path to directory  Options C<row>, C<rules> and C<log> are mandatory while all
94  in which cache file for C<data_structure> call will be created.  other are optional.
95    
96  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  C<load_row_coderef> is closure only used when executing lookups, so they will
97  in structures.  die if it's not defined.
98    
99    This function will B<die> if normalizastion can't be evaled.
100    
101    Since this function isn't exported you have to call it with
102    C<WebPAC::Normalize::data_structure>.
103    
104  =cut  =cut
105    
106  sub new {  my $load_row_coderef;
107          my $class = shift;  
108          my $self = {@_};  sub data_structure {
109          bless($self, $class);          my $arg = {@_};
110    
111          $self->setup_cache_dir( $self->{'cache_data_structure'} );          die "need row argument" unless ($arg->{row});
112            die "need normalisation argument" unless ($arg->{rules});
113    
114          $self ? return $self : return undef;          _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            no strict 'subs';
121            no warnings 'redefine';
122            eval "$arg->{rules};";
123            die "error evaling $arg->{rules}: $@\n" if ($@);
124    
125            return _get_ds();
126  }  }
127    
128  =head2 setup_cache_dir  =head2 _set_ds
129    
130    Set current record hash
131    
132  Check if specified cache directory exist, and if not, disable caching.    _set_ds( $rec );
133    
134   $setup_cache_dir('./cache/ds/');  =cut
135    
136  If you pass false or zero value to this function, it will disable  my $rec;
137  cacheing.  
138    sub _set_ds {
139            $rec = shift or die "no record hash";
140            $WebPAC::Normalize::MARC::rec = $rec;
141    }
142    
143    =head2
144    
145      my $rec = _get_rec();
146    
147  =cut  =cut
148    
149  sub setup_cache_dir {  sub _get_rec { $rec };
         my $self = shift;  
150    
151          my $dir = shift;  =head2 _set_config
152    
153          my $log = $self->_get_logger();  Set current config hash
154    
155          if ($dir) {    _set_config( $config );
                 my $msg;  
                 if (! -e $dir) {  
                         $msg = "doesn't exist";  
                 } elsif (! -d $dir) {  
                         $msg = "is not directory";  
                 } elsif (! -w $dir) {  
                         $msg = "not writable";  
                 }  
156    
157                  if ($msg) {  Magic keys are:
158                          undef $self->{'cache_data_structure'};  
159                          $log->warn("cache_data_structure $dir $msg, disabling...");  =over 4
160                  } else {  
161                          $log->debug("using cache dir $dir");  =item _
162                  }  
163          } else {  Code of current database
164                  $log->debug("disabling cache");  
165                  undef $self->{'cache_data_structure'};  =item _mfn
166          }  
167    Current MFN
168    
169    =back
170    
171    =cut
172    
173    my $config;
174    
175    sub _set_config {
176            $config = shift;
177  }  }
178    
179    =head2 _get_ds
180    
181  =head2 data_structure  Return hash formatted as data structure
182    
183  Create in-memory data structure which represents normalized layout from    my $ds = _get_ds();
 C<conf/normalize/*.xml>.  
184    
185  This structures are used to produce output.  =cut
186    
187   my @ds = $webpac->data_structure($rec);  my $out;
188    
189  B<Note: historical oddity follows>  sub _get_ds {
190    #warn "## out = ",dump($out);
191            return $out;
192    }
193    
194    =head2 _clean_ds
195    
196  This method will also set C<< $webpac->{'currnet_filename'} >> if there is  Clean data structure hash for next record
197  C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
198  C<< <headline> >> tag.    _clean_ds();
199    
200  =cut  =cut
201    
202  sub data_structure {  sub _clean_ds {
203          my $self = shift;          my $a = {@_};
204            $out = undef;
205            WebPAC::Normalize::MARC::_clean();
206    }
207    
208          my $log = $self->_get_logger();  =head2 _set_lookup
209    
210          my $rec = shift;  Set current lookup hash
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
211    
212          my $cache_file;    _set_lookup( $lookup );
213    
214          if (my $cache_path = $self->{'cache_data_structure'}) {  =cut
                 my $id = $rec->{'000'};  
                 $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);  
                 unless (defined($id)) {  
                         $log->warn("Can't use cache_data_structure on records without unique identifier in field 000");  
                         undef $self->{'cache_data_structure'};  
                 } else {  
                         $cache_file = "$cache_path/$id";  
                         if (-r $cache_file) {  
                                 my $ds_ref = retrieve($cache_file);  
                                 if ($ds_ref) {  
                                         $log->debug("cache hit: $cache_file");  
                                         my $ok = 1;  
                                         foreach my $f (qw(current_filename headline)) {  
                                                 if ($ds_ref->{$f}) {  
                                                         $self->{$f} = $ds_ref->{$f};  
                                                 } else {  
                                                         $ok = 0;  
                                                 }  
                                         };  
                                         if ($ok && $ds_ref->{'ds'}) {  
                                                 return @{ $ds_ref->{'ds'} };  
                                         } else {  
                                                 $log->warn("cache_data_structure $cache_path corrupt. Use rm $cache_path/* to re-create it on next run!");  
                                                 undef $self->{'cache_data_structure'};  
                                         }  
                                 }  
                         }  
                 }  
         }  
215    
216          undef $self->{'currnet_filename'};  my $lookup;
         undef $self->{'headline'};  
217    
218          my @sorted_tags;  sub _set_lookup {
219          if ($self->{tags_by_order}) {          $lookup = shift;
220                  @sorted_tags = @{$self->{tags_by_order}};  }
         } else {  
                 @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
                 $self->{tags_by_order} = \@sorted_tags;  
         }  
221    
222          my @ds;  =head2 _get_lookup
223    
224          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  Get current lookup hash
225    
226          foreach my $field (@sorted_tags) {    my $lookup = _get_lookup();
227    
228                  my $row;  =cut
229    
230  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  sub _get_lookup {
231            return $lookup;
232    }
233    
234                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  =head2 _set_load_row
                         my $format = $tag->{'value'} || $tag->{'content'};  
235    
236                          $log->debug("format: $format");  Setup code reference which will return L<data_structure> from
237    L<WebPAC::Store>
238    
239                          my @v;    _set_load_row(sub {
240                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {                  my ($database,$input,$mfn) = @_;
241                                  @v = $self->fill_in_to_arr($rec,$format);                  $store->load_row( database => $database, input => $input, id => $mfn );
242                          } else {    });
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
243    
244                          if ($tag->{'sort'}) {  =cut
                                 @v = $self->sort_arr(@v);  
                         }  
245    
246                          # use format?  sub _set_load_row {
247                          if ($tag->{'format_name'}) {          my $coderef = shift;
248                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;          confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
                         }  
249    
250                          if ($field eq 'filename') {          $load_row_coderef = $coderef;
251                                  $self->{'current_filename'} = join('',@v);  }
                                 $log->debug("filename: ",$self->{'current_filename'});  
                         } elsif ($field eq 'headline') {  
                                 $self->{'headline'} .= join('',@v);  
                                 $log->debug("headline: ",$self->{'headline'});  
                                 next; # don't return headline in data_structure!  
                         }  
252    
253                          # delimiter will join repeatable fields  =head2 _debug
254                          if ($tag->{'delimiter'}) {  
255                                  @v = ( join($tag->{'delimiter'}, @v) );  Change level of debug warnings
256                          }  
257      _debug( 2 );
258    
259    =cut
260    
261    sub _debug {
262            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    =head1 Functions to create C<data_structure>
270    
271    Those functions generally have to first in your normalization file.
272    
273    =head2 to
274    
275    Generic way to set values for some name
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    =cut
282    
283    sub to {
284            my $type = shift or confess "need type -- BUG?";
285            my $name = shift or confess "needs name as first argument";
286            my @o = grep { defined($_) && $_ ne '' } @_;
287            return unless (@o);
288            $out->{$name}->{$type} = \@o;
289    }
290    
291    =head2 search_display
292    
293    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    sub search_display {
300            my $name = shift or die "search_display needs name as first argument";
301            my @o = grep { defined($_) && $_ ne '' } @_;
302            return unless (@o);
303            $out->{$name}->{search} = \@o;
304            $out->{$name}->{display} = \@o;
305    }
306    
307    =head2 tag
308    
309    Old name for L<search_display>, it will probably be removed at one point.
310    
311    =cut
312    
313    sub tag {
314            search_display( @_ );
315    }
316    
317    =head2 display
318    
319    Define output just for I<display>
320    
321      @v = display('Title', rec('200','a') );
322    
323    =cut
324    
325    sub display { to( 'display', @_ ) }
326    
327    =head2 search
328    
329    Prepare values just for I<search>
330    
331      @v = search('Title', rec('200','a') );
332    
333    =cut
334    
335    sub search { to( 'search', @_ ) }
336    
337    =head2 sorted
338    
339    Insert into lists which will be automatically sorted
340    
341     sorted('Title', rec('200','a') );
342    
343    =cut
344    
345    sub sorted { to( 'sorted', @_ ) }
346    
347    
348    =head1 Functions to extract data from input
349    
350    This function should be used inside functions to create C<data_structure> described
351    above.
352    
353    =head2 _pack_subfields_hash
354    
355     @subfields = _pack_subfields_hash( $h );
356     $subfields = _pack_subfields_hash( $h, 1 );
357    
358    Return each subfield value in array or pack them all together and return scalar
359    with subfields (denoted by C<^>) and values.
360    
361    =cut
362    
363                          # default types  sub _pack_subfields_hash {
                         my @types = qw(display swish);  
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $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;  
364    
365            warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
366    
367            my ($h,$include_subfields) = @_;
368    
369            # sanity and ease of use
370            return $h if (ref($h) ne 'HASH');
371    
372            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                                    push @out, $h->{$sf};
384                            } else {
385    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
386                                    push @out, $h->{$sf}->[$o];
387                            }
388                    }
389                    if ($include_subfields) {
390                            return join('', @out);
391                    } else {
392                            return @out;
393                    }
394            } else {
395                    if ($include_subfields) {
396                            my $out = '';
397                            foreach my $sf (sort keys %$h) {
398                                    if (ref($h->{$sf}) eq 'ARRAY') {
399                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
400                                  } else {                                  } else {
401                                          push @{$row->{$type}}, @v;                                          $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                    }
409            }
410    }
411    
412    =head2 rec1
413    
414                  }  Return all values in some field
415    
416                  if ($row) {    @v = rec1('200')
                         $row->{'tag'} = $field;  
417    
418                          # TODO: name_sigular, name_plural  TODO: order of values is probably same as in source data, need to investigate that
419                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
420                          $row->{'name'} = $name ? $self->_x($name) : $field;  =cut
421    
422                          # post-sort all values in field  sub rec1 {
423                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {          my $f = shift;
424                                  $log->warn("sort at field tag not implemented");          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
425            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                    my @out;
429                    foreach my $h ( @{ $rec->{$f} } ) {
430                            if (ref($h) eq 'HASH') {
431                                    push @out, ( _pack_subfields_hash( $h ) );
432                            } else {
433                                    push @out, $h;
434                          }                          }
435                    }
436                    return @out;
437            } elsif( defined($rec->{$f}) ) {
438                    return $rec->{$f};
439            }
440    }
441    
442                          push @ds, $row;  =head2 rec2
443    
444                          $log->debug("row $field: ",sub { Dumper($row) });  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 rec
465    
466          if ($cache_file) {  syntaxtic sugar for
467                  store {  
468                          ds => \@ds,    @v = rec('200')
469                          current_filename => $self->{'current_filename'},    @v = rec('200','a')
470                          headline => $self->{'headline'},  
471                  }, $cache_file;  If rec() returns just single value, it will
472                  $log->debug("created storable cache file $cache_file");  return scalar, not array.
473    
474    =cut
475    
476    sub rec {
477            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          return @ds;  =head2 frec
493    
494    Returns first value from field
495    
496      $v = frec('200');
497      $v = frec('200','a');
498    
499    =cut
500    
501    sub frec {
502            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  =head2 apply_format  =head2 frec_eq
508    
509    =head2 frec_ne
510    
511    Check if first values from two fields are same or different
512    
513      if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
514            # values are same
515      } else {
516        # values are different
517      }
518    
519  Apply format specified in tag with C<format_name="name"> and  Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
520  C<format_delimiter=";;">.  could write something like:
521    
522   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    if ( frec( '900','a' ) eq frec( '910','c' ) ) {
523            # yada tada
524      }
525    
526  Formats can contain C<lookup{...}> if you need them.  but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
527    in order to parse text and create invalid function C<eqfrec>.
528    
529  =cut  =cut
530    
531  sub apply_format {  sub frec_eq {
532          my $self = shift;          my ( $f1,$sf1, $f2, $sf2 ) = @_;
533            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
534    }
535    
536    sub frec_ne {
537            return ! frec_eq( @_ );
538    }
539    
540    =head2 regex
541    
542          my ($name,$delimiter,$data) = @_;  Apply regex to some or all values
543    
544          my $log = $self->_get_logger();    @v = regex( 's/foo/bar/g', @v );
545    
546          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =cut
547                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
548                  return $data;  sub regex {
549            my $r = shift;
550            my @out;
551            #warn "r: $r\n", dump(\@_);
552            foreach my $t (@_) {
553                    next unless ($t);
554                    eval "\$t =~ $r";
555                    push @out, $t if ($t && $t ne '');
556          }          }
557            return @out;
558    }
559    
560          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 prefix
561    
562          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Prefix all values with a string
563    
564          my @data = split(/\Q$delimiter\E/, $data);    @v = prefix( 'my_', @v );
565    
566          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
567    
568          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub prefix {
569                  return $self->lookup($out);          my $p = shift;
570          } else {          return @_ unless defined( $p );
571                  return $out;          return map { $p . $_ } grep { defined($_) } @_;
572          }  }
573    
574    =head2 suffix
575    
576    suffix all values with a string
577    
578      @v = suffix( '_my', @v );
579    
580    =cut
581    
582    sub suffix {
583            my $s = shift;
584            return @_ unless defined( $s );
585            return map { $_ . $s } grep { defined($_) } @_;
586  }  }
587    
588  =head2 parse  =head2 surround
589    
590  Perform smart parsing of string, skipping delimiters for fields which aren't  surround all values with a two strings
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
591    
592   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    @v = surround( 'prefix_', '_suffix', @v );
593    
594  =cut  =cut
595    
596  sub parse {  sub surround {
597          my $self = shift;          my $p = shift;
598            my $s = shift;
599            $p = '' unless defined( $p );
600            $s = '' unless defined( $s );
601            return map { $p . $_ . $s } grep { defined($_) } @_;
602    }
603    
604          my ($rec, $format_utf8, $i) = @_;  =head2 first
605    
606          return if (! $format_utf8);  Return first element
607    
608          my $log = $self->_get_logger();    $v = first( @v );
609    
610          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =cut
611    
612          $i = 0 if (! $i);  sub first {
613            my $r = shift;
614            return $r;
615    }
616    
617          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head2 lookup
618    
619          my @out;  Consult lookup hashes for some value
620    
621          $log->debug("format: $format");    @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    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      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    You can think about this lookup as SQL (if that helps):
648    
649          my $eval_code;    select
650          # remove eval{...} from beginning          sub { what }
651          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);    from
652            database, input
653      where
654        sub { filter from lookuped record }
655      having
656        sub { optional filter on current record }
657    
658    Easy as pie, right?
659    
660    =cut
661    
662          my $filter_name;  sub lookup {
663          # remove filter{...} from beginning          my ($what, $database, $input, $key, $having) = @_;
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
664    
665          my $prefix;          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
         my $all_found=0;  
666    
667          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {          warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
668            return unless (defined($lookup->{$database}->{$input}->{$key}));
669    
670                  my $del = $1 || '';          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
                 $prefix ||= $del if ($all_found == 0);  
671    
672                  # repeatable index          my $mfns;
673                  my $r = $i;          my @having = $having->();
                 $r = 0 if (lc("$2") eq 's');  
674    
675                  my $found = 0;          warn "## having = ", dump( @having ) if ($debug > 2);
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
676    
677                  if ($found) {          foreach my $h ( @having ) {
678                          push @out, $del;                  if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
679                          push @out, $tmp;                          warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
680                          $all_found += $found;                          $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
681                  }                  }
682          }          }
683    
684          return if (! $all_found);          return unless ($mfns);
685    
686          my $out = join('',@out);          my @mfns = sort keys %$mfns;
687    
688          if ($out) {          warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
                 # add rest of format (suffix)  
                 $out .= $format;  
689    
690                  # add prefix if not there          my $old_rec = $rec;
691                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my @out;
692    
693                  $log->debug("result: $out");          foreach my $mfn (@mfns) {
694          }                  $rec = $load_row_coderef->( $database, $input, $mfn );
695    
696          if ($eval_code) {                  warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
697                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
698                  $log->debug("about to eval{$eval} format: $out");                  my @vals = $what->();
699                  return if (! $self->_eval($eval));  
700          }                  push @out, ( @vals );
701            
702          if ($filter_name && $self->{'filter'}->{$filter_name}) {                  warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
                 $log->debug("about to filter{$filter_name} format: $out");  
                 $out = $self->{'filter'}->{$filter_name}->($out);  
                 return unless(defined($out));  
                 $log->debug("filter result: $out");  
703          }          }
704    
705          return $out;  #       if (ref($lookup->{$k}) eq 'ARRAY') {
706    #               return @{ $lookup->{$k} };
707    #       } else {
708    #               return $lookup->{$k};
709    #       }
710    
711            $rec = $old_rec;
712    
713            warn "## lookup returns = ", dump(@out), $/ if ($debug);
714    
715            if ($#out == 0) {
716                    return $out[0];
717            } else {
718                    return @out;
719            }
720  }  }
721    
722  =head2 parse_to_arr  =head2 save_into_lookup
723    
724  Similar to C<parse>, but returns array of all repeatable fields  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   my @arr = $webpac->parse_to_arr($rec,'v250^a');  MFN will be extracted from first occurence current of field 000
729    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
730    
731  =cut    my $nr = save_into_lookup($database,$input,$key,sub {
732            # code which produce one or more values
733      });
734    
735    It returns number of items saved.
736    
737  sub parse_to_arr {  This function shouldn't be called directly, it's called from code created by
738          my $self = shift;  L<WebPAC::Parser>.
739    
740          my ($rec, $format_utf8) = @_;  =cut
741    
742          my $log = $self->_get_logger();  sub save_into_lookup {
743            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          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
         return if (! $format_utf8);  
750    
751          my $i = 0;          my $mfn =
752          my @arr;                  defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
753                    defined($config->{_mfn})        ?       $config->{_mfn}         :
754                                                                                    die "mfn not defined or zero";
755    
756          while (my $v = $self->parse($rec,$format_utf8,$i++)) {          my $nr = 0;
                 push @arr, $v;  
         }  
757    
758          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          foreach my $v ( $coderef->() ) {
759                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
760                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
761                    $nr++;
762            }
763    
764          return @arr;          return $nr;
765  }  }
766    
767  =head2 fill_in_to_arr  =head2 config
768    
769    Consult config values stored in C<config.yml>
770    
771  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    # return database code (key under databases in yaml)
772  for fields which have lookups, so they shouldn't be parsed but rather    $database_code = config();    # use _ from hash
773  C<fill_id>ed.    $database_name = config('name');
774      $database_input_name = config('input name');
775    
776   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  Up to three levels are supported.
777    
778  =cut  =cut
779    
780  sub fill_in_to_arr {  sub config {
781          my $self = shift;          return unless ($config);
782    
783          my ($rec, $format_utf8) = @_;          my $p = shift;
784    
785          my $log = $self->_get_logger();          $p ||= '';
786    
787          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          my $v;
         return if (! $format_utf8);  
788    
789          my $i = 0;          warn "### getting config($p)\n" if ($debug > 1);
790          my @arr;  
791            my @p = split(/\s+/,$p);
792            if ($#p < 0) {
793                    $v = $config->{ '_' };  # special, database code
794            } else {
795    
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    
         while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  
                 push @arr, @v;  
815          }          }
816    
817          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
818            warn "config( '$p' ) is empty\n" if (! $v);
819    
820          return @arr;          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          my $log = $self->_get_logger();  =head2 join_with
839    
840          # FIXME add Schwartzian Transformation?  Joins walues with some delimiter
841    
842          my @sorted = sort {    $v = join_with(", ", @v);
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
843    
844          return @sorted;  =cut
845    
846    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    Split record subfield on some regex and take one of parts out
857    
858      $a_before_semi_column =
859            split_rec_on('200','a', /\s*;\s*/, $part);
860    
861  =head2 _sort_by_order  C<$part> is optional number of element. First element is
862    B<1>, not 0!
863    
864  Sort xml tags data structure accoding to C<order=""> attribute.  If there is no C<$part> parameter or C<$part> is 0, this function will
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> encoding into application specific  my $hash;
 (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::DB  sub count {
926            warn "## count ",dump(@_),$/ if ( $debug );
927            return @_ . '';
928    }
929    
930    # END
931    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26