/[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 371 by dpavlin, Sun Jan 8 21:16:27 2006 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 blib;  
 use WebPAC::Common;  
 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    # debugging warn(s)
40    my $debug = 0;
41    
42  WebPAC::Normalize - data mungling for normalisation  use WebPAC::Normalize::ISBN;
43    push @EXPORT, ( 'isbn_10', 'isbn_13' );
44    
45  =head1 VERSION  =head1 NAME
46    
47  Version 0.08  WebPAC::Normalize - describe normalisaton rules using sets
48    
49  =cut  =cut
50    
51  our $VERSION = '0.08';  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  It contains several assumptions:  =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  =over    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  =item *  Options C<row>, C<rules> and C<log> are mandatory while all
89    other are optional.
90    
91  format of fields is defined using C<v123^a> notation for repeatable fields  C<load_row_coderef> is closure only used when executing lookups, so they will
92  or C<s123^a> for single (or first) value, where C<123> is field number and  die if it's not defined.
 C<a> is subfield.  
93    
94  =item *  This function will B<die> if normalizastion can't be evaled.
95    
96  source data records (C<$rec>) have unique identifiers in field C<000>  Since this function isn't exported you have to call it with
97    C<WebPAC::Normalize::data_structure>.
98    
99  =item *  =cut
100    
101  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  my $load_row_coderef;
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
102    
103  =item *  sub data_structure {
104            my $arg = {@_};
105    
106  optional C<filter{filter_name}> at B<begining of format> will apply perl          die "need row argument" unless ($arg->{row});
107  code defined as code ref on format after field substitution to producing          die "need normalisation argument" unless ($arg->{rules});
 output  
108    
109  There is one built-in filter called C<regex> which can be use like this:          _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    filter{regex(s/foo/bar/)}          return _get_ds();
121    }
122    
123  =item *  =head2 _set_ds
124    
125  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  Set current record hash
126    
127  =item *    _set_ds( $rec );
128    
129  at end, optional C<format>s rules are resolved. Format rules are similar to  =cut
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
130    
131  =back  my $rec;
132    
133  This also describes order in which transformations are applied (eval,  sub _set_ds {
134  filter, lookup, format) which is important to undestand when deciding how to          $rec = shift or die "no record hash";
135  solve your data mungling and normalisation process.  }
136    
137    =head2 _set_config
138    
139    Set current config hash
140    
141      _set_config( $config );
142    
143  =head1 FUNCTIONS  Magic keys are:
144    
145  =head2 new  =over 4
146    
147  Create new normalisation object  =item _
148    
149    my $n = new WebPAC::Normalize::Something(  Code of current database
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
150    
151  Parametar C<filter> defines user supplied snippets of perl code which can  =item _mfn
 be use with C<filter{...}> notation.  
152    
153  C<prefix> is used to form filename for database record (to support multiple  Current MFN
 source files which are joined in one database).  
154    
155  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  =back
 in structures. If you pass this parametar, you must also pass C<lookup>  
 which is C<WebPAC::Lookup> object.  
156    
157  =cut  =cut
158    
159  sub new {  my $config;
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
160    
161          my $r = $self->{'lookup_regex'} ? 1 : 0;  sub _set_config {
162          my $l = $self->{'lookup'} ? 1 : 0;          $config = shift;
163    }
164    
165          my $log = $self->_get_logger();  =head2 _get_ds
166    
167          # those two must be in pair  Return hash formatted as data structure
         if ( ($r & $l) != ($r || $l) ) {  
                 my $log = $self->_get_logger();  
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
168    
169          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));    my $ds = _get_ds();
170    
171          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  =cut
172    
173          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader);
174    my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
175    
176          if (! $self->{filter} || ! $self->{filter}->{regex}) {  sub _get_ds {
177                  $log->debug("adding built-in filter regex");  #warn "## out = ",dump($out);
178                  $self->{filter}->{regex} = sub {          return $out;
179                          my ($val, $regex) = @_;  }
180                          eval "\$val =~ $regex";  
181                          return $val;  =head2 _clean_ds
                 };  
         }  
182    
183          $self ? return $self : return undef;  Clean data structure hash for next record
184    
185      _clean_ds();
186    
187    =cut
188    
189    sub _clean_ds {
190            my $a = {@_};
191            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader) = ();
192            ($marc_record_offset, $marc_fetch_offset) = (0,0);
193            $marc_encoding = $a->{marc_encoding};
194  }  }
195    
196    =head2 _set_lookup
197    
198  =head2 data_structure  Set current lookup hash
199    
200  Create in-memory data structure which represents normalized layout from    _set_lookup( $lookup );
 C<conf/normalize/*.xml>.  
201    
202  This structures are used to produce output.  =cut
203    
204   my $ds = $webpac->data_structure($rec);  my $lookup;
205    
206    sub _set_lookup {
207            $lookup = shift;
208    }
209    
210    =head2 _get_lookup
211    
212    Get current lookup hash
213    
214      my $lookup = _get_lookup();
215    
216  =cut  =cut
217    
218  sub data_structure {  sub _get_lookup {
219          my $self = shift;          return $lookup;
220    }
221    
222          my $log = $self->_get_logger();  =head2 _set_load_row
223    
224          my $rec = shift;  Setup code reference which will return L<data_structure> from
225          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  L<WebPAC::Store>
226    
227          $log->debug("data_structure rec = ", sub { Dumper($rec) });    _set_load_row(sub {
228                    my ($database,$input,$mfn) = @_;
229                    $store->load_row( database => $database, input => $input, id => $mfn );
230      });
231    
232          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));  =cut
233    
234          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  sub _set_load_row {
235            my $coderef = shift;
236            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
237    
238          my $cache_file;          $load_row_coderef = $coderef;
239    }
240    
241          if ($self->{'db'}) {  =head2 _get_marc_fields
                 my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );  
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });  
                 return $ds if ($ds);  
                 $log->debug("cache miss, creating");  
         }  
242    
243          my @sorted_tags;  Get all fields defined by calls to C<marc>
244          if ($self->{tags_by_order}) {  
245                  @sorted_tags = @{$self->{tags_by_order}};          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
246          } else {  
247                  @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  We are using I<magic> which detect repeatable fields only from
248                  $self->{tags_by_order} = \@sorted_tags;  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      marc_repeatable_subfield('900','a');
273      marc('900','a', rec('200','a') );
274      marc('900','b', rec('200','b') );
275      marc('900','c', rec('200','c') );
276    
277    will create:
278    
279      900a-1 900a-2 900a-3 900b-1 900c-1
280      900b-2
281    
282    There is also support for returning next or specific using:
283    
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          my $ds;          return if (! $marc_record || ref($marc_record) ne 'ARRAY');
310    
311          $log->debug("tags: ",sub { join(", ",@sorted_tags) });          warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
312    
313          foreach my $field (@sorted_tags) {          my $marc_rec = $marc_record->[ $fetch_pos ];
314    
315                  my $row;          warn "## _get_marc_fields (at offset: $fetch_pos) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
316    
317  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});          return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);
318    
319                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {          # first, sort all existing fields
320                          my $format;          # 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                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');          @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
326                          $format = $tag->{'value'} || $tag->{'content'};          
327            # output marc fields
328            my @m;
329    
330                          my @v;          # count unique field-subfields (used for offset when walking to next subfield)
331                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          my $u;
332                                  @v = $self->fill_in_to_arr($rec,$format);          map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
333                          } else {  
334                                  @v = $self->parse_to_arr($rec,$format);          if ($debug) {
335                          }                  warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
336                          if (! @v) {                  warn "## marc_record[$fetch_pos] = ", dump( $marc_rec ), $/;
337                                  $log->debug("$field <",$self->{tag},"> format: $format no values");                  warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
338  #                               next;                  warn "## subfield count = ", dump( $u ), $/;
339                          } else {          }
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
340    
341                          if ($tag->{'sort'}) {          my $len = $#sorted_marc_record;
342                                  @v = $self->sort_arr(@v);          my $visited;
343                          }          my $i = 0;
344            my $field;
345    
346                          # use format?          foreach ( 0 .. $len ) {
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
347    
348                          # delimiter will join repeatable fields                  # find next element which isn't visited
349                          if ($tag->{'delimiter'}) {                  while ($visited->{$i}) {
350                                  @v = ( join($tag->{'delimiter'}, @v) );                          $i = ($i + 1) % ($len + 1);
351                          }                  }
352    
353                          # default types                  # mark it visited
354                          my @types = qw(display search);                  $visited->{$i}++;
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("tag $field / $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;  
355    
356                                  } else {                  my $row = dclone( $sorted_marc_record[$i] );
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
357    
358                    # 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                  }                  }
371    
372                  if ($row) {                  # if field exists
373                          $row->{'tag'} = $field;                  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    
394                          # TODO: name_sigular, name_plural                          } else {
395                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};                                  # append new subfields to existing field
396                          my $row_name = $name ? $self->_x($name) : $field;                                  push @$field, ( $row->[3], $row->[4] );
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
397                          }                          }
398                    } else {
399                            # insert first field
400                            $field = $row;
401                    }
402    
403                          $ds->{$row_name} = $row;                  if (! $marc_repeatable_subfield->{ $fsf }) {
404                            # make step to next subfield
405                          $log->debug("row $field: ",sub { Dumper($row) });                          $i = ($i + $u->{ $fsf } ) % ($len + 1);
406                  }                  }
407            }
408    
409            if ($#$field >= 0) {
410                    push @m, $field;
411                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
412          }          }
413    
414          $self->{'db'}->save_ds(          return \@m;
415                  id => $id,  }
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
416    
417          $log->debug("ds: ", sub { Dumper($ds) });  =head2 _get_marc_leader
418    
419          $log->logconfess("data structure returned is not array any more!") if wantarray;  Return leader from currently fetched record by L</_get_marc_fields>
420    
421          return $ds;    print WebPAC::Normalize::_get_marc_leader();
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  =head2 parse  =head2 _debug
431    
432  Perform smart parsing of string, skipping delimiters for fields which aren't  Change level of debug warnings
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
433    
434   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    _debug( 2 );
435    
436  Filters are implemented here. While simple form of filters looks like this:  =cut
437    
438    filter{name_of_filter}  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    Those functions generally have to first in your normalization file.
448    
449  but, filters can also have variable number of parametars like this:  =head2 search_display
450    
451    Define output for L<search> and L<display> at the same time
452    
453      search_display('Title', rec('200','a') );
454    
   filter{name_of_filter(param,param,param)}  
455    
456  =cut  =cut
457    
458  my $warn_once;  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  sub parse {  =head2 tag
         my $self = shift;  
467    
468          my ($rec, $format_utf8, $i, $rec_size) = @_;  Old name for L<search_display>, but supported
469    
470          return if (! $format_utf8);  =cut
471    
472          my $log = $self->_get_logger();  sub tag {
473            search_display( @_ );
474    }
475    
476          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 display
477    
478          $i = 0 if (! $i);  Define output just for I<display>
479    
480          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});    @v = display('Title', rec('200','a') );
481    
482          my @out;  =cut
483    
484          $log->debug("format: $format [$i]");  sub _field {
485            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          my $eval_code;  sub display { _field( 'display', @_ ) }
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
493    
494          my $filter_name;  =head2 search
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
495    
496          # did we found any (att all) field from format in row?  Prepare values just for I<search>
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
497    
498          my $f_step = 1;    @v = search('Title', rec('200','a') );
499    
500          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
501    
502                  my $del = $1 || '';  sub search { _field( 'search', @_ ) }
                 $prefix = $del if ($f_step == 1);  
503    
504                  my $fld_type = lc($2);  =head2 sorted
505    
506                  # repeatable index  Insert into lists which will be automatically sorted
507                  my $r = $i;  
508                  if ($fld_type eq 's') {   sorted('Title', rec('200','a') );
509                          if ($found_any->{'v'}) {  
510                                  $r = 0;  =cut
511                          } else {  
512                                  return;  sub sorted { _field( 'sorted', @_ ) }
513                          }  
514                  }  
515    =head2 marc_leader
516    
517    Setup fields within MARC leader or get leader
518    
519      marc_leader('05','c');
520      my $leader = marc_leader();
521    
522                  my $found = 0;  =cut
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
523    
524                  if ($found) {  sub marc_leader {
525                          $found_any->{$fld_type} += $found;          my ($offset,$value) = @_;
526    
527                          # we will skip delimiter before first occurence of field!          if ($offset) {
528                          push @out, $del unless($found_any->{$fld_type} == 1);                  $marc_leader->[ $marc_record_offset ]->{ $offset } = $value;
529                          push @out, $tmp;          } else {
530                    
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                  }                  }
                 $f_step++;  
537          }          }
538    }
539    
540    =head2 marc_fixed
541    
542    Create control/indentifier fields with values in fixed positions
543    
544          # test if any fields found?    marc_fixed('008', 00, '070402');
545          return if (! $found_any->{'v'} && ! $found_any->{'s'});    marc_fixed('008', 39, '|');
546    
547          my $out = join('',@out);  Positions not specified will be filled with spaces (C<0x20>).
548    
549          if ($out) {  There will be no effort to extend last specified value to full length of
550                  # add rest of format (suffix)  field in standard.
                 $out .= $format;  
551    
552                  # add prefix if not there  =cut
553                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
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                  $log->debug("result: $out");          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          if ($eval_code) {  =head2 marc
584                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
585                  $log->debug("about to eval{$eval} format: $out");  Save value for MARC field
586                  return if (! $self->_eval($eval));  
587      marc('900','a', rec('200','a') );
588      marc('001', rec('000') );
589    
590    =cut
591    
592    sub marc {
593            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) {          foreach (@_) {
602                  my @filter_args;                  my $v = $_;             # make var read-write for Encode
603                  if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {                  next unless (defined($v) && $v !~ /^\s*$/);
604                          @filter_args = split(/,/, $2);                  my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
605                  }                  if (defined $sf) {
606                  if ($self->{'filter'}->{$filter_name}) {                          push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];
607                          $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));                  } else {
608                          unshift @filter_args, $out;                          push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
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    =head2 marc_compose
650    
651          my ($rec, $format_utf8) = @_;  Save values for each MARC subfield explicitly
652    
653          my $log = $self->_get_logger();    marc_compose('900',
654            'a', rec('200','a')
655            'b', rec('201','a')
656            'a', rec('200','b')
657            'c', rec('200','c')
658      );
659    
660          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  If you specify C<+> for subfield, value will be appended
661          return if (! $format_utf8);  to previous defined subfield.
662    
663          my $i = 0;  =cut
664          my @arr;  
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            my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
670            my $m = [ $f, $i1, $i2 ];
671    
672          my $rec_size = { '_' => '_' };          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
673    
674          while (my $v = $self->parse($rec,$format_utf8,$i++,\$rec_size)) {          if ($#_ % 2 != 1) {
675                  push @arr, $v;                  die "ERROR: marc_compose",dump($f,@_)," not valid (must be even).\nDo you need to add first() or join() around some argument?\n";
                 warn "parse rec_size = ", Dumper($rec_size);  
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    Remove some field or subfield from MARC record.
721    
722      marc_remove('200');
723      marc_remove('200','a');
724    
725    This will erase field C<200> or C<200^a> from current MARC record.
726    
727      marc_remove('*');
728    
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
738    
739    sub marc_remove {
740            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            warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
747    
748            if ($f eq '*') {
749    
750                    delete( $marc_record->[ $marc_record_offset ] );
751                    warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
752    
753            } else {
754    
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  =head2 fill_in                  warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
786    
787  Workhourse of all: takes record from in-memory structure of database and                  $marc_record->[ $marc_record_offset ] = $marc;
788  strings with placeholders and returns string or array of with substituted          }
 values from record.  
789    
790   my $text = $webpac->fill_in($rec,'v250^a');          warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
791    }
792    
793  Optional argument is ordinal number for repeatable fields. By default,  =head2 marc_original_order
 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.  
794    
795   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  Copy all subfields preserving original order to marc field.
796    
797  This function B<does not> perform parsing of format to inteligenty skip    marc_original_order( marc_field_number, original_input_field_number );
 delimiters before fields which aren't used.  
798    
799  This method will automatically decode UTF-8 string to local code page  Please note that field numbers are consistent with other commands (marc
800  if needed.  field number first), but somewhat counter-intuitive (destination and then
801    source).
802    
803  There is optional parametar C<$record_size> which can be used to get sizes of  You might want to use this command if you are just renaming subfields or
804  all C<field^subfield> combinations in this format.  using pre-processing modify_record in C<config.yml> and don't need any
805    post-processing or want to preserve order of original subfields.
806    
  my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);  
807    
808  =cut  =cut
809    
810  sub fill_in {  sub marc_original_order {
811          my $self = shift;  
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 $log = $self->_get_logger();          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          my ($rec,$format,$i,$rec_size) = @_;          foreach my $d (@$r) {
824    
825          $log->logconfess("need data record") unless ($rec);                  if (! defined($d->{subfields}) && ref($d->{subfields}) ne 'ARRAY') {
826          $log->logconfess("need format to parse") unless($format);                          warn "# marc_original_order($to,$from): field $from doesn't have subfields specification\n";
827                            next;
828                    }
829            
830                    my @sfs = @{ $d->{subfields} };
831    
832                    die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);
833    
834          # iteration (for repeatable fields)                  warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);
         $i ||= 0;  
835    
836          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));                  my $m = [ $to, $i1, $i2 ];
837    
838          # FIXME remove for speedup?                  while (my $sf = shift @sfs) {
839          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
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 {
850                                    die "field $from subfield '$sf' need occurence $offset which doesn't exist", dump($d->{$sf});
851                            }
852                            push @$m, ( $sf, $v ) if (defined($v));
853                    }
854    
855          if (utf8::is_utf8($format)) {                  if ($#{$m} > 2) {
856                  $format = $self->_x($format);                          push @{ $marc_record->[ $marc_record_offset ] }, $m;
857                    }
858          }          }
859    
860          my $found = 0;          warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1);
861          my $just_single = 1;  }
862    
863          my $eval_code;  =head2 marc_template
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
864    
865          my $filter_name;  =cut
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
866    
867          # do actual replacement of placeholders  sub marc_template {
868          # repeatable fields          my $args = {@_};
869          if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {          warn "## marc_template(",dump($args),")";
870                  $just_single = 0;  
871            foreach ( qw/subfields_rename marc_template/ ) {
872    #               warn "ref($_) = ",ref($args->{$_});
873                    die "$_ not ARRAY" if ref($args->{$_}) ne 'ARRAY';
874          }          }
875    
876          # non-repeatable fields          my $r = $rec->{ $args->{from} } || return;
877          if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {          die "record field ", $args->{from}, " isn't array ",dump( $rec ) unless (ref($r) eq 'ARRAY');
878                  return if ($i > 0 && $just_single);  
879            my @subfields_rename = @{ $args->{subfields_rename} };
880    #       warn "### subfields_rename [$#subfields_rename] = ",dump( @subfields_rename );
881    
882            confess "need mapping in pairs for subfields_rename"
883                    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 $m;
925    
926            foreach my $r ( @{ $rec->{ $args->{from} } } ) {
927    
928          if ($found) {                  my $i1 = $r->{i1} || ' ';
929                  $log->debug("format: $format");                  my $i2 = $r->{i2} || ' ';
930                  if ($eval_code) {                  $m = [ $args->{to}, $i1, $i2 ];
931                          my $eval = $self->fill_in($rec,$eval_code,$i);  
932                          return if (! $self->_eval($eval));                  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                            $to_count->{ $to_sf }++;
946                    }
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                  if ($filter_name && $self->{'filter'}->{$filter_name}) {  
986                          $log->debug("filter '$filter_name' for $format");                  warn "## template: |$template|\n## marc_template_order = ",dump( $marc_template_order );
987                          $format = $self->{'filter'}->{$filter_name}->($format);  
988                          return unless(defined($format));                  foreach my $sf ( @{ $marc_template_order->{$template} } ) {
989                          $log->debug("filter result: $format");                          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                  # do we have lookups?  
995                  if ($self->{'lookup'}) {                  warn "#### >>>> created marc: ", dump( $m );
996                          if ($self->{'lookup'}->can('lookup')) {  
997                                  my @lookup = $self->{lookup}->lookup($format);                  push @marc_out, $m;
998                                  $log->debug("lookup $format", join(", ", @lookup));          }
999                                  return @lookup;  
1000            warn "### marc_template produced: ",dump( @marc_out );
1001    
1002            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    =cut
1015    
1016    sub marc_count {
1017            return $#{ $marc_record };
1018    }
1019    
1020    
1021    =head1 Functions to extract data from input
1022    
1023    This function should be used inside functions to create C<data_structure> described
1024    above.
1025    
1026    =head2 _pack_subfields_hash
1027    
1028     @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
1035    
1036    sub _pack_subfields_hash {
1037    
1038            warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
1039    
1040            my ($h,$include_subfields) = @_;
1041    
1042            # sanity and ease of use
1043            return $h if (ref($h) ne 'HASH');
1044    
1045            if ( defined($h->{subfields}) ) {
1046                    my $sfs = delete $h->{subfields} || die "no subfields?";
1047                    my @out;
1048                    while (@$sfs) {
1049                            my $sf = shift @$sfs;
1050                            push @out, '^' . $sf if ($include_subfields);
1051                            my $o = shift @$sfs;
1052                            if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
1053                                    # single element subfields are not arrays
1054    #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
1055    
1056                                    push @out, $h->{$sf};
1057                          } else {                          } else {
1058                                  $log->warn("Have lookup object but can't invoke lookup method");  #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 {                  } else {
1065                          return $format;                          return @out;
1066                  }                  }
1067          } else {          } else {
1068                  return;                  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                            }
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  =head2 fill_in_to_arr    @v = rec1('200')
1090    
1091  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  TODO: order of values is probably same as in source data, need to investigate that
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
1092    
1093   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  =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 {
1106                                    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  =cut
1122    
1123  sub fill_in_to_arr {  sub rec2 {
1124          my $self = shift;          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 {
1132                            $_->{$sf};
1133                    }
1134            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
1135    }
1136    
1137          my ($rec, $format_utf8) = @_;  =head2 rec
1138    
1139          my $log = $self->_get_logger();  syntaxtic sugar for
1140    
1141          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = rec('200')
1142          return if (! $format_utf8);    @v = rec('200','a')
1143    
1144          my $i = 0;  If rec() returns just single value, it will
1145          my @arr;  return scalar, not array.
1146    
1147          my $rec_size;  =cut
1148    
1149          while (my $v = $self->fill_in($rec,$format_utf8,$i,\$rec_size)) {  sub rec {
1150                  push @arr, $v;          my @out;
1151                  warn "rec_size = ", Dumper($rec_size);          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 {
1161                    return '';
1162          }          }
1163    }
1164    
1165    =head2 frec
1166    
1167    Returns first value from field
1168    
1169          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);    $v = frec('200');
1170      $v = frec('200','a');
1171    
1172    =cut
1173    
1174          return @arr;  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 get_data  =head2 frec_ne
1183    
1184  Returns value from record.  Check if first values from two fields are same or different
1185    
1186   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);    if ( frec_eq( 900 => 'a', 910 => 'c' ) ) {
1187            # values are same
1188      } else {
1189        # values are different
1190      }
1191    
1192  Required arguments are:  Strictly speaking C<frec_eq> and C<frec_ne> wouldn't be needed if you
1193    could write something like:
1194    
1195  =over 8    if ( frec( '900','a' ) eq frec( '910','c' ) ) {
1196            # yada tada
1197      }
1198    
1199  =item C<$rec>  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  record reference  =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  =item C<$f>  sub frec_ne {
1210            return ! frec_eq( @_ );
1211    }
1212    
1213    =head2 regex
1214    
1215  field  Apply regex to some or all values
1216    
1217  =item C<$sf>    @v = regex( 's/foo/bar/g', @v );
1218    
1219  optional subfield  =cut
1220    
1221  =item C<$i>  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  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )  =head2 prefix
1234    
1235  =item C<$found>  Prefix all values with a string
1236    
1237  optional variable that will be incremeted if preset    @v = prefix( 'my_', @v );
1238    
1239  =item C<$rec_size>  =cut
1240    
1241  hash to hold maximum occurances of C<field^subfield> combinations  sub prefix {
1242  (which can be accessed using keys in same format)          my $p = shift;
1243            return @_ unless defined( $p );
1244            return map { $p . $_ } grep { defined($_) } @_;
1245    }
1246    
1247  =back  =head2 suffix
1248    
1249  Returns value or empty string, updates C<$found> and C<rec_size>  suffix all values with a string
1250  if present.  
1251      @v = suffix( '_my', @v );
1252    
1253  =cut  =cut
1254    
1255  sub get_data {  sub suffix {
1256          my $self = shift;          my $s = shift;
1257            return @_ unless defined( $s );
1258            return map { $_ . $s } grep { defined($_) } @_;
1259    }
1260    
1261          my ($rec,$f,$sf,$i,$found,$cache) = @_;  =head2 surround
1262    
1263          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');  surround all values with a two strings
1264    
1265          if (defined($$cache)) {    @v = surround( 'prefix_', '_suffix', @v );
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
         }  
1266    
1267          return '' unless ($$rec->{$f}->[$i]);  =cut
1268    
1269          {  sub surround {
1270                  no strict 'refs';          my $p = shift;
1271                  if (defined($sf)) {          my $s = shift;
1272                          $$found++ if (defined($$found) && $$rec->{$f}->[$i]->{$sf});          $p = '' unless defined( $p );
1273                          return $$rec->{$f}->[$i]->{$sf};          $s = '' unless defined( $s );
1274                  } else {          return map { $p . $_ . $s } grep { defined($_) } @_;
1275                          $$found++ if (defined($$found));  }
1276                          # it still might have subfields, just  
1277                          # not specified, so we'll dump some debug info  =head2 first
1278                          if ($$rec->{$f}->[$i] =~ /HASH/o) {  
1279                                  my $out;  Return first element
1280                                  foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
1281                                          $out .= '$' . $k .':' . $$rec->{$f}->[$i]->{$k}." ";    $v = first( @v );
1282                                  }  
1283                                  return $out;  =cut
1284                          } else {  
1285                                  return $$rec->{$f}->[$i];  sub first {
1286                          }          my $r = shift;
1287                  }          return $r;
         }  
1288  }  }
1289    
1290    =head2 lookup
1291    
1292  =head2 apply_format  Consult lookup hashes for some value
1293    
1294  Apply format specified in tag with C<format_name="name"> and    @v = lookup(
1295  C<format_delimiter=";;">.          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   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  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  Formats can contain C<lookup{...}> if you need them.    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  =cut
1334    
1335  sub apply_format {  sub lookup {
1336          my $self = shift;          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          my ($name,$delimiter,$data) = @_;          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
1344    
1345          my $log = $self->_get_logger();          my $mfns;
1346            my @having = $having->();
1347    
1348          if (! $self->{'import_xml'}->{'format'}->{$name}) {          warn "## having = ", dump( @having ) if ($debug > 2);
1349                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
1350                  return $data;          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 @vals = $what->();
1372    
1373                    push @out, ( @vals );
1374    
1375                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1376            }
1377    
1378          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  #       if (ref($lookup->{$k}) eq 'ARRAY') {
1379    #               return @{ $lookup->{$k} };
1380    #       } else {
1381    #               return $lookup->{$k};
1382    #       }
1383    
1384          my @data = split(/\Q$delimiter\E/, $data);          $rec = $old_rec;
1385    
1386          my $out = sprintf($format, @data);          warn "## lookup returns = ", dump(@out), $/ if ($debug);
         $log->debug("using format $name [$format] on $data to produce: $out");  
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  Sort array ignoring case and html in data  Consult config values stored in C<config.yml>
1443    
1444   my @sorted = $webpac->sort_arr(@unsorted);    # 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    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 $log = $self->_get_logger();          my $v;
1461    
1462            warn "### getting config($p)\n" if ($debug > 1);
1463    
1464            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                    foreach my $k (@p) {
1472                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
1473                            if (ref($c) eq 'ARRAY') {
1474                                    $c = shift @$c;
1475                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
1476                                    last;
1477                            }
1478    
1479                            if (! defined($c->{$k}) ) {
1480                                    $c = undef;
1481                                    last;
1482                            } else {
1483                                    $c = $c->{$k};
1484                            }
1485                    }
1486                    $v = $c if ($c);
1487    
1488          # FIXME add Schwartzian Transformation?          }
1489    
1490          my @sorted = sort {          warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
1491                  $a =~ s#<[^>]+/*>##;          warn "config( '$p' ) is empty\n" if (! $v);
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
1492    
1493          return @sorted;          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    Joins walues with some delimiter
1514    
1515          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||    $v = join_with(", ", @v);
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
1516    
1517          return $va <=> $vb;  =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    Split record subfield on some regex and take one of parts out
1530    
1531  Convert strings from C<conf/normalize/*.xml> encoding into application    $a_before_semi_column =
1532  specific encoding (optinally specified using C<code_page> to C<new>          split_rec_on('200','a', /\s*;\s*/, $part);
 constructor).  
1533    
1534   my $text = $n->_x('normalize text string');  C<$part> is optional number of element. First element is
1535    B<1>, not 0!
1536    
1537  This is a stub so that other modules doesn't have to implement it.  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  =head1 AUTHOR    set( key => 'value' );
1568    
1569  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
1570    
1571  =head1 COPYRIGHT & LICENSE  sub set {
1572            my ($k,$v) = @_;
1573            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
1574            $hash->{$k} = $v;
1575    };
1576    
1577  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 get
1578    
1579  This program is free software; you can redistribute it and/or modify it    get( 'key' );
 under the same terms as Perl itself.  
1580    
1581  =cut  =cut
1582    
1583  1; # End of WebPAC::Normalize  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    =head2 count
1591    
1592      if ( count( @result ) == 1 ) {
1593            # do something if only 1 result is there
1594      }
1595    
1596    =cut
1597    
1598    sub count {
1599            warn "## count ",dump(@_),$/ if ( $debug );
1600            return @_ . '';
1601    }
1602    
1603    # END
1604    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26