/[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 70 by dpavlin, Sat Nov 19 23:48:24 2005 UTC revision 1019 by dpavlin, Sat Nov 10 00:05:36 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.02  =head1 NAME
46    
47    WebPAC::Normalize - describe normalisaton rules using sets
48    
49  =cut  =cut
50    
51  our $VERSION = '0.02';  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);  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                  my $row;                  # mark it visited
354                    $visited->{$i}++;
355    
356  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});                  my $row = dclone( $sorted_marc_record[$i] );
357    
358                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {                  # field and subfield which is key for
359                          my $format;                  # 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                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');                  }
                         $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'};  
                         my $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                          $ds->{$row_name} = $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          $log->logdie("there is no current_filename defined! Do you have filename tag in conf/normalize/?.xml") unless ($self->{'current_filename'});  Those functions generally have to first in your normalization file.
448    
449          $self->{'db'}->save_ds(  =head2 search_display
                 ds => $ds,  
                 current_filename => $self->{'current_filename'},  
                 headline => $self->{'headline'},  
         ) if ($self->{'db'});  
450    
451          $log->debug("ds: ", sub { Dumper($ds) });  Define output for L<search> and L<display> at the same time
452    
453          $log->logconfess("data structure returned is not array any more!") if wantarray;    search_display('Title', rec('200','a') );
454    
         return $ds;  
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    Old name for L<search_display>, but supported
469    
470  Perform smart parsing of string, skipping delimiters for fields which aren't  =cut
471  defined. It can also eval code in format starting with C<eval{...}> and  
472  return output or nothing depending on eval code.  sub tag {
473            search_display( @_ );
474    }
475    
476   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  =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          $log->debug("format: $format");   sorted('Title', rec('200','a') );
509    
510          my $eval_code;  =cut
511          # remove eval{...} from beginning  
512          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  sub sorted { _field( 'sorted', @_ ) }
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    =cut
591    
592          if ($eval_code) {  sub marc {
593                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;          my $f = shift or die "marc needs field";
594                  $log->debug("about to eval{$eval} format: $out");          die "marc field must be numer" unless ($f =~ /^\d+$/);
595                  return if (! $self->_eval($eval));  
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  Similar to C<parse>, but returns array of all repeatable fields  Set both indicators for MARC field
631    
632   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc_indicators('900', ' ', 1);
633    
634    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    sub marc_compose {
666            my $f = shift or die "marc_compose needs field";
667            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
668    
669          while (my $v = $self->parse($rec,$format_utf8,$i++)) {          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
670                  push @arr, $v;          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            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          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "## marc_compose current marc = ", dump( $m ),$/ if ($debug > 1);
692    
693          return @arr;          push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);
694  }  }
695    
696    =head2 marc_duplicate
697    
698  =head2 fill_in  Generate copy of current MARC record and continue working on copy
699    
700  Workhourse of all: takes record from in-memory structure of database and    marc_duplicate();
 strings with placeholders and returns string or array of with substituted  
 values from record.  
701    
702   my $text = $webpac->fill_in($rec,'v250^a');  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or
703    C<< _get_marc_fields( offset => 42 ) >>.
704    
705  Optional argument is ordinal number for repeatable fields. By default,  =cut
706  it's assume to be first repeatable field (fields are perl array, so first  
707  element is 0).  sub marc_duplicate {
708  Following example will read second value from repeatable field.           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    
716    }
717    
718    =head2 marc_remove
719    
720    Remove some field or subfield from MARC record.
721    
722   my $text = $webpac->fill_in($rec,'Title: v250^a',1);    marc_remove('200');
723      marc_remove('200','a');
724    
725  This function B<does not> perform parsing of format to inteligenty skip  This will erase field C<200> or C<200^a> from current MARC record.
 delimiters before fields which aren't used.  
726    
727  This method will automatically decode UTF-8 string to local code page    marc_remove('*');
728  if needed.  
729    Will remove all fields in current MARC record.
730    
731    This is useful after calling C<marc_duplicate> or on it's own (but, you
732    should probably just remove that subfield definition if you are not
733    using C<marc_duplicate>).
734    
735    FIXME: support fields < 10.
736    
737  =cut  =cut
738    
739  sub fill_in {  sub marc_remove {
740          my $self = shift;          my ($f, $sf) = @_;
741    
742          my $log = $self->_get_logger();          die "marc_remove needs record number" unless defined($f);
743    
744          my $rec = shift || $log->logconfess("need data record");          my $marc = $marc_record->[ $marc_record_offset ];
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
745    
746          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
747    
748          # FIXME remove for speedup?          if ($f eq '*') {
749          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
750                    delete( $marc_record->[ $marc_record_offset ] );
751                    warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
752    
753            } else {
754    
755          if (utf8::is_utf8($format)) {                  my $i = 0;
756                  $format = $self->_x($format);                  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                    $marc_record->[ $marc_record_offset ] = $marc;
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 ",dump( $rec ) 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 ",dump( $rec ) 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                    warn "### r = ",dump( $r );
933    
934                    my ( $new_r, $from_count, $to_count );
935                    foreach my $sf ( keys %{$r} ) {
936                            # skip everything which isn't one char subfield (e.g. 'subfields')
937                            next unless $sf =~ m/^\w$/;
938                            my $nr = $from_count->{$sf}++;
939                            my $rename_to = $subfields_rename->{ $sf } ||
940                                    die "can't find subfield rename for $sf/$nr in ", dump( $subfields_rename );
941                            warn "### rename $sf/$nr to ", dump( $rename_to->[$nr] ), $/;
942                            my ( $to_sf, $to_nr ) = @{ $rename_to->[$nr] };
943                            $new_r->{ $to_sf }->[ $to_nr ] = [ $sf => $nr ];
944    
945          my $i = 0;                          $to_count->{ $to_sf }++;
946          my @arr;                  }
947    
948                    warn "### new_r = ",dump( $new_r );
949    
950                    my $from_count_key = dump( $to_count );
951    
952                    warn "### from_count = ",dump( $from_count ), $/;
953                    warn "### to_count   = ",dump( $to_count ), $/;
954    
955                    my $template = $pos_templates->{ $from_count_key } ||
956                            die "I don't have template for:\n$from_count_key\n## available templates\n", dump( $pos_templates );
957    
958                    warn "### selected template: |$template|\n";
959    
960                    $fill_in = {};
961    
962                    my @templates = split(/\|/, $template );
963                    @templates = ( $template );
964    
965                    foreach my $sf ( @templates ) {
966                            sub fill_in {
967                                    my ( $r, $sf, $nr ) = @_;
968                                    my ( $from_sf, $from_nr ) = @{ $new_r->{ $sf }->[ $nr ] };
969                                    my $v = $r->{ $from_sf }; # || die "no $from_sf/$from_nr";
970                                    warn "#### fill_in( $sf, $nr ) = $from_sf/$from_nr >>>> ",dump( $v ), $/;
971                                    if ( ref( $v ) eq 'ARRAY' ) {
972                                            $fill_in->{$sf}->[$nr] = $v->[$from_nr];
973                                            return $v->[$from_nr];
974                                    } elsif ( $from_nr == 0 ) {
975                                            $fill_in->{$sf}->[$nr] = $v;
976                                            return $v;
977                                    } else {
978                                            die "requested subfield $from_sf/$from_nr but it's ",dump( $v );
979                                    }
980                            }
981                            warn "#### $sf <<<< $fields_re\n";
982                            $sf =~ s/($fields_re)(\d+)/fill_in($r,$1,$2)/ge;
983                            warn "#### >>>> $sf with fill_in = ",dump( $fill_in ),$/;
984                    }
985    
986                    warn "## template: |$template|\n## marc_template_order = ",dump( $marc_template_order );
987    
988          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {                  foreach my $sf ( @{ $marc_template_order->{$template} } ) {
989                  push @arr, @v;                          my ( $sf, $nr ) = @$sf;
990                            my $v = $fill_in->{$sf}->[$nr] || die "can't find fill_in $sf/$nr";
991                            warn "++ $sf/$nr |$v|\n";
992                            push @$m, ( $sf, $v );
993                    }
994    
995                    warn "#### >>>> created marc: ", dump( $m );
996    
997                    push @marc_out, $m;
998          }          }
999    
1000          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "### marc_template produced: ",dump( @marc_out );
1001    
1002          return @arr;          foreach my $marc ( @marc_out ) {
1003                    warn "+++ ",dump( $marc );
1004                    push @{ $marc_record->[ $marc_record_offset ] }, $marc;
1005            }
1006  }  }
1007    
1008    =head2 marc_count
1009    
1010    Return number of MARC records created using L</marc_duplicate>.
1011    
1012      print "created ", marc_count(), " records";
1013    
1014  =head2 get_data  =cut
1015    
1016    sub marc_count {
1017            return $#{ $marc_record };
1018    }
1019    
 Returns value from record.  
1020    
1021   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head1 Functions to extract data from input
1022    
1023  Arguments are:  This function should be used inside functions to create C<data_structure> described
1024  record reference C<$rec>,  above.
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
1025    
1026  Optinal variable C<$found> will be incremeted if there  =head2 _pack_subfields_hash
 is field.  
1027    
1028  Returns value or empty string.   @subfields = _pack_subfields_hash( $h );
1029     $subfields = _pack_subfields_hash( $h, 1 );
1030    
1031    Return each subfield value in array or pack them all together and return scalar
1032    with subfields (denoted by C<^>) and values.
1033    
1034  =cut  =cut
1035    
1036  sub get_data {  sub _pack_subfields_hash {
1037          my $self = shift;  
1038            warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
1039    
1040            my ($h,$include_subfields) = @_;
1041    
1042          my ($rec,$f,$sf,$i,$found) = @_;          # sanity and ease of use
1043            return $h if (ref($h) ne 'HASH');
1044    
1045          if ($$rec->{$f}) {          if ( defined($h->{subfields}) ) {
1046                  return '' if (! $$rec->{$f}->[$i]);                  my $sfs = delete $h->{subfields} || die "no subfields?";
1047                  no strict 'refs';                  my @out;
1048                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {                  while (@$sfs) {
1049                          $$found++ if (defined($$found));                          my $sf = shift @$sfs;
1050                          return $$rec->{$f}->[$i]->{$sf};                          push @out, '^' . $sf if ($include_subfields);
1051                  } elsif (! $sf && $$rec->{$f}->[$i]) {                          my $o = shift @$sfs;
1052                          $$found++ if (defined($$found));                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
1053                          # it still might have subfield, just                                  # single element subfields are not arrays
1054                          # not specified, so we'll dump all  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
1055                          if ($$rec->{$f}->[$i] =~ /HASH/o) {  
1056                                  my $out;                                  push @out, $h->{$sf};
1057                                  foreach my $k (keys %{$$rec->{$f}->[$i]}) {                          } else {
1058                                          $out .= $$rec->{$f}->[$i]->{$k}." ";  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
1059                                    push @out, $h->{$sf}->[$o];
1060                            }
1061                    }
1062                    if ($include_subfields) {
1063                            return join('', @out);
1064                    } else {
1065                            return @out;
1066                    }
1067            } else {
1068                    if ($include_subfields) {
1069                            my $out = '';
1070                            foreach my $sf (sort keys %$h) {
1071                                    if (ref($h->{$sf}) eq 'ARRAY') {
1072                                            $out .= '^' . $sf . join('^' . $sf, @{ $h->{$sf} });
1073                                    } else {
1074                                            $out .= '^' . $sf . $h->{$sf};
1075                                  }                                  }
1076                                  return $out;                          }
1077                            return $out;
1078                    } else {
1079                            # FIXME this should probably be in alphabetical order instead of hash order
1080                            values %{$h};
1081                    }
1082            }
1083    }
1084    
1085    =head2 rec1
1086    
1087    Return all values in some field
1088    
1089      @v = rec1('200')
1090    
1091    TODO: order of values is probably same as in source data, need to investigate that
1092    
1093    =cut
1094    
1095    sub rec1 {
1096            my $f = shift;
1097            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
1098            return unless (defined($rec) && defined($rec->{$f}));
1099            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
1100            if (ref($rec->{$f}) eq 'ARRAY') {
1101                    my @out;
1102                    foreach my $h ( @{ $rec->{$f} } ) {
1103                            if (ref($h) eq 'HASH') {
1104                                    push @out, ( _pack_subfields_hash( $h ) );
1105                          } else {                          } else {
1106                                  return $$rec->{$f}->[$i];                                  push @out, $h;
1107                          }                          }
1108                    }
1109                    return @out;
1110            } elsif( defined($rec->{$f}) ) {
1111                    return $rec->{$f};
1112            }
1113    }
1114    
1115    =head2 rec2
1116    
1117    Return all values in specific field and subfield
1118    
1119      @v = rec2('200','a')
1120    
1121    =cut
1122    
1123    sub rec2 {
1124            my $f = shift;
1125            return unless (defined($rec && $rec->{$f}));
1126            my $sf = shift;
1127            warn "rec2($f,$sf) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
1128            return map {
1129                    if (ref($_->{$sf}) eq 'ARRAY') {
1130                            @{ $_->{$sf} };
1131                  } else {                  } else {
1132                          return '';                          $_->{$sf};
1133                  }                  }
1134            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
1135    }
1136    
1137    =head2 rec
1138    
1139    syntaxtic sugar for
1140    
1141      @v = rec('200')
1142      @v = rec('200','a')
1143    
1144    If rec() returns just single value, it will
1145    return scalar, not array.
1146    
1147    =cut
1148    
1149    sub rec {
1150            my @out;
1151            if ($#_ == 0) {
1152                    @out = rec1(@_);
1153            } elsif ($#_ == 1) {
1154                    @out = rec2(@_);
1155            }
1156            if ($#out == 0 && ! wantarray) {
1157                    return $out[0];
1158            } elsif (@out) {
1159                    return @out;
1160          } else {          } else {
1161                  return '';                  return '';
1162          }          }
1163  }  }
1164    
1165    =head2 frec
1166    
1167    Returns first value from field
1168    
1169      $v = frec('200');
1170      $v = frec('200','a');
1171    
1172    =cut
1173    
1174    sub frec {
1175            my @out = rec(@_);
1176            warn "rec(",dump(@_),") has more than one return value, ignoring\n" if $#out > 0;
1177            return shift @out;
1178    }
1179    
1180    =head2 frec_eq
1181    
1182    =head2 frec_ne
1183    
1184    Check if first values from two fields are same or different
1185    
1186      if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
1187            # values are same
1188      } else {
1189        # values are different
1190      }
1191    
1192    Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
1193    could write something like:
1194    
1195      if ( frec( '900','a' ) eq frec( '910','c' ) ) {
1196            # yada tada
1197      }
1198    
1199    but you can't since our parser L<WebPAC::Parser> will remove all whitespaces
1200    in order to parse text and create invalid function C<eqfrec>.
1201    
1202    =cut
1203    
1204    sub frec_eq {
1205            my ( $f1,$sf1, $f2, $sf2 ) = @_;
1206            return (rec( $f1, $sf1 ))[0] eq (rec( $f2, $sf2 ))[0];
1207    }
1208    
1209    sub frec_ne {
1210            return ! frec_eq( @_ );
1211    }
1212    
1213    =head2 regex
1214    
1215    Apply regex to some or all values
1216    
1217      @v = regex( 's/foo/bar/g', @v );
1218    
1219    =cut
1220    
1221    sub regex {
1222            my $r = shift;
1223            my @out;
1224            #warn "r: $r\n", dump(\@_);
1225            foreach my $t (@_) {
1226                    next unless ($t);
1227                    eval "\$t =~ $r";
1228                    push @out, $t if ($t && $t ne '');
1229            }
1230            return @out;
1231    }
1232    
1233    =head2 prefix
1234    
1235  =head2 apply_format  Prefix all values with a string
1236    
1237  Apply format specified in tag with C<format_name="name"> and    @v = prefix( 'my_', @v );
 C<format_delimiter=";;">.  
1238    
1239   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
1240    
1241    sub prefix {
1242            my $p = shift;
1243            return @_ unless defined( $p );
1244            return map { $p . $_ } grep { defined($_) } @_;
1245    }
1246    
1247  Formats can contain C<lookup{...}> if you need them.  =head2 suffix
1248    
1249    suffix all values with a string
1250    
1251      @v = suffix( '_my', @v );
1252    
1253  =cut  =cut
1254    
1255  sub apply_format {  sub suffix {
1256          my $self = shift;          my $s = shift;
1257            return @_ unless defined( $s );
1258            return map { $_ . $s } grep { defined($_) } @_;
1259    }
1260    
1261          my ($name,$delimiter,$data) = @_;  =head2 surround
1262    
1263          my $log = $self->_get_logger();  surround all values with a two strings
1264    
1265      @v = surround( 'prefix_', '_suffix', @v );
1266    
1267    =cut
1268    
1269    sub surround {
1270            my $p = shift;
1271            my $s = shift;
1272            $p = '' unless defined( $p );
1273            $s = '' unless defined( $s );
1274            return map { $p . $_ . $s } grep { defined($_) } @_;
1275    }
1276    
1277    =head2 first
1278    
1279    Return first element
1280    
1281      $v = first( @v );
1282    
1283    =cut
1284    
1285    sub first {
1286            my $r = shift;
1287            return $r;
1288    }
1289    
1290          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =head2 lookup
1291                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
1292                  return $data;  Consult lookup hashes for some value
1293    
1294      @v = lookup(
1295            sub {
1296                    'ffkk/peri/mfn'.rec('000')
1297            },
1298            'ffkk','peri','200-a-200-e',
1299            sub {
1300                    first(rec(200,'a')).' '.first(rec('200','e'))
1301            }
1302      );
1303    
1304    Code like above will be B<automatically generated> using L<WebPAC::Parse> from
1305    normal lookup definition in C<conf/lookup/something.pl> which looks like:
1306    
1307      lookup(
1308            # which results to return from record recorded in lookup
1309            sub { 'ffkk/peri/mfn' . rec('000') },
1310            # from which database and input
1311            'ffkk','peri',
1312            # such that following values match
1313            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
1314            # if this part is missing, we will try to match same fields
1315            # from lookup record and current one, or you can override
1316            # which records to use from current record using
1317            sub { rec('900','x') . ' ' . rec('900','y') },
1318      )
1319    
1320    You can think about this lookup as SQL (if that helps):
1321    
1322      select
1323            sub { what }
1324      from
1325            database, input
1326      where
1327        sub { filter from lookuped record }
1328      having
1329        sub { optional filter on current record }
1330    
1331    Easy as pie, right?
1332    
1333    =cut
1334    
1335    sub lookup {
1336            my ($what, $database, $input, $key, $having) = @_;
1337    
1338            confess "lookup needs 5 arguments: what, database, input, key, having\n" unless ($#_ == 4);
1339    
1340            warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
1341            return unless (defined($lookup->{$database}->{$input}->{$key}));
1342    
1343            confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
1344    
1345            my $mfns;
1346            my @having = $having->();
1347    
1348            warn "## having = ", dump( @having ) if ($debug > 2);
1349    
1350            foreach my $h ( @having ) {
1351                    if (defined($lookup->{$database}->{$input}->{$key}->{$h})) {
1352                            warn "lookup for $database/$input/$key/$h return ",dump($lookup->{$database}->{$input}->{$key}->{$h}),"\n" if ($debug);
1353                            $mfns->{$_}++ foreach keys %{ $lookup->{$database}->{$input}->{$key}->{$h} };
1354                    }
1355          }          }
1356    
1357          $log->warn("no delimiter for format $name") if (! $delimiter);          return unless ($mfns);
1358    
1359            my @mfns = sort keys %$mfns;
1360    
1361            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
1362    
1363            my $old_rec = $rec;
1364            my @out;
1365    
1366            foreach my $mfn (@mfns) {
1367                    $rec = $load_row_coderef->( $database, $input, $mfn );
1368    
1369                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
1370    
1371          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");                  my @vals = $what->();
1372    
1373          my @data = split(/\Q$delimiter\E/, $data);                  push @out, ( @vals );
1374    
1375          my $out = sprintf($format, @data);                  warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1376          $log->debug("using format $name [$format] on $data to produce: $out");          }
1377    
1378    #       if (ref($lookup->{$k}) eq 'ARRAY') {
1379    #               return @{ $lookup->{$k} };
1380    #       } else {
1381    #               return $lookup->{$k};
1382    #       }
1383    
1384            $rec = $old_rec;
1385    
1386            warn "## lookup returns = ", dump(@out), $/ if ($debug);
1387    
1388          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          if ($#out == 0) {
1389                  return $self->{'lookup'}->lookup($out);                  return $out[0];
1390          } else {          } else {
1391                  return $out;                  return @out;
1392          }          }
1393    }
1394    
1395    =head2 save_into_lookup
1396    
1397    Save value into lookup. It associates current database, input
1398    and specific keys with one or more values which will be
1399    associated over MFN.
1400    
1401    MFN will be extracted from first occurence current of field 000
1402    in current record, or if it doesn't exist from L<_set_config> C<_mfn>.
1403    
1404      my $nr = save_into_lookup($database,$input,$key,sub {
1405            # code which produce one or more values
1406      });
1407    
1408    It returns number of items saved.
1409    
1410    This function shouldn't be called directly, it's called from code created by
1411    L<WebPAC::Parser>.
1412    
1413    =cut
1414    
1415    sub save_into_lookup {
1416            my ($database,$input,$key,$coderef) = @_;
1417            die "save_into_lookup needs database" unless defined($database);
1418            die "save_into_lookup needs input" unless defined($input);
1419            die "save_into_lookup needs key" unless defined($key);
1420            die "save_into_lookup needs CODE" unless ( defined($coderef) && ref($coderef) eq 'CODE' );
1421    
1422            warn "## save_into_lookup rec = ", dump($rec), " config = ", dump($config), $/ if ($debug > 2);
1423    
1424            my $mfn =
1425                    defined($rec->{'000'}->[0])     ?       $rec->{'000'}->[0]      :
1426                    defined($config->{_mfn})        ?       $config->{_mfn}         :
1427                                                                                    die "mfn not defined or zero";
1428    
1429            my $nr = 0;
1430    
1431            foreach my $v ( $coderef->() ) {
1432                    $lookup->{$database}->{$input}->{$key}->{$v}->{$mfn}++;
1433                    warn "# saved lookup $database/$input/$key [$v] $mfn\n" if ($debug > 1);
1434                    $nr++;
1435            }
1436    
1437            return $nr;
1438  }  }
1439    
1440  =head2 sort_arr  =head2 config
1441    
1442    Consult config values stored in C<config.yml>
1443    
1444  Sort array ignoring case and html in data    # return database code (key under databases in yaml)
1445      $database_code = config();    # use _ from hash
1446      $database_name = config('name');
1447      $database_input_name = config('input name');
1448    
1449   my @sorted = $webpac->sort_arr(@unsorted);  Up to three levels are supported.
1450    
1451  =cut  =cut
1452    
1453  sub sort_arr {  sub config {
1454          my $self = shift;          return unless ($config);
1455    
1456            my $p = shift;
1457    
1458            $p ||= '';
1459    
1460            my $v;
1461    
1462          my $log = $self->_get_logger();          warn "### getting config($p)\n" if ($debug > 1);
1463    
1464          # FIXME add Schwartzian Transformation?          my @p = split(/\s+/,$p);
1465            if ($#p < 0) {
1466                    $v = $config->{ '_' };  # special, database code
1467            } else {
1468    
1469                    my $c = dclone( $config );
1470    
1471          my @sorted = sort {                  foreach my $k (@p) {
1472                  $a =~ s#<[^>]+/*>##;                          warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
1473                  $b =~ s#<[^>]+/*>##;                          if (ref($c) eq 'ARRAY') {
1474                  lc($b) cmp lc($a)                                  $c = shift @$c;
1475          } @_;                                  warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
1476          $log->debug("sorted values: ",sub { join(", ",@sorted) });                                  last;
1477                            }
1478    
1479          return @sorted;                          if (! defined($c->{$k}) ) {
1480                                    $c = undef;
1481                                    last;
1482                            } else {
1483                                    $c = $c->{$k};
1484                            }
1485                    }
1486                    $v = $c if ($c);
1487    
1488            }
1489    
1490            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
1491            warn "config( '$p' ) is empty\n" if (! $v);
1492    
1493            return $v;
1494  }  }
1495    
1496    =head2 id
1497    
1498  =head1 INTERNAL METHODS  Returns unique id of this record
1499    
1500  =head2 _sort_by_order    $id = id();
1501    
1502  Sort xml tags data structure accoding to C<order=""> attribute.  Returns C<42/2> for 2nd occurence of MFN 42.
1503    
1504  =cut  =cut
1505    
1506  sub _sort_by_order {  sub id {
1507          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
1508            return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';
1509    }
1510    
1511    =head2 join_with
1512    
1513          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};  
1514    
1515          return $va <=> $vb;    $v = join_with(", ", @v);
1516    
1517    =cut
1518    
1519    sub join_with {
1520            my $d = shift;
1521            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
1522            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
1523            return '' unless defined($v);
1524            return $v;
1525  }  }
1526    
1527  =head2 _x  =head2 split_rec_on
1528    
1529  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).  
1530    
1531   my $text = $n->_x('normalize text string');    $a_before_semi_column =
1532            split_rec_on('200','a', /\s*;\s*/, $part);
1533    
1534  This is a stub so that other modules doesn't have to implement it.  C<$part> is optional number of element. First element is
1535    B<1>, not 0!
1536    
1537    If there is no C<$part> parameter or C<$part> is 0, this function will
1538    return all values produced by splitting.
1539    
1540  =cut  =cut
1541    
1542  sub _x {  sub split_rec_on {
1543          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
1544          return shift;  
1545            my ($fld, $sf, $regex, $part) = @_;
1546            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
1547    
1548            my @r = rec( $fld, $sf );
1549            my $v = shift @r;
1550            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
1551    
1552            return '' if ( ! defined($v) || $v =~ /^\s*$/);
1553    
1554            my @s = split( $regex, $v );
1555            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
1556            if ($part && $part > 0) {
1557                    return $s[ $part - 1 ];
1558            } else {
1559                    return @s;
1560            }
1561  }  }
1562    
1563    my $hash;
1564    
1565    =head2 set
1566    
1567      set( key => 'value' );
1568    
1569    =cut
1570    
1571    sub set {
1572            my ($k,$v) = @_;
1573            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
1574            $hash->{$k} = $v;
1575    };
1576    
1577    =head2 get
1578    
1579  =head1 AUTHOR    get( 'key' );
1580    
1581  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
1582    
1583  =head1 COPYRIGHT & LICENSE  sub get {
1584            my $k = shift || return;
1585            my $v = $hash->{$k};
1586            warn "## get $k = ", dump( $v ), $/ if ( $debug );
1587            return $v;
1588    }
1589    
1590  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 count
1591    
1592  This program is free software; you can redistribute it and/or modify it    if ( count( @result ) == 1 ) {
1593  under the same terms as Perl itself.          # do something if only 1 result is there
1594      }
1595    
1596  =cut  =cut
1597    
1598  1; # End of WebPAC::DB  sub count {
1599            warn "## count ",dump(@_),$/ if ( $debug );
1600            return @_ . '';
1601    }
1602    
1603    # END
1604    1;

Legend:
Removed from v.70  
changed lines
  Added in v.1019

  ViewVC Help
Powered by ViewVC 1.1.26