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

Legend:
Removed from v.31  
changed lines
  Added in v.1015

  ViewVC Help
Powered by ViewVC 1.1.26