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

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

  ViewVC Help
Powered by ViewVC 1.1.26