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

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

  ViewVC Help
Powered by ViewVC 1.1.26