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

Legend:
Removed from v.74  
changed lines
  Added in v.1017

  ViewVC Help
Powered by ViewVC 1.1.26