/[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 15 by dpavlin, Sun Jul 17 10:42:23 2005 UTC revision 831 by dpavlin, Wed May 23 20:03:14 2007 UTC
# Line 1  Line 1 
1  package WebPAC::Normalize;  package WebPAC::Normalize;
2    use Exporter 'import';
3    @EXPORT = qw/
4            _set_rec _set_lookup
5            _set_load_row
6            _get_ds _clean_ds
7            _debug
8            _pack_subfields_hash
9    
10            tag search display
11            marc marc_indicators marc_repeatable_subfield
12            marc_compose marc_leader marc_fixed
13            marc_duplicate marc_remove marc_count
14            marc_original_order
15    
16            rec1 rec2 rec
17            regex prefix suffix surround
18            first lookup join_with
19            save_into_lookup
20    
21            split_rec_on
22    
23            get set
24            count
25    /;
26    
27  use warnings;  use warnings;
28  use strict;  use strict;
29  use Data::Dumper;  
30  use Storable;  #use base qw/WebPAC::Common/;
31    use Data::Dump qw/dump/;
32    use Storable qw/dclone/;
33    use Carp qw/confess/;
34    
35    # debugging warn(s)
36    my $debug = 0;
37    
38    
39  =head1 NAME  =head1 NAME
40    
41  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
42    
43  =head1 VERSION  =head1 VERSION
44    
45  Version 0.01  Version 0.29
46    
47  =cut  =cut
48    
49  our $VERSION = '0.01';  our $VERSION = '0.29';
50    
51  =head1 SYNOPSIS  =head1 SYNOPSIS
52    
53  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
54    from input records using perl functions which are specialized for set
55    processing.
56    
57    Sets are implemented as arrays, and normalisation file is valid perl, which
58    means that you check it's validity before running WebPAC using
59    C<perl -c normalize.pl>.
60    
61    Normalisation can generate multiple output normalized data. For now, supported output
62    types (on the left side of definition) are: C<tag>, C<display>, C<search> and
63    C<marc>.
64    
65    =head1 FUNCTIONS
66    
67    Functions which start with C<_> are private and used by WebPAC internally.
68    All other functions are available for use within normalisation rules.
69    
70    =head2 data_structure
71    
72    Return data structure
73    
74      my $ds = WebPAC::Normalize::data_structure(
75            lookup => $lookup_hash,
76            row => $row,
77            rules => $normalize_pl_config,
78            marc_encoding => 'utf-8',
79            config => $config,
80            load_row_coderef => sub {
81                    my ($database,$input,$mfn) = shift;
82                    $store->load_row( database => $database, input => $input, id => $mfn );
83            },
84      );
85    
86    Options C<row>, C<rules> and C<log> are mandatory while all
87    other are optional.
88    
89    C<load_row_coderef> is closure only used when executing lookups, so they will
90    die if it's not defined.
91    
92  It contains several assumptions:  This function will B<die> if normalizastion can't be evaled.
93    
94  =over  Since this function isn't exported you have to call it with
95    C<WebPAC::Normalize::data_structure>.
96    
97  =item *  =cut
98    
99  format of fields is defined using C<v123^a> notation for repeatable fields  my $load_row_coderef;
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
100    
101  =item *  sub data_structure {
102            my $arg = {@_};
103    
104  source data records (C<$rec>) have unique identifiers in field C<000>          die "need row argument" unless ($arg->{row});
105            die "need normalisation argument" unless ($arg->{rules});
106    
107  =item *          no strict 'subs';
108            _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
109            _set_rec( $arg->{row} );
110            _set_config( $arg->{config} ) if defined($arg->{config});
111            _clean_ds( %{ $arg } );
112            $load_row_coderef = $arg->{load_row_coderef};
113    
114  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be          eval "$arg->{rules}";
115  perl code that is evaluated before producing output (value of field will be          die "error evaling $arg->{rules}: $@\n" if ($@);
 interpolated before that)  
116    
117  =item *          return _get_ds();
118    }
119    
120  optional C<filter{filter_name}> at B<begining of format> will apply perl  =head2 _set_rec
 code defined as code ref on format after field substitution to producing  
 output  
121    
122  =item *  Set current record hash
123    
124  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.    _set_rec( $rec );
125    
126    =cut
127    
128    my $rec;
129    
130    sub _set_rec {
131            $rec = shift or die "no record hash";
132    }
133    
134  =item *  =head2 _set_config
135    
136  at end, optional C<format>s rules are resolved. Format rules are similar to  Set current config hash
137  C<sprintf> and can also contain C<lookup{...}> which is performed after  
138  values are inserted in format.    _set_config( $config );
139    
140    Magic keys are:
141    
142    =over 4
143    
144    =item _
145    
146    Code of current database
147    
148    =item _mfn
149    
150    Current MFN
151    
152  =back  =back
153    
154  This also describes order in which transformations are applied (eval,  =cut
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
155    
156    my $config;
157    
158    sub _set_config {
159            $config = shift;
160    }
161    
162    =head2 _get_ds
163    
164  =head1 FUNCTIONS  Return hash formatted as data structure
165    
166  =head2 new    my $ds = _get_ds();
167    
168  Create new normalisation object  =cut
169    
170    my $n = new WebPAC::Normalize::Something(  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader);
171          filter => {  my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
172                  'filter_name_1' => sub {  
173                          # filter code  sub _get_ds {
174                          return length($_);          return $out;
175                  }, ...  }
176          },  
177          cache_data_structure => './cache/ds/',  =head2 _clean_ds
178          lookup_regex => $lookup->regex,  
179    );  Clean data structure hash for next record
180    
181      _clean_ds();
182    
183    =cut
184    
185  Parametar C<filter> defines user supplied snippets of perl code which can  sub _clean_ds {
186  be use with C<filter{...}> notation.          my $a = {@_};
187            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader) = ();
188            ($marc_record_offset, $marc_fetch_offset) = (0,0);
189            $marc_encoding = $a->{marc_encoding};
190    }
191    
192    =head2 _set_lookup
193    
194  Optional parameter C<cache_data_structure> defines path to directory  Set current lookup hash
 in which cache file for C<data_structure> call will be created.  
195    
196  Recommended parametar C<lookup_regex> is used to enable parsing of lookups    _set_lookup( $lookup );
 in structures.  
197    
198  =cut  =cut
199    
200  sub new {  my $lookup;
201          my $class = shift;  
202          my $self = {@_};  sub _set_lookup {
203          bless($self, $class);          $lookup = shift;
204    }
205    
206    =head2 _get_lookup
207    
208    Get current lookup hash
209    
210      my $lookup = _get_lookup();
211    
212    =cut
213    
214    sub _get_lookup {
215            return $lookup;
216    }
217    
218    =head2 _set_load_row
219    
220    Setup code reference which will return L<data_structure> from
221    L<WebPAC::Store>
222    
223      _set_load_row(sub {
224                    my ($database,$input,$mfn) = @_;
225                    $store->load_row( database => $database, input => $input, id => $mfn );
226      });
227    
228          $self->setup_cache_dir( $self->{'cache_data_structure'} );  =cut
229    
230    sub _set_load_row {
231            my $coderef = shift;
232            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
233    
234          $self ? return $self : return undef;          $load_row_coderef = $coderef;
235  }  }
236    
237  =head2 setup_cache_dir  =head2 _get_marc_fields
238    
239    Get all fields defined by calls to C<marc>
240    
241            $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
242    
243    We are using I<magic> which detect repeatable fields only from
244    sequence of field/subfield data generated by normalization.
245    
246    Repeatable field is created when there is second occurence of same subfield or
247    if any of indicators are different.
248    
249    This is sane for most cases. Something like:
250    
251      900a-1 900b-1 900c-1
252      900a-2 900b-2
253      900a-3
254    
255  Check if specified cache directory exist, and if not, disable caching.  will be created from any combination of:
256    
257   $setup_cache_dir('./cache/ds/');    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
258    
259  If you pass false or zero value to this function, it will disable  and following rules:
260  cacheing.  
261      marc('900','a', rec('200','a') );
262      marc('900','b', rec('200','b') );
263      marc('900','c', rec('200','c') );
264    
265    which might not be what you have in mind. If you need repeatable subfield,
266    define it using C<marc_repeatable_subfield> like this:
267    
268      marc_repeatable_subfield('900','a');
269      marc('900','a', rec('200','a') );
270      marc('900','b', rec('200','b') );
271      marc('900','c', rec('200','c') );
272    
273    will create:
274    
275      900a-1 900a-2 900a-3 900b-1 900c-1
276      900b-2
277    
278    There is also support for returning next or specific using:
279    
280      while (my $mf = WebPAC::Normalize:_get_marc_fields( fetch_next => 1 ) ) {
281            # do something with $mf
282      }
283    
284    will always return fields from next MARC record or
285    
286      my $mf = WebPAC::Normalize::_get_marc_fields( offset => 42 );
287    
288    will return 42th copy record (if it exists).
289    
290  =cut  =cut
291    
292  sub setup_cache_dir {  my $fetch_pos;
         my $self = shift;  
293    
294          my $dir = shift;  sub _get_marc_fields {
295    
296          my $log = $self->_get_logger();          my $arg = {@_};
297            warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2);
298            $fetch_pos = $marc_fetch_offset;
299            if ($arg->{offset}) {
300                    $fetch_pos = $arg->{offset};
301            } elsif($arg->{fetch_next}) {
302                    $marc_fetch_offset++;
303            }
304    
305            return if (! $marc_record || ref($marc_record) ne 'ARRAY');
306    
307            warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
308    
309            my $marc_rec = $marc_record->[ $fetch_pos ];
310    
311            warn "## _get_marc_fields (at offset: $fetch_pos) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
312    
313            return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);
314    
315            # first, sort all existing fields
316            # XXX might not be needed, but modern perl might randomize elements in hash
317            my @sorted_marc_record = sort {
318                    $a->[0] . ( $a->[3] || '' ) cmp $b->[0] . ( $b->[3] || '')
319            } @{ $marc_rec };
320    
321            @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
322            
323            # output marc fields
324            my @m;
325    
326            # count unique field-subfields (used for offset when walking to next subfield)
327            my $u;
328            map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
329    
330            if ($debug) {
331                    warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
332                    warn "## marc_record[$fetch_pos] = ", dump( $marc_rec ), $/;
333                    warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
334                    warn "## subfield count = ", dump( $u ), $/;
335            }
336    
337          if ($dir) {          my $len = $#sorted_marc_record;
338                  my $msg;          my $visited;
339                  if (! -e $dir) {          my $i = 0;
340                          $msg = "doesn't exist";          my $field;
341                  } elsif (! -d $dir) {  
342                          $msg = "is not directory";          foreach ( 0 .. $len ) {
343                  } elsif (! -w $dir) {  
344                          $msg = "not writable";                  # find next element which isn't visited
345                    while ($visited->{$i}) {
346                            $i = ($i + 1) % ($len + 1);
347                  }                  }
348    
349                  if ($msg) {                  # mark it visited
350                          undef $self->{'cache_data_structure'};                  $visited->{$i}++;
351                          $log->warn("cache_data_structure $dir $msg, disabling...");  
352                    my $row = dclone( $sorted_marc_record[$i] );
353    
354                    # field and subfield which is key for
355                    # marc_repeatable_subfield and u
356                    my $fsf = $row->[0] . ( $row->[3] || '' );
357    
358                    if ($debug > 1) {
359    
360                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
361                            print "### this [$i]: ", dump( $row ),$/;
362                            print "### sf: ", $row->[3], " vs ", $field->[3],
363                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
364                                    if ($#$field >= 0);
365    
366                    }
367    
368                    # if field exists
369                    if ( $#$field >= 0 ) {
370                            if (
371                                    $row->[0] ne $field->[0] ||             # field
372                                    $row->[1] ne $field->[1] ||             # i1
373                                    $row->[2] ne $field->[2]                # i2
374                            ) {
375                                    push @m, $field;
376                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
377                                    $field = $row;
378    
379                            } elsif (
380                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
381                                    ||
382                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
383                                            ! $marc_repeatable_subfield->{ $fsf }
384                                    )
385                            ) {
386                                    push @m, $field;
387                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
388                                    $field = $row;
389    
390                            } else {
391                                    # append new subfields to existing field
392                                    push @$field, ( $row->[3], $row->[4] );
393                            }
394                  } else {                  } else {
395                          $log->debug("using cache dir $dir");                          # insert first field
396                            $field = $row;
397                    }
398    
399                    if (! $marc_repeatable_subfield->{ $fsf }) {
400                            # make step to next subfield
401                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
402                  }                  }
         } else {  
                 $log->debug("disabling cache");  
                 undef $self->{'cache_data_structure'};  
403          }          }
404    
405            if ($#$field >= 0) {
406                    push @m, $field;
407                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
408            }
409    
410            return \@m;
411  }  }
412    
413    =head2 _get_marc_leader
414    
415  =head2 data_structure  Return leader from currently fetched record by L</_get_marc_fields>
416    
417  Create in-memory data structure which represents normalized layout from    print WebPAC::Normalize::_get_marc_leader();
 C<conf/normalize/*.xml>.  
418    
419  This structures are used to produce output.  =cut
420    
421   my @ds = $webpac->data_structure($rec);  sub _get_marc_leader {
422            die "no fetch_pos, did you called _get_marc_fields first?" unless ( defined( $fetch_pos ) );
423            return $marc_leader->[ $fetch_pos ];
424    }
425    
426  B<Note: historical oddity follows>  =head2 _debug
427    
428  This method will also set C<< $webpac->{'currnet_filename'} >> if there is  Change level of debug warnings
429  C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
430  C<< <headline> >> tag.    _debug( 2 );
431    
432  =cut  =cut
433    
434  sub data_structure {  sub _debug {
435          my $self = shift;          my $l = shift;
436            return $debug unless defined($l);
437            warn "debug level $l",$/ if ($l > 0);
438            $debug = $l;
439    }
440    
441    =head1 Functions to create C<data_structure>
442    
443    Those functions generally have to first in your normalization file.
444    
445    =head2 tag
446    
447    Define new tag for I<search> and I<display>.
448    
449      tag('Title', rec('200','a') );
450    
451    
452    =cut
453    
454    sub tag {
455            my $name = shift or die "tag needs name as first argument";
456            my @o = grep { defined($_) && $_ ne '' } @_;
457            return unless (@o);
458            $out->{$name}->{tag} = $name;
459            $out->{$name}->{search} = \@o;
460            $out->{$name}->{display} = \@o;
461    }
462    
463          my $log = $self->_get_logger();  =head2 display
464    
465          my $rec = shift;  Define tag just for I<display>
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
466    
467          my $cache_file;    @v = display('Title', rec('200','a') );
468    
469          if (my $cache_path = $self->{'cache_data_structure'}) {  =cut
470                  my $id = $rec->{'000'};  
471                  $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);  sub display {
472                  unless (defined($id)) {          my $name = shift or die "display needs name as first argument";
473                          $log->warn("Can't use cache_data_structure on records without unique identifier in field 000");          my @o = grep { defined($_) && $_ ne '' } @_;
474                          undef $self->{'cache_data_structure'};          return unless (@o);
475            $out->{$name}->{tag} = $name;
476            $out->{$name}->{display} = \@o;
477    }
478    
479    =head2 search
480    
481    Prepare values just for I<search>
482    
483      @v = search('Title', rec('200','a') );
484    
485    =cut
486    
487    sub search {
488            my $name = shift or die "search needs name as first argument";
489            my @o = grep { defined($_) && $_ ne '' } @_;
490            return unless (@o);
491            $out->{$name}->{tag} = $name;
492            $out->{$name}->{search} = \@o;
493    }
494    
495    =head2 marc_leader
496    
497    Setup fields within MARC leader or get leader
498    
499      marc_leader('05','c');
500      my $leader = marc_leader();
501    
502    =cut
503    
504    sub marc_leader {
505            my ($offset,$value) = @_;
506    
507            if ($offset) {
508                    $marc_leader->[ $marc_record_offset ]->{ $offset } = $value;
509            } else {
510                    
511                    if (defined($marc_leader)) {
512                            die "marc_leader not array = ", dump( $marc_leader ) unless (ref($marc_leader) eq 'ARRAY');
513                            return $marc_leader->[ $marc_record_offset ];
514                  } else {                  } else {
515                          $cache_file = "$cache_path/$id";                          return;
516                          if (-r $cache_file) {                  }
517                                  my $ds_ref = retrieve($cache_file);          }
518                                  if ($ds_ref) {  }
519                                          $log->debug("cache hit: $cache_file");  
520                                          my $ok = 1;  =head2 marc_fixed
521                                          foreach my $f (qw(current_filename headline)) {  
522                                                  if ($ds_ref->{$f}) {  Create control/indentifier fields with values in fixed positions
523                                                          $self->{$f} = $ds_ref->{$f};  
524                                                  } else {    marc_fixed('008', 00, '070402');
525                                                          $ok = 0;    marc_fixed('008', 39, '|');
526                                                  }  
527                                          };  Positions not specified will be filled with spaces (C<0x20>).
528                                          if ($ok && $ds_ref->{'ds'}) {  
529                                                  return @{ $ds_ref->{'ds'} };  There will be no effort to extend last specified value to full length of
530                                          } else {  field in standard.
531                                                  $log->warn("cache_data_structure $cache_path corrupt. Use rm $cache_path/* to re-create it on next run!");  
532                                                  undef $self->{'cache_data_structure'};  =cut
533                                          }  
534                                  }  sub marc_fixed {
535            my ($f, $pos, $val) = @_;
536            die "need marc(field, position, value)" unless defined($f) && defined($pos);
537    
538            my $update = 0;
539    
540            map {
541                    if ($_->[0] eq $f) {
542                            my $old = $_->[1];
543                            if (length($old) < $pos) {
544                                    $_->[1] .= ' ' x ( $pos - length($old) ) . $val;
545                                    warn "## marc_fixed($f,$pos,'$val') append '$old' -> '$_->[1]'\n" if ($debug > 1);
546                            } else {
547                                    $_->[1] = substr($old, 0, $pos) . $val . substr($old, $pos + length($val));
548                                    warn "## marc_fixed($f,$pos,'$val') update '$old' -> '$_->[1]'\n" if ($debug > 1);
549                          }                          }
550                            $update++;
551                  }                  }
552            } @{ $marc_record->[ $marc_record_offset ] };
553    
554            if (! $update) {
555                    my $v = ' ' x $pos . $val;
556                    push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
557                    warn "## marc_fixed($f,$pos,'val') created '$v'\n" if ($debug > 1);
558          }          }
559    }
560    
561          undef $self->{'currnet_filename'};  =head2 marc
         undef $self->{'headline'};  
562    
563          my @sorted_tags;  Save value for MARC field
564          if ($self->{tags_by_order}) {  
565                  @sorted_tags = @{$self->{tags_by_order}};    marc('900','a', rec('200','a') );
566          } else {    marc('001', rec('000') );
567                  @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
568                  $self->{tags_by_order} = \@sorted_tags;  =cut
569    
570    sub marc {
571            my $f = shift or die "marc needs field";
572            die "marc field must be numer" unless ($f =~ /^\d+$/);
573    
574            my $sf;
575            if ($f >= 10) {
576                    $sf = shift or die "marc needs subfield";
577          }          }
578    
579          my @ds;          foreach (@_) {
580                    my $v = $_;             # make var read-write for Encode
581                    next unless (defined($v) && $v !~ /^\s*$/);
582                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
583                    if (defined $sf) {
584                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];
585                    } else {
586                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
587                    }
588            }
589    }
590    
591          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  =head2 marc_repeatable_subfield
592    
593          foreach my $field (@sorted_tags) {  Save values for MARC repetable subfield
594    
595                  my $row;    marc_repeatable_subfield('910', 'z', rec('909') );
596    
597  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  =cut
598    
599                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  sub marc_repeatable_subfield {
600                          my $format = $tag->{'value'} || $tag->{'content'};          my ($f,$sf) = @_;
601            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
602            $marc_repeatable_subfield->{ $f . $sf }++;
603            marc(@_);
604    }
605    
606                          $log->debug("format: $format");  =head2 marc_indicators
607    
608                          my @v;  Set both indicators for MARC field
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->fill_in_to_arr($rec,$format);  
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
609    
610                          if ($tag->{'sort'}) {    marc_indicators('900', ' ', 1);
                                 @v = $self->sort_arr(@v);  
                         }  
611    
612                          # use format?  Any indicator value other than C<0-9> will be treated as undefined.
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
613    
614                          if ($field eq 'filename') {  =cut
                                 $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!  
                         }  
615    
616                          # delimiter will join repeatable fields  sub marc_indicators {
617                          if ($tag->{'delimiter'}) {          my $f = shift || die "marc_indicators need field!\n";
618                                  @v = ( join($tag->{'delimiter'}, @v) );          my ($i1,$i2) = @_;
619                          }          die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
620            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
621    
622            $i1 = ' ' if ($i1 !~ /^\d$/);
623            $i2 = ' ' if ($i2 !~ /^\d$/);
624            @{ $marc_indicators->{$f} } = ($i1,$i2);
625    }
626    
627                          # default types  =head2 marc_compose
                         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;  
628    
629                                  } else {  Save values for each MARC subfield explicitly
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
630    
631      marc_compose('900',
632            'a', rec('200','a')
633            'b', rec('201','a')
634            'a', rec('200','b')
635            'c', rec('200','c')
636      );
637    
638                  }  If you specify C<+> for subfield, value will be appended
639    to previous defined subfield.
640    
641                  if ($row) {  =cut
                         $row->{'tag'} = $field;  
642    
643                          # TODO: name_sigular, name_plural  sub marc_compose {
644                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};          my $f = shift or die "marc_compose needs field";
645                          $row->{'name'} = $name ? $self->_x($name) : $field;          die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
646    
647                          push @ds, $row;          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
648            my $m = [ $f, $i1, $i2 ];
649    
650                          $log->debug("row $field: ",sub { Dumper($row) });          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
                 }  
651    
652            if ($#_ % 2 != 1) {
653                    die "ERROR: marc_compose",dump($f,@_)," not valid (must be even).\nDo you need to add first() or join() around some argument?\n";
654          }          }
655    
656          if ($cache_file) {          while (@_) {
657                  store {                  my $sf = shift;
658                          ds => \@ds,                  my $v = shift;
659                          current_filename => $self->{'current_filename'},  
660                          headline => $self->{'headline'},                  next unless (defined($v) && $v !~ /^\s*$/);
661                  }, $cache_file;                  warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
662                  $log->debug("created storable cache file $cache_file");                  if ($sf ne '+') {
663                            push @$m, ( $sf, $v );
664                    } else {
665                            $m->[ $#$m ] .= $v;
666                    }
667          }          }
668    
669          return @ds;          warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);
670    
671            push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);
672  }  }
673    
674  =head2 parse  =head2 marc_duplicate
675    
676    Generate copy of current MARC record and continue working on copy
677    
678  Perform smart parsing of string, skipping delimiters for fields which aren't    marc_duplicate();
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
679    
680   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or
681    C<< _get_marc_fields( offset => 42 ) >>.
682    
683  =cut  =cut
684    
685  sub parse {  sub marc_duplicate {
686          my $self = shift;           my $m = $marc_record->[ -1 ];
687             die "can't duplicate record which isn't defined" unless ($m);
688             push @{ $marc_record }, dclone( $m );
689             push @{ $marc_leader }, dclone( marc_leader() );
690             warn "## marc_duplicate = ", dump(@$marc_leader, @$marc_record), $/ if ($debug > 1);
691             $marc_record_offset = $#{ $marc_record };
692             warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1);
693    
694    }
695    
696          my ($rec, $format_utf8, $i) = @_;  =head2 marc_remove
697    
698          return if (! $format_utf8);  Remove some field or subfield from MARC record.
699    
700          my $log = $self->_get_logger();    marc_remove('200');
701      marc_remove('200','a');
702    
703          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  This will erase field C<200> or C<200^a> from current MARC record.
704    
705          $i = 0 if (! $i);    marc_remove('*');
706    
707          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  Will remove all fields in current MARC record.
708    
709          my @out;  This is useful after calling C<marc_duplicate> or on it's own (but, you
710    should probably just remove that subfield definition if you are not
711    using C<marc_duplicate>).
712    
713          $log->debug("format: $format");  FIXME: support fields < 10.
714    
715          my $eval_code;  =cut
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
716    
717          my $filter_name;  sub marc_remove {
718          # remove filter{...} from beginning          my ($f, $sf) = @_;
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
719    
720          my $prefix;          die "marc_remove needs record number" unless defined($f);
         my $all_found=0;  
721    
722          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {          my $marc = $marc_record->[ $marc_record_offset ];
723    
724                  my $del = $1 || '';          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
                 $prefix ||= $del if ($all_found == 0);  
725    
726                  # repeatable index          if ($f eq '*') {
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
727    
728                  my $found = 0;                  delete( $marc_record->[ $marc_record_offset ] );
729                  my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);                  warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
730    
731                  if ($found) {          } else {
732                          push @out, $del;  
733                          push @out, $tmp;                  my $i = 0;
734                          $all_found += $found;                  foreach ( 0 .. $#{ $marc } ) {
735                            last unless (defined $marc->[$i]);
736                            warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
737                            if ($marc->[$i]->[0] eq $f) {
738                                    if (! defined $sf) {
739                                            # remove whole field
740                                            splice @$marc, $i, 1;
741                                            warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
742                                            $i--;
743                                    } else {
744                                            foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
745                                                    my $o = ($j * 2) + 3;
746                                                    if ($marc->[$i]->[$o] eq $sf) {
747                                                            # remove subfield
748                                                            splice @{$marc->[$i]}, $o, 2;
749                                                            warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
750                                                            # is record now empty?
751                                                            if ($#{ $marc->[$i] } == 2) {
752                                                                    splice @$marc, $i, 1;
753                                                                    warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
754                                                                    $i--;
755                                                            };
756                                                    }
757                                            }
758                                    }
759                            }
760                            $i++;
761                  }                  }
762    
763                    warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
764    
765                    $marc_record->[ $marc_record_offset ] = $marc;
766          }          }
767    
768          return if (! $all_found);          warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
769    }
770    
771          my $out = join('',@out);  =head2 marc_original_order
772    
773          if ($out) {  Copy all subfields preserving original order to marc field.
                 # add rest of format (suffix)  
                 $out .= $format;  
774    
775                  # add prefix if not there    marc_original_order( marc_field_number, original_input_field_number );
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
776    
777                  $log->debug("result: $out");  Please note that field numbers are consistent with other commands (marc
778          }  field number first), but somewhat counter-intuitive (destination and then
779    source).
780    
781          if ($eval_code) {  You might want to use this command if you are just renaming subfields or
782                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  using pre-processing modify_record in C<config.yml> and don't need any
783                  $log->debug("about to eval{$eval} format: $out");  post-processing or want to preserve order of original subfields.
                 return if (! $self->_eval($eval));  
         }  
           
         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");  
         }  
784    
         return $out;  
 }  
785    
786  =head2 parse_to_arr  =cut
787    
788  Similar to C<parse>, but returns array of all repeatable fields  sub marc_original_order {
789    
790   my @arr = $webpac->parse_to_arr($rec,'v250^a');          my ($to, $from) = @_;
791            die "marc_original_order needs from and to fields\n" unless ($from && $to);
792    
793  =cut          return unless defined($rec->{$from});
794    
795  sub parse_to_arr {          my $r = $rec->{$from};
796          my $self = shift;          die "record field $from isn't array\n" unless (ref($r) eq 'ARRAY');
797    
798          my ($rec, $format_utf8) = @_;          my ($i1,$i2) = defined($marc_indicators->{$to}) ? @{ $marc_indicators->{$to} } : (' ',' ');
799            warn "## marc_original_order($to,$from) source = ", dump( $r ),$/ if ($debug > 1);
800    
801          my $log = $self->_get_logger();          foreach my $d (@$r) {
802    
803          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  if (! defined($d->{subfields}) && ref($d->{subfields}) ne 'ARRAY') {
804          return if (! $format_utf8);                          warn "# marc_original_order($to,$from): field $from doesn't have subfields specification\n";
805                            next;
806                    }
807            
808                    my @sfs = @{ $d->{subfields} };
809    
810          my $i = 0;                  die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);
         my @arr;  
811    
812          while (my $v = $self->parse($rec,$format_utf8,$i++)) {                  warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);
813                  push @arr, $v;  
814          }                  my $m = [ $to, $i1, $i2 ];
815    
816                    while (my $sf = shift @sfs) {
817    
818          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);                          warn "#--> sf: ",dump($sf), $/ if ($debug > 2);
819                            my $offset = shift @sfs;
820                            die "corrupted sufields specification for field $from\n" unless defined($offset);
821    
822          return @arr;                          my $v;
823                            if (ref($d->{$sf}) eq 'ARRAY') {
824                                    $v = $d->{$sf}->[$offset] if (defined($d->{$sf}->[$offset]));
825                            } elsif ($offset == 0) {
826                                    $v = $d->{$sf};
827                            } else {
828                                    die "field $from subfield '$sf' need occurence $offset which doesn't exist", dump($d->{$sf});
829                            }
830                            push @$m, ( $sf, $v ) if (defined($v));
831                    }
832    
833                    if ($#{$m} > 2) {
834                            push @{ $marc_record->[ $marc_record_offset ] }, $m;
835                    }
836            }
837    
838            warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1);
839  }  }
840    
841    =head2 marc_count
842    
843  =head2 fill_in  Return number of MARC records created using L</marc_duplicate>.
844    
845  Workhourse of all: takes record from in-memory structure of database and    print "created ", marc_count(), " records";
 strings with placeholders and returns string or array of with substituted  
 values from record.  
846    
847   my $text = $webpac->fill_in($rec,'v250^a');  =cut
848    
849  Optional argument is ordinal number for repeatable fields. By default,  sub marc_count {
850  it's assume to be first repeatable field (fields are perl array, so first          return $#{ $marc_record };
851  element is 0).  }
852  Following example will read second value from repeatable field.  
853    
854    =head1 Functions to extract data from input
855    
856   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  This function should be used inside functions to create C<data_structure> described
857    above.
858    
859  This function B<does not> perform parsing of format to inteligenty skip  =head2 _pack_subfields_hash
 delimiters before fields which aren't used.  
860    
861  This method will automatically decode UTF-8 string to local code page   @subfields = _pack_subfields_hash( $h );
862  if needed.   $subfields = _pack_subfields_hash( $h, 1 );
863    
864    Return each subfield value in array or pack them all together and return scalar
865    with subfields (denoted by C<^>) and values.
866    
867  =cut  =cut
868    
869  sub fill_in {  sub _pack_subfields_hash {
         my $self = shift;  
870    
871          my $log = $self->_get_logger();          warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
872    
873          my $rec = shift || $log->logconfess("need data record");          my ($h,$include_subfields) = @_;
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
874    
875          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          # sanity and ease of use
876            return $h if (ref($h) ne 'HASH');
877    
878          # FIXME remove for speedup?          if ( defined($h->{subfields}) ) {
879          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  my $sfs = delete $h->{subfields} || die "no subfields?";
880                    my @out;
881                    while (@$sfs) {
882                            my $sf = shift @$sfs;
883                            push @out, '^' . $sf if ($include_subfields);
884                            my $o = shift @$sfs;
885                            if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
886                                    # single element subfields are not arrays
887    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
888    
889          if (utf8::is_utf8($format)) {                                  push @out, $h->{$sf};
890                  $format = $self->_x($format);                          } else {
891    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
892                                    push @out, $h->{$sf}->[$o];
893                            }
894                    }
895                    if ($include_subfields) {
896                            return join('', @out);
897                    } else {
898                            return @out;
899                    }
900            } else {
901                    if ($include_subfields) {
902                            my $out = '';
903                            foreach my $sf (sort keys %$h) {
904                                    if (ref($h->{$sf}) eq 'ARRAY') {
905                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
906                                    } else {
907                                            $out .= '^' . $sf . $h->{$sf};
908                                    }
909                            }
910                            return $out;
911                    } else {
912                            # FIXME this should probably be in alphabetical order instead of hash order
913                            values %{$h};
914                    }
915          }          }
916    }
917    
918          my $found = 0;  =head2 rec1
919    
920          my $eval_code;  Return all values in some field
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
921    
922          my $filter_name;    @v = rec1('200')
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
923    
924          # do actual replacement of placeholders  TODO: order of values is probably same as in source data, need to investigate that
         # repeatable fields  
         $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;  
         # non-repeatable fields  
         $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;  
925    
926          if ($found) {  =cut
927                  $log->debug("format: $format");  
928                  if ($eval_code) {  sub rec1 {
929                          my $eval = $self->fill_in($rec,$eval_code,$i);          my $f = shift;
930                          return if (! $self->_eval($eval));          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
931                  }          return unless (defined($rec) && defined($rec->{$f}));
932                  if ($filter_name && $self->{'filter'}->{$filter_name}) {          warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
933                          $log->debug("filter '$filter_name' for $format");          if (ref($rec->{$f}) eq 'ARRAY') {
934                          $format = $self->{'filter'}->{$filter_name}->($format);                  my @out;
935                          return unless(defined($format));                  foreach my $h ( @{ $rec->{$f} } ) {
936                          $log->debug("filter result: $format");                          if (ref($h) eq 'HASH') {
937                                    push @out, ( _pack_subfields_hash( $h ) );
938                            } else {
939                                    push @out, $h;
940                            }
941                  }                  }
942                  # do we have lookups?                  return @out;
943                  if ($self->{'lookup'}) {          } elsif( defined($rec->{$f}) ) {
944                          return $self->lookup($format);                  return $rec->{$f};
945            }
946    }
947    
948    =head2 rec2
949    
950    Return all values in specific field and subfield
951    
952      @v = rec2('200','a')
953    
954    =cut
955    
956    sub rec2 {
957            my $f = shift;
958            return unless (defined($rec && $rec->{$f}));
959            my $sf = shift;
960            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
961            return map {
962                    if (ref($_->{$sf}) eq 'ARRAY') {
963                            @{ $_->{$sf} };
964                  } else {                  } else {
965                          return $format;                          $_->{$sf};
966                  }                  }
967            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
968    }
969    
970    =head2 rec
971    
972    syntaxtic sugar for
973    
974      @v = rec('200')
975      @v = rec('200','a')
976    
977    If rec() returns just single value, it will
978    return scalar, not array.
979    
980    =cut
981    
982    sub rec {
983            my @out;
984            if ($#_ == 0) {
985                    @out = rec1(@_);
986            } elsif ($#_ == 1) {
987                    @out = rec2(@_);
988            }
989            if ($#out == 0 && ! wantarray) {
990                    return $out[0];
991            } elsif (@out) {
992                    return @out;
993          } else {          } else {
994                  return;                  return '';
995          }          }
996  }  }
997    
998    =head2 regex
999    
1000    Apply regex to some or all values
1001    
1002      @v = regex( 's/foo/bar/g', @v );
1003    
1004    =cut
1005    
1006    sub regex {
1007            my $r = shift;
1008            my @out;
1009            #warn "r: $r\n", dump(\@_);
1010            foreach my $t (@_) {
1011                    next unless ($t);
1012                    eval "\$t =~ $r";
1013                    push @out, $t if ($t && $t ne '');
1014            }
1015            return @out;
1016    }
1017    
1018  =head2 fill_in_to_arr  =head2 prefix
1019    
1020  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  Prefix all values with a string
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
1021    
1022   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = prefix( 'my_', @v );
1023    
1024  =cut  =cut
1025    
1026  sub fill_in_to_arr {  sub prefix {
1027          my $self = shift;          my $p = shift;
1028            return @_ unless defined( $p );
1029            return map { $p . $_ } grep { defined($_) } @_;
1030    }
1031    
1032          my ($rec, $format_utf8) = @_;  =head2 suffix
1033    
1034          my $log = $self->_get_logger();  suffix all values with a string
1035    
1036          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = suffix( '_my', @v );
         return if (! $format_utf8);  
1037    
1038          my $i = 0;  =cut
         my @arr;  
1039    
1040          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub suffix {
1041                  push @arr, @v;          my $s = shift;
1042          }          return @_ unless defined( $s );
1043            return map { $_ . $s } grep { defined($_) } @_;
1044    }
1045    
1046          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =head2 surround
1047    
1048          return @arr;  surround all values with a two strings
1049    
1050      @v = surround( 'prefix_', '_suffix', @v );
1051    
1052    =cut
1053    
1054    sub surround {
1055            my $p = shift;
1056            my $s = shift;
1057            $p = '' unless defined( $p );
1058            $s = '' unless defined( $s );
1059            return map { $p . $_ . $s } grep { defined($_) } @_;
1060  }  }
1061    
1062    =head2 first
1063    
1064  =head2 get_data  Return first element
1065    
1066  Returns value from record.    $v = first( @v );
1067    
1068   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =cut
1069    
1070  Arguments are:  sub first {
1071  record reference C<$rec>,          my $r = shift;
1072  field C<$f>,          return $r;
1073  optional subfiled C<$sf>,  }
1074  index for repeatable values C<$i>.  
1075    =head2 lookup
1076    
1077    Consult lookup hashes for some value
1078    
1079  Optinal variable C<$found> will be incremeted if there    @v = lookup(
1080  is field.          sub {
1081                    'ffkk/peri/mfn'.rec('000')
1082            },
1083            'ffkk','peri','200-a-200-e',
1084            sub {
1085                    first(rec(200,'a')).' '.first(rec('200','e'))
1086            }
1087      );
1088    
1089  Returns value or empty string.  Code like above will be B<automatically generated> using L<WebPAC::Parse> from
1090    normal lookup definition in C<conf/lookup/something.pl> which looks like:
1091    
1092      lookup(
1093            # which results to return from record recorded in lookup
1094            sub { 'ffkk/peri/mfn' . rec('000') },
1095            # from which database and input
1096            'ffkk','peri',
1097            # such that following values match
1098            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
1099            # if this part is missing, we will try to match same fields
1100            # from lookup record and current one, or you can override
1101            # which records to use from current record using
1102            sub { rec('900','x') . ' ' . rec('900','y') },
1103      )
1104    
1105    You can think about this lookup as SQL (if that helps):
1106    
1107      select
1108            sub { what }
1109      from
1110            database, input
1111      where
1112        sub { filter from lookuped record }
1113      having
1114        sub { optional filter on current record }
1115    
1116    Easy as pie, right?
1117    
1118  =cut  =cut
1119    
1120  sub get_data {  sub lookup {
1121          my $self = shift;          my ($what, $database, $input, $key, $having) = @_;
1122    
1123          my ($rec,$f,$sf,$i,$found) = @_;          confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
1124    
1125          if ($$rec->{$f}) {          warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
1126                  return '' if (! $$rec->{$f}->[$i]);          return unless (defined($lookup->{$database}->{$input}->{$key}));
1127                  no strict 'refs';  
1128                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
1129                          $$found++ if (defined($$found));  
1130                          return $$rec->{$f}->[$i]->{$sf};          my $mfns;
1131                  } elsif ($$rec->{$f}->[$i]) {          my @having = $having->();
1132                          $$found++ if (defined($$found));  
1133                          # it still might have subfield, just          warn "## having = ", dump( @having ) if ($debug > 2);
1134                          # not specified, so we'll dump all  
1135                          if ($$rec->{$f}->[$i] =~ /HASH/o) {          foreach my $h ( @having ) {
1136                                  my $out;                  if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
1137                                  foreach my $k (keys %{$$rec->{$f}->[$i]}) {                          warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
1138                                          $out .= $$rec->{$f}->[$i]->{$k}." ";                          $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
1139                  }                  }
1140            }
1141    
1142            return unless ($mfns);
1143    
1144            my @mfns = sort keys %$mfns;
1145    
1146            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
1147    
1148            my $old_rec = $rec;
1149            my @out;
1150    
1151            foreach my $mfn (@mfns) {
1152                    $rec = $load_row_coderef->( $database, $input, $mfn );
1153    
1154                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
1155    
1156                    my @vals = $what->();
1157    
1158                    push @out, ( @vals );
1159    
1160                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1161            }
1162    
1163    #       if (ref($lookup->{$k}) eq 'ARRAY') {
1164    #               return @{ $lookup->{$k} };
1165    #       } else {
1166    #               return $lookup->{$k};
1167    #       }
1168    
1169            $rec = $old_rec;
1170    
1171            warn "## lookup returns = ", dump(@out), $/ if ($debug);
1172    
1173            if ($#out == 0) {
1174                    return $out[0];
1175          } else {          } else {
1176                  return '';                  return @out;
1177          }          }
1178  }  }
1179    
1180    =head2 save_into_lookup
1181    
1182  =head2 apply_format  Save value into lookup. It associates current database, input
1183    and specific keys with one or more values which will be
1184    associated over MFN.
1185    
1186  Apply format specified in tag with C<format_name="name"> and  MFN will be extracted from first occurence current of field 000
1187  C<format_delimiter=";;">.  in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
1188    
1189   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    my $nr = save_into_lookup($database,$input,$key,sub {
1190            # code which produce one or more values
1191      });
1192    
1193  Formats can contain C<lookup{...}> if you need them.  It returns number of items saved.
1194    
1195    This function shouldn't be called directly, it's called from code created by
1196    L<WebPAC::Parser>.
1197    
1198  =cut  =cut
1199    
1200  sub apply_format {  sub save_into_lookup {
1201          my $self = shift;          my ($database,$input,$key,$coderef) = @_;
1202            die "save_into_lookup needs database" unless defined($database);
1203            die "save_into_lookup needs input" unless defined($input);
1204            die "save_into_lookup needs key" unless defined($key);
1205            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
1206    
1207            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
1208    
1209            my $mfn =
1210                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
1211                    defined($config->{_mfn})        ?       $config->{_mfn}         :
1212                                                                                    die "mfn not defined or zero";
1213    
1214            my $nr = 0;
1215    
1216            foreach my $v ( $coderef->() ) {
1217                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
1218                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
1219                    $nr++;
1220            }
1221    
1222          my ($name,$delimiter,$data) = @_;          return $nr;
1223    }
1224    
1225          my $log = $self->_get_logger();  =head2 config
1226    
1227          if (! $self->{'import_xml'}->{'format'}->{$name}) {  Consult config values stored in C<config.yml>
1228                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
1229                  return $data;    # return database code (key under databases in yaml)
1230          }    $database_code = config();    # use _ from hash
1231      $database_name = config('name');
1232      $database_input_name = config('input name');
1233      $tag = config('input normalize tag');
1234    
1235          $log->warn("no delimiter for format $name") if (! $delimiter);  Up to three levels are supported.
1236    
1237          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =cut
1238    
1239    sub config {
1240            return unless ($config);
1241    
1242            my $p = shift;
1243    
1244          my @data = split(/\Q$delimiter\E/, $data);          $p ||= '';
1245    
1246          my $out = sprintf($format, @data);          my $v;
         $log->debug("using format $name [$format] on $data to produce: $out");  
1247    
1248          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          warn "### getting config($p)\n" if ($debug > 1);
1249                  return $self->lookup($out);  
1250            my @p = split(/\s+/,$p);
1251            if ($#p < 0) {
1252                    $v = $config->{ '_' };  # special, database code
1253          } else {          } else {
1254                  return $out;  
1255                    my $c = dclone( $config );
1256    
1257                    foreach my $k (@p) {
1258                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
1259                            if (ref($c) eq 'ARRAY') {
1260                                    $c = shift @$c;
1261                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
1262                                    last;
1263                            }
1264    
1265                            if (! defined($c->{$k}) ) {
1266                                    $c = undef;
1267                                    last;
1268                            } else {
1269                                    $c = $c->{$k};
1270                            }
1271                    }
1272                    $v = $c if ($c);
1273    
1274          }          }
1275    
1276            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
1277            warn "config( '$p' ) is empty\n" if (! $v);
1278    
1279            return $v;
1280  }  }
1281    
1282  =head2 sort_arr  =head2 id
1283    
1284    Returns unique id of this record
1285    
1286  Sort array ignoring case and html in data    $id = id();
1287    
1288   my @sorted = $webpac->sort_arr(@unsorted);  Returns C<42/2> for 2nd occurence of MFN 42.
1289    
1290  =cut  =cut
1291    
1292  sub sort_arr {  sub id {
1293          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
1294            return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';
1295    }
1296    
1297          my $log = $self->_get_logger();  =head2 join_with
1298    
1299          # FIXME add Schwartzian Transformation?  Joins walues with some delimiter
1300    
1301          my @sorted = sort {    $v = join_with(", ", @v);
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
1302    
1303          return @sorted;  =cut
1304    
1305    sub join_with {
1306            my $d = shift;
1307            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
1308            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
1309            return '' unless defined($v);
1310            return $v;
1311  }  }
1312    
1313    =head2 split_rec_on
1314    
1315    Split record subfield on some regex and take one of parts out
1316    
1317  =head1 INTERNAL METHODS    $a_before_semi_column =
1318            split_rec_on('200','a', /\s*;\s*/, $part);
1319    
1320  =head2 _sort_by_order  C<$part> is optional number of element. First element is
1321    B<1>, not 0!
1322    
1323  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
1324    return all values produced by splitting.
1325    
1326  =cut  =cut
1327    
1328  sub _sort_by_order {  sub split_rec_on {
1329          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
1330    
1331          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          my ($fld, $sf, $regex, $part) = @_;
1332                  $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};  
1333    
1334          return $va <=> $vb;          my @r = rec( $fld, $sf );
1335            my $v = shift @r;
1336            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
1337    
1338            return '' if ( ! defined($v) || $v =~ /^\s*$/);
1339    
1340            my @s = split( $regex, $v );
1341            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
1342            if ($part && $part > 0) {
1343                    return $s[ $part - 1 ];
1344            } else {
1345                    return @s;
1346            }
1347  }  }
1348    
1349  =head2 _x  my $hash;
   
 Convert strings from C<conf/normalize/*.xml> encoding into application  
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
1350    
1351   my $text = $n->_x('normalize text string');  =head2 set
1352    
1353  This is a stub so that other modules doesn't have to implement it.    set( key => 'value' );
1354    
1355  =cut  =cut
1356    
1357  sub _x {  sub set {
1358          my $self = shift;          my ($k,$v) = @_;
1359          return shift;          warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
1360  }          $hash->{$k} = $v;
1361    };
1362    
1363    =head2 get
1364    
1365  =head1 AUTHOR    get( 'key' );
1366    
1367  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
1368    
1369  =head1 COPYRIGHT & LICENSE  sub get {
1370            my $k = shift || return;
1371            my $v = $hash->{$k};
1372            warn "## get $k = ", dump( $v ), $/ if ( $debug );
1373            return $v;
1374    }
1375    
1376  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 count
1377    
1378  This program is free software; you can redistribute it and/or modify it    if ( count( @result ) == 1 ) {
1379  under the same terms as Perl itself.          # do something if only 1 result is there
1380      }
1381    
1382  =cut  =cut
1383    
1384  1; # End of WebPAC::DB  sub count {
1385            warn "## count ",dump(@_),$/ if ( $debug );
1386            return @_ . '';
1387    }
1388    
1389    # END
1390    1;

Legend:
Removed from v.15  
changed lines
  Added in v.831

  ViewVC Help
Powered by ViewVC 1.1.26