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

Legend:
Removed from v.14  
changed lines
  Added in v.1118

  ViewVC Help
Powered by ViewVC 1.1.26