/[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 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 Data::Dumper;  
   
 =head1 NAME  
27    
28  WebPAC::Normalize - normalisation of source file  #use base qw/WebPAC::Common/;
29    use Data::Dump qw/dump/;
30    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.01  WebPAC::Normalize - describe normalisaton rules using sets
52    
53  =cut  =cut
54    
55  our $VERSION = '0.01';  our $VERSION = '0.35';
56    
57  =head1 SYNOPSIS  =head1 SYNOPSIS
58    
59  This package contains code that could be helpful in implementing different  This module uses C<conf/normalize/*.pl> files to perform normalisation
60  normalisation front-ends.  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  =head1 FUNCTIONS  =head1 FUNCTIONS
72    
73  =head2 new  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    =head2 data_structure
77    
78  Create new normalisation object  Return data structure
79    
80    my $n = new WebPAC::Normalize::Something(    my $ds = WebPAC::Normalize::data_structure(
81          cache_data_structure => './cache/ds/',          lookup => $lookup_hash,
82          lookup_regex => $lookup->regex,          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  Optional parameter C<cache_data_structure> defines path to directory  Options C<row>, C<rules> and C<log> are mandatory while all
93  in which cache file for C<data_structure> call will be created.  other are optional.
94    
95  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
96  in structures.  die if it's not defined.
97    
98    This function will B<die> if normalizastion can't be evaled.
99    
100    Since this function isn't exported you have to call it with
101    C<WebPAC::Normalize::data_structure>.
102    
103  =cut  =cut
104    
105  sub new {  my $load_row_coderef;
106          my $class = shift;  
107          my $self = {@_};  sub data_structure {
108          bless($self, $class);          my $arg = {@_};
109    
110          $self->setup_cache_dir( $self->{'cache_data_structure'} );          die "need row argument" unless ($arg->{row});
111            die "need normalisation argument" unless ($arg->{rules});
112    
113          $self ? return $self : return undef;          _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            no strict 'subs';
120            no warnings 'redefine';
121            eval "$arg->{rules};";
122            die "error evaling $arg->{rules}: $@\n" if ($@);
123    
124            return _get_ds();
125  }  }
126    
127  =head2 setup_cache_dir  =head2 _set_ds
128    
129    Set current record hash
130    
131  Check if specified cache directory exist, and if not, disable caching.    _set_ds( $rec );
132    
133   $setup_cache_dir('./cache/ds/');  =cut
134    
135  If you pass false or zero value to this function, it will disable  my $rec;
136  cacheing.  
137    sub _set_ds {
138            $rec = shift or die "no record hash";
139            $WebPAC::Normalize::MARC::rec = $rec;
140    }
141    
142    =head2
143    
144      my $rec = _get_rec();
145    
146  =cut  =cut
147    
148  sub setup_cache_dir {  sub _get_rec { $rec };
         my $self = shift;  
149    
150          my $dir = shift;  =head2 _set_config
151    
152          my $log = $self->_get_logger();  Set current config hash
153    
154          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";  
                 }  
155    
156                  if ($msg) {  Magic keys are:
157                          undef $self->{'cache_data_structure'};  
158                          $log->warn("cache_data_structure $dir $msg, disabling...");  =over 4
159                  } else {  
160                          $log->debug("using cache dir $dir");  =item _
161                  }  
162          } else {  Code of current database
163                  $log->debug("disabling cache");  
164                  undef $self->{'cache_data_structure'};  =item _mfn
165          }  
166    Current MFN
167    
168    =back
169    
170    =cut
171    
172    my $config;
173    
174    sub _set_config {
175            $config = shift;
176  }  }
177    
178    =head2 _get_ds
179    
180  =head2 data_structure  Return hash formatted as data structure
181    
182      my $ds = _get_ds();
183    
184  Create in-memory data structure which represents normalized layout from  =cut
185  C<conf/normalize/*.xml>.  
186    my $out;
187    
188  This structures are used to produce output.  sub _get_ds {
189    #warn "## out = ",dump($out);
190            return $out;
191    }
192    
193   my @ds = $webpac->data_structure($rec);  =head2 _clean_ds
194    
195  B<Note: historical oddity follows>  Clean data structure hash for next record
196    
197  This method will also set C<< $webpac->{'currnet_filename'} >> if there is    _clean_ds();
 C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
 C<< <headline> >> tag.  
198    
199  =cut  =cut
200    
201  sub data_structure {  sub _clean_ds {
202          my $self = shift;          my $a = {@_};
203            $out = undef;
204            WebPAC::Normalize::MARC::_clean();
205    }
206    
207          my $log = $self->_get_logger();  =head2 _set_lookup
208    
209          my $rec = shift;  Set current lookup hash
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
210    
211          my $cache_file;    _set_lookup( $lookup );
212    
213          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'};  
                                         }  
                                 }  
                         }  
                 }  
         }  
214    
215          undef $self->{'currnet_filename'};  my $lookup;
         undef $self->{'headline'};  
216    
217          my @sorted_tags;  sub _set_lookup {
218          if ($self->{tags_by_order}) {          $lookup = shift;
219                  @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;  
         }  
220    
221          my @ds;  =head2 _get_lookup
222    
223          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  Get current lookup hash
224    
225          foreach my $field (@sorted_tags) {    my $lookup = _get_lookup();
226    
227                  my $row;  =cut
228    
229  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  sub _get_lookup {
230            return $lookup;
231    }
232    
233                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  =head2 _set_load_row
                         my $format = $tag->{'value'} || $tag->{'content'};  
234    
235                          $log->debug("format: $format");  Setup code reference which will return L<data_structure> from
236    L<WebPAC::Store>
237    
238                          my @v;    _set_load_row(sub {
239                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {                  my ($database,$input,$mfn) = @_;
240                                  @v = $self->fill_in_to_arr($rec,$format);                  $store->load_row( database => $database, input => $input, id => $mfn );
241                          } else {    });
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
242    
243                          if ($tag->{'sort'}) {  =cut
                                 @v = $self->sort_arr(@v);  
                         }  
244    
245                          # use format?  sub _set_load_row {
246                          if ($tag->{'format_name'}) {          my $coderef = shift;
247                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;          confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
                         }  
248    
249                          if ($field eq 'filename') {          $load_row_coderef = $coderef;
250                                  $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!  
                         }  
251    
252                          # delimiter will join repeatable fields  =head2 _debug
253                          if ($tag->{'delimiter'}) {  
254                                  @v = ( join($tag->{'delimiter'}, @v) );  Change level of debug warnings
255                          }  
256      _debug( 2 );
257    
258    =cut
259    
260    sub _debug {
261            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    =head1 Functions to create C<data_structure>
270    
271    Those functions generally have to first in your normalization file.
272    
273    =head2 search_display
274    
275    Define output for L<search> and L<display> at the same time
276    
277      search_display('Title', rec('200','a') );
278    
279    
280    =cut
281    
282    sub search_display {
283            my $name = shift or die "search_display needs name as first argument";
284            my @o = grep { defined($_) && $_ ne '' } @_;
285            return unless (@o);
286            $out->{$name}->{search} = \@o;
287            $out->{$name}->{display} = \@o;
288    }
289    
290    =head2 tag
291    
292    Old name for L<search_display>, but supported
293    
294    =cut
295    
296    sub tag {
297            search_display( @_ );
298    }
299    
300    =head2 display
301    
302    Define output just for I<display>
303    
304      @v = display('Title', rec('200','a') );
305    
306    =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    sub display { _field( 'display', @_ ) }
317    
318    =head2 search
319    
320    Prepare values just for I<search>
321    
322      @v = search('Title', rec('200','a') );
323    
324    =cut
325    
326    sub search { _field( 'search', @_ ) }
327    
328    =head2 sorted
329    
330    Insert into lists which will be automatically sorted
331    
332     sorted('Title', rec('200','a') );
333    
334    =cut
335    
336    sub sorted { _field( 'sorted', @_ ) }
337    
338    
339    
340    =head1 Functions to extract data from input
341    
342    This function should be used inside functions to create C<data_structure> described
343    above.
344    
345    =head2 _pack_subfields_hash
346    
347     @subfields = _pack_subfields_hash( $h );
348     $subfields = _pack_subfields_hash( $h, 1 );
349    
350    Return each subfield value in array or pack them all together and return scalar
351    with subfields (denoted by C<^>) and values.
352    
353    =cut
354    
355    sub _pack_subfields_hash {
356    
357            warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
358    
359                          # default types          my ($h,$include_subfields) = @_;
                         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;  
360    
361            # sanity and ease of use
362            return $h if (ref($h) ne 'HASH');
363    
364            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                                    push @out, $h->{$sf};
376                            } else {
377    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
378                                    push @out, $h->{$sf}->[$o];
379                            }
380                    }
381                    if ($include_subfields) {
382                            return join('', @out);
383                    } else {
384                            return @out;
385                    }
386            } else {
387                    if ($include_subfields) {
388                            my $out = '';
389                            foreach my $sf (sort keys %$h) {
390                                    if (ref($h->{$sf}) eq 'ARRAY') {
391                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
392                                  } else {                                  } else {
393                                          push @{$row->{$type}}, @v;                                          $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                    }
401            }
402    }
403    
404    =head2 rec1
405    
406                  }  Return all values in some field
407    
408      @v = rec1('200')
409    
410                  if ($row) {  TODO: order of values is probably same as in source data, need to investigate that
                         $row->{'tag'} = $field;  
411    
412                          # TODO: name_sigular, name_plural  =cut
413                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
414                          $row->{'name'} = $name ? $self->_x($name) : $field;  sub rec1 {
415            my $f = shift;
416                          # post-sort all values in field          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
417                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {          return unless (defined($rec) && defined($rec->{$f}));
418                                  $log->warn("sort at field tag not implemented");          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
419            if (ref($rec->{$f}) eq 'ARRAY') {
420                    my @out;
421                    foreach my $h ( @{ $rec->{$f} } ) {
422                            if (ref($h) eq 'HASH') {
423                                    push @out, ( _pack_subfields_hash( $h ) );
424                            } else {
425                                    push @out, $h;
426                          }                          }
427                    }
428                    return @out;
429            } elsif( defined($rec->{$f}) ) {
430                    return $rec->{$f};
431            }
432    }
433    
434    =head2 rec2
435    
436    Return all values in specific field and subfield
437    
438                          push @ds, $row;    @v = rec2('200','a')
439    
440                          $log->debug("row $field: ",sub { Dumper($row) });  =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 rec
457    
458    syntaxtic sugar for
459    
460      @v = rec('200')
461      @v = rec('200','a')
462    
463          if ($cache_file) {  If rec() returns just single value, it will
464                  store {  return scalar, not array.
465                          ds => \@ds,  
466                          current_filename => $self->{'current_filename'},  =cut
467                          headline => $self->{'headline'},  
468                  }, $cache_file;  sub rec {
469                  $log->debug("created storable cache file $cache_file");          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    =head2 frec
485    
486          return @ds;  Returns first value from field
487    
488      $v = frec('200');
489      $v = frec('200','a');
490    
491    =cut
492    
493    sub frec {
494            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  =head2 apply_format  =head2 frec_eq
500    
501    =head2 frec_ne
502    
503  Apply format specified in tag with C<format_name="name"> and  Check if first values from two fields are same or different
 C<format_delimiter=";;">.  
504    
505   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
506            # values are same
507      } else {
508        # values are different
509      }
510    
511  Formats can contain C<lookup{...}> if you need them.  Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
512    could write something like:
513    
514      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
515            # yada tada
516      }
517    
518    but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
519    in order to parse text and create invalid function C<eqfrec>.
520    
521  =cut  =cut
522    
523  sub apply_format {  sub frec_eq {
524          my $self = shift;          my ( $f1,$sf1, $f2, $sf2 ) = @_;
525            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
526    }
527    
528    sub frec_ne {
529            return ! frec_eq( @_ );
530    }
531    
532    =head2 regex
533    
534          my ($name,$delimiter,$data) = @_;  Apply regex to some or all values
535    
536          my $log = $self->_get_logger();    @v = regex( 's/foo/bar/g', @v );
537    
538          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =cut
539                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
540                  return $data;  sub regex {
541            my $r = shift;
542            my @out;
543            #warn "r: $r\n", dump(\@_);
544            foreach my $t (@_) {
545                    next unless ($t);
546                    eval "\$t =~ $r";
547                    push @out, $t if ($t && $t ne '');
548          }          }
549            return @out;
550    }
551    
552          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 prefix
553    
554          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Prefix all values with a string
555    
556          my @data = split(/\Q$delimiter\E/, $data);    @v = prefix( 'my_', @v );
557    
558          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
559    
560          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub prefix {
561                  return $self->lookup($out);          my $p = shift;
562          } else {          return @_ unless defined( $p );
563                  return $out;          return map { $p . $_ } grep { defined($_) } @_;
564          }  }
565    
566    =head2 suffix
567    
568    suffix all values with a string
569    
570      @v = suffix( '_my', @v );
571    
572    =cut
573    
574    sub suffix {
575            my $s = shift;
576            return @_ unless defined( $s );
577            return map { $_ . $s } grep { defined($_) } @_;
578  }  }
579    
580  =head2 parse  =head2 surround
581    
582  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.  
583    
584   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    @v = surround( 'prefix_', '_suffix', @v );
585    
586  =cut  =cut
587    
588  sub parse {  sub surround {
589          my $self = shift;          my $p = shift;
590            my $s = shift;
591            $p = '' unless defined( $p );
592            $s = '' unless defined( $s );
593            return map { $p . $_ . $s } grep { defined($_) } @_;
594    }
595    
596          my ($rec, $format_utf8, $i) = @_;  =head2 first
597    
598          return if (! $format_utf8);  Return first element
599    
600          my $log = $self->_get_logger();    $v = first( @v );
601    
602          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =cut
603    
604          $i = 0 if (! $i);  sub first {
605            my $r = shift;
606            return $r;
607    }
608    
609          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head2 lookup
610    
611          my @out;  Consult lookup hashes for some value
612    
613          $log->debug("format: $format");    @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 $eval_code;  Code like above will be B<automatically generated> using L<WebPAC::Parse> from
624          # remove eval{...} from beginning  normal lookup definition in C<conf/lookup/something.pl> which looks like:
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
625    
626          my $filter_name;    lookup(
627          # remove filter{...} from beginning          # which results to return from record recorded in lookup
628          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);          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          my $prefix;  You can think about this lookup as SQL (if that helps):
         my $all_found=0;  
640    
641          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {    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                  my $del = $1 || '';  Easy as pie, right?
                 $prefix ||= $del if ($all_found == 0);  
651    
652                  # repeatable index  =cut
653                  my $r = $i;  
654                  $r = 0 if (lc("$2") eq 's');  sub lookup {
655            my ($what, $database, $input, $key, $having) = @_;
656    
657            confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
658    
659            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
660            return unless (defined($lookup->{$database}->{$input}->{$key}));
661    
662                  my $found = 0;          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
663    
664                  if ($found) {          my $mfns;
665                          push @out, $del;          my @having = $having->();
666                          push @out, $tmp;  
667                          $all_found += $found;          warn "## having = ", dump( @having ) if ($debug > 2);
668    
669            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          return if (! $all_found);          return unless ($mfns);
677    
678          my $out = join('',@out);          my @mfns = sort keys %$mfns;
679    
680          if ($out) {          warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
                 # add rest of format (suffix)  
                 $out .= $format;  
681    
682                  # add prefix if not there          my $old_rec = $rec;
683                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my @out;
684    
685                  $log->debug("result: $out");          foreach my $mfn (@mfns) {
686          }                  $rec = $load_row_coderef->( $database, $input, $mfn );
687    
688          if ($eval_code) {                  warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
689                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
690                  $log->debug("about to eval{$eval} format: $out");                  my @vals = $what->();
691                  return if (! $self->_eval($eval));  
692          }                  push @out, ( @vals );
693            
694          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");  
695          }          }
696    
697          return $out;  #       if (ref($lookup->{$k}) eq 'ARRAY') {
698    #               return @{ $lookup->{$k} };
699    #       } else {
700    #               return $lookup->{$k};
701    #       }
702    
703            $rec = $old_rec;
704    
705            warn "## lookup returns = ", dump(@out), $/ if ($debug);
706    
707            if ($#out == 0) {
708                    return $out[0];
709            } else {
710                    return @out;
711            }
712  }  }
713    
714  =head2 parse_to_arr  =head2 save_into_lookup
715    
716  Similar to C<parse>, but returns array of all repeatable fields  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   my @arr = $webpac->parse_to_arr($rec,'v250^a');  MFN will be extracted from first occurence current of field 000
721    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
722    
723  =cut    my $nr = save_into_lookup($database,$input,$key,sub {
724            # code which produce one or more values
725      });
726    
727  sub parse_to_arr {  It returns number of items saved.
         my $self = shift;  
728    
729          my ($rec, $format_utf8) = @_;  This function shouldn't be called directly, it's called from code created by
730    L<WebPAC::Parser>.
731    
732          my $log = $self->_get_logger();  =cut
733    
734          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  sub save_into_lookup {
735          return if (! $format_utf8);          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          my $i = 0;          warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
         my @arr;  
742    
743          while (my $v = $self->parse($rec,$format_utf8,$i++)) {          my $mfn =
744                  push @arr, $v;                  defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
745          }                  defined($config->{_mfn})        ?       $config->{_mfn}         :
746                                                                                    die "mfn not defined or zero";
747    
748          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          my $nr = 0;
749    
750          return @arr;          foreach my $v ( $coderef->() ) {
751                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
752                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
753                    $nr++;
754            }
755    
756            return $nr;
757  }  }
758    
759  =head2 fill_in_to_arr  =head2 config
760    
761  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  Consult config values stored in C<config.yml>
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
762    
763   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    # 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    Up to three levels are supported.
769    
770  =cut  =cut
771    
772  sub fill_in_to_arr {  sub config {
773          my $self = shift;          return unless ($config);
774    
775            my $p = shift;
776    
777            $p ||= '';
778    
779            my $v;
780    
781            warn "### getting config($p)\n" if ($debug > 1);
782    
783          my ($rec, $format_utf8) = @_;          my @p = split(/\s+/,$p);
784            if ($#p < 0) {
785                    $v = $config->{ '_' };  # special, database code
786            } else {
787    
788          my $log = $self->_get_logger();                  my $c = dclone( $config );
789    
790          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  foreach my $k (@p) {
791          return if (! $format_utf8);                          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          my $i = 0;                          if (! defined($c->{$k}) ) {
799          my @arr;                                  $c = undef;
800                                    last;
801                            } else {
802                                    $c = $c->{$k};
803                            }
804                    }
805                    $v = $c if ($c);
806    
         while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  
                 push @arr, @v;  
807          }          }
808    
809          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
810            warn "config( '$p' ) is empty\n" if (! $v);
811    
812          return @arr;          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    Split record subfield on some regex and take one of parts out
849    
850      $a_before_semi_column =
851            split_rec_on('200','a', /\s*;\s*/, $part);
852    
853  =head2 _sort_by_order  C<$part> is optional number of element. First element is
854    B<1>, not 0!
855    
856  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
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> encoding into application specific  my $hash;
 (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::DB  sub count {
918            warn "## count ",dump(@_),$/ if ( $debug );
919            return @_ . '';
920    }
921    
922    # END
923    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26