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

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

  ViewVC Help
Powered by ViewVC 1.1.26