/[webpac2]/trunk/lib/WebPAC/Normalize.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Normalize.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 371 by dpavlin, Sun Jan 8 21:16:27 2006 UTC revision 912 by dpavlin, Tue Oct 30 17:40:13 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            search_display search display
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    
17            rec1 rec2 rec
18            regex prefix suffix surround
19            first lookup join_with
20            save_into_lookup
21    
22            split_rec_on
23    
24            get set
25            count
26    /;
27    
28  use warnings;  use warnings;
29  use strict;  use strict;
30  use blib;  
31  use WebPAC::Common;  #use base qw/WebPAC::Common/;
32  use base 'WebPAC::Common';  use Data::Dump qw/dump/;
33  use Data::Dumper;  use Storable qw/dclone/;
34    use Carp qw/confess/;
35    
36    # debugging warn(s)
37    my $debug = 0;
38    
39    
40  =head1 NAME  =head1 NAME
41    
42  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
43    
44  =head1 VERSION  =head1 VERSION
45    
46  Version 0.08  Version 0.30
47    
48  =cut  =cut
49    
50  our $VERSION = '0.08';  our $VERSION = '0.30';
51    
52  =head1 SYNOPSIS  =head1 SYNOPSIS
53    
54  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
55    from input records using perl functions which are specialized for set
56    processing.
57    
58    Sets are implemented as arrays, and normalisation file is valid perl, which
59    means that you check it's validity before running WebPAC using
60    C<perl -c normalize.pl>.
61    
62    Normalisation can generate multiple output normalized data. For now, supported output
63    types (on the left side of definition) are: C<search_display>, C<display>, C<search> and
64    C<marc>.
65    
66    =head1 FUNCTIONS
67    
68    Functions which start with C<_> are private and used by WebPAC internally.
69    All other functions are available for use within normalisation rules.
70    
71    =head2 data_structure
72    
73  It contains several assumptions:  Return data structure
74    
75  =over    my $ds = WebPAC::Normalize::data_structure(
76            lookup => $lookup_hash,
77            row => $row,
78            rules => $normalize_pl_config,
79            marc_encoding => 'utf-8',
80            config => $config,
81            load_row_coderef => sub {
82                    my ($database,$input,$mfn) = shift;
83                    $store->load_row( database => $database, input => $input, id => $mfn );
84            },
85      );
86    
87  =item *  Options C<row>, C<rules> and C<log> are mandatory while all
88    other are optional.
89    
90  format of fields is defined using C<v123^a> notation for repeatable fields  C<load_row_coderef> is closure only used when executing lookups, so they will
91  or C<s123^a> for single (or first) value, where C<123> is field number and  die if it's not defined.
 C<a> is subfield.  
92    
93  =item *  This function will B<die> if normalizastion can't be evaled.
94    
95  source data records (C<$rec>) have unique identifiers in field C<000>  Since this function isn't exported you have to call it with
96    C<WebPAC::Normalize::data_structure>.
97    
98  =item *  =cut
99    
100  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  my $load_row_coderef;
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
101    
102  =item *  sub data_structure {
103            my $arg = {@_};
104    
105  optional C<filter{filter_name}> at B<begining of format> will apply perl          die "need row argument" unless ($arg->{row});
106  code defined as code ref on format after field substitution to producing          die "need normalisation argument" unless ($arg->{rules});
 output  
107    
108  There is one built-in filter called C<regex> which can be use like this:          no strict 'subs';
109            _set_lookup( $arg->{lookup} ) if defined($arg->{lookup});
110            _set_rec( $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    filter{regex(s/foo/bar/)}          eval "$arg->{rules}";
116            die "error evaling $arg->{rules}: $@\n" if ($@);
117    
118  =item *          return _get_ds();
119    }
120    
121  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  =head2 _set_rec
122    
123  =item *  Set current record hash
124    
125  at end, optional C<format>s rules are resolved. Format rules are similar to    _set_rec( $rec );
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
126    
127  =back  =cut
128    
129  This also describes order in which transformations are applied (eval,  my $rec;
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
130    
131    sub _set_rec {
132            $rec = shift or die "no record hash";
133    }
134    
135    =head2 _set_config
136    
137    Set current config hash
138    
139  =head1 FUNCTIONS    _set_config( $config );
140    
141  =head2 new  Magic keys are:
142    
143  Create new normalisation object  =over 4
144    
145    my $n = new WebPAC::Normalize::Something(  =item _
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
146    
147  Parametar C<filter> defines user supplied snippets of perl code which can  Code of current database
 be use with C<filter{...}> notation.  
148    
149  C<prefix> is used to form filename for database record (to support multiple  =item _mfn
 source files which are joined in one database).  
150    
151  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Current MFN
152  in structures. If you pass this parametar, you must also pass C<lookup>  
153  which is C<WebPAC::Lookup> object.  =back
154    
155  =cut  =cut
156    
157  sub new {  my $config;
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
158    
159          my $r = $self->{'lookup_regex'} ? 1 : 0;  sub _set_config {
160          my $l = $self->{'lookup'} ? 1 : 0;          $config = shift;
161    }
162    
163          my $log = $self->_get_logger();  =head2 _get_ds
164    
165          # 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");  
         }  
166    
167          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));    my $ds = _get_ds();
168    
169          $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  =cut
170    
171          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader);
172    my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
173    
174          if (! $self->{filter} || ! $self->{filter}->{regex}) {  sub _get_ds {
175                  $log->debug("adding built-in filter regex");          return $out;
176                  $self->{filter}->{regex} = sub {  }
177                          my ($val, $regex) = @_;  
178                          eval "\$val =~ $regex";  =head2 _clean_ds
179                          return $val;  
180                  };  Clean data structure hash for next record
181          }  
182      _clean_ds();
183    
184          $self ? return $self : return undef;  =cut
185    
186    sub _clean_ds {
187            my $a = {@_};
188            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators, $marc_leader) = ();
189            ($marc_record_offset, $marc_fetch_offset) = (0,0);
190            $marc_encoding = $a->{marc_encoding};
191  }  }
192    
193    =head2 _set_lookup
194    
195  =head2 data_structure  Set current lookup hash
196    
197      _set_lookup( $lookup );
198    
199    =cut
200    
201    my $lookup;
202    
203    sub _set_lookup {
204            $lookup = shift;
205    }
206    
207  Create in-memory data structure which represents normalized layout from  =head2 _get_lookup
 C<conf/normalize/*.xml>.  
208    
209  This structures are used to produce output.  Get current lookup hash
210    
211   my $ds = $webpac->data_structure($rec);    my $lookup = _get_lookup();
212    
213  =cut  =cut
214    
215  sub data_structure {  sub _get_lookup {
216          my $self = shift;          return $lookup;
217    }
218    
219          my $log = $self->_get_logger();  =head2 _set_load_row
220    
221          my $rec = shift;  Setup code reference which will return L<data_structure> from
222          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  L<WebPAC::Store>
223    
224          $log->debug("data_structure rec = ", sub { Dumper($rec) });    _set_load_row(sub {
225                    my ($database,$input,$mfn) = @_;
226                    $store->load_row( database => $database, input => $input, id => $mfn );
227      });
228    
229          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));  =cut
230    
231          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  sub _set_load_row {
232            my $coderef = shift;
233            confess "argument isn't CODE" unless ref($coderef) eq 'CODE';
234    
235          my $cache_file;          $load_row_coderef = $coderef;
236    }
237    
238          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");  
         }  
239    
240          my @sorted_tags;  Get all fields defined by calls to C<marc>
241          if ($self->{tags_by_order}) {  
242                  @sorted_tags = @{$self->{tags_by_order}};          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
243          } else {  
244                  @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  We are using I<magic> which detect repeatable fields only from
245                  $self->{tags_by_order} = \@sorted_tags;  sequence of field/subfield data generated by normalization.
246    
247    Repeatable field is created when there is second occurence of same subfield or
248    if any of indicators are different.
249    
250    This is sane for most cases. Something like:
251    
252      900a-1 900b-1 900c-1
253      900a-2 900b-2
254      900a-3
255    
256    will be created from any combination of:
257    
258      900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
259    
260    and following rules:
261    
262      marc('900','a', rec('200','a') );
263      marc('900','b', rec('200','b') );
264      marc('900','c', rec('200','c') );
265    
266    which might not be what you have in mind. If you need repeatable subfield,
267    define it using C<marc_repeatable_subfield> like this:
268    
269      marc_repeatable_subfield('900','a');
270      marc('900','a', rec('200','a') );
271      marc('900','b', rec('200','b') );
272      marc('900','c', rec('200','c') );
273    
274    will create:
275    
276      900a-1 900a-2 900a-3 900b-1 900c-1
277      900b-2
278    
279    There is also support for returning next or specific using:
280    
281      while (my $mf = WebPAC::Normalize:_get_marc_fields( fetch_next => 1 ) ) {
282            # do something with $mf
283      }
284    
285    will always return fields from next MARC record or
286    
287      my $mf = WebPAC::Normalize::_get_marc_fields( offset => 42 );
288    
289    will return 42th copy record (if it exists).
290    
291    =cut
292    
293    my $fetch_pos;
294    
295    sub _get_marc_fields {
296    
297            my $arg = {@_};
298            warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2);
299            $fetch_pos = $marc_fetch_offset;
300            if ($arg->{offset}) {
301                    $fetch_pos = $arg->{offset};
302            } elsif($arg->{fetch_next}) {
303                    $marc_fetch_offset++;
304          }          }
305    
306          my $ds;          return if (! $marc_record || ref($marc_record) ne 'ARRAY');
307    
308          $log->debug("tags: ",sub { join(", ",@sorted_tags) });          warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
309    
310          foreach my $field (@sorted_tags) {          my $marc_rec = $marc_record->[ $fetch_pos ];
311    
312                  my $row;          warn "## _get_marc_fields (at offset: $fetch_pos) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
313    
314  #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);
315    
316                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {          # first, sort all existing fields
317                          my $format;          # XXX might not be needed, but modern perl might randomize elements in hash
318            my @sorted_marc_record = sort {
319                    $a->[0] . ( $a->[3] || '' ) cmp $b->[0] . ( $b->[3] || '')
320            } @{ $marc_rec };
321    
322                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');          @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
323                          $format = $tag->{'value'} || $tag->{'content'};          
324            # output marc fields
325            my @m;
326    
327                          my @v;          # count unique field-subfields (used for offset when walking to next subfield)
328                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          my $u;
329                                  @v = $self->fill_in_to_arr($rec,$format);          map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
330                          } else {  
331                                  @v = $self->parse_to_arr($rec,$format);          if ($debug) {
332                          }                  warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
333                          if (! @v) {                  warn "## marc_record[$fetch_pos] = ", dump( $marc_rec ), $/;
334                                  $log->debug("$field <",$self->{tag},"> format: $format no values");                  warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
335  #                               next;                  warn "## subfield count = ", dump( $u ), $/;
336                          } else {          }
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
337    
338                          if ($tag->{'sort'}) {          my $len = $#sorted_marc_record;
339                                  @v = $self->sort_arr(@v);          my $visited;
340                          }          my $i = 0;
341            my $field;
342    
343                          # use format?          foreach ( 0 .. $len ) {
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
344    
345                          # delimiter will join repeatable fields                  # find next element which isn't visited
346                          if ($tag->{'delimiter'}) {                  while ($visited->{$i}) {
347                                  @v = ( join($tag->{'delimiter'}, @v) );                          $i = ($i + 1) % ($len + 1);
348                          }                  }
349    
350                          # default types                  # mark it visited
351                          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;  
352    
353                                  } else {                  my $row = dclone( $sorted_marc_record[$i] );
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
354    
355                    # field and subfield which is key for
356                    # marc_repeatable_subfield and u
357                    my $fsf = $row->[0] . ( $row->[3] || '' );
358    
359                    if ($debug > 1) {
360    
361                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
362                            print "### this [$i]: ", dump( $row ),$/;
363                            print "### sf: ", $row->[3], " vs ", $field->[3],
364                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
365                                    if ($#$field >= 0);
366    
367                  }                  }
368    
369                  if ($row) {                  # if field exists
370                          $row->{'tag'} = $field;                  if ( $#$field >= 0 ) {
371                            if (
372                                    $row->[0] ne $field->[0] ||             # field
373                                    $row->[1] ne $field->[1] ||             # i1
374                                    $row->[2] ne $field->[2]                # i2
375                            ) {
376                                    push @m, $field;
377                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
378                                    $field = $row;
379    
380                            } elsif (
381                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
382                                    ||
383                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
384                                            ! $marc_repeatable_subfield->{ $fsf }
385                                    )
386                            ) {
387                                    push @m, $field;
388                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
389                                    $field = $row;
390    
391                          # TODO: name_sigular, name_plural                          } else {
392                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};                                  # append new subfields to existing field
393                          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");  
394                          }                          }
395                    } else {
396                            # insert first field
397                            $field = $row;
398                    }
399    
400                          $ds->{$row_name} = $row;                  if (! $marc_repeatable_subfield->{ $fsf }) {
401                            # make step to next subfield
402                          $log->debug("row $field: ",sub { Dumper($row) });                          $i = ($i + $u->{ $fsf } ) % ($len + 1);
403                  }                  }
404            }
405    
406            if ($#$field >= 0) {
407                    push @m, $field;
408                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
409          }          }
410    
411          $self->{'db'}->save_ds(          return \@m;
412                  id => $id,  }
413                  ds => $ds,  
414                  prefix => $self->{prefix},  =head2 _get_marc_leader
         ) if ($self->{'db'});  
415    
416          $log->debug("ds: ", sub { Dumper($ds) });  Return leader from currently fetched record by L</_get_marc_fields>
417    
418          $log->logconfess("data structure returned is not array any more!") if wantarray;    print WebPAC::Normalize::_get_marc_leader();
419    
420          return $ds;  =cut
421    
422    sub _get_marc_leader {
423            die "no fetch_pos, did you called _get_marc_fields first?" unless ( defined( $fetch_pos ) );
424            return $marc_leader->[ $fetch_pos ];
425  }  }
426    
427  =head2 parse  =head2 _debug
428    
429  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.  
430    
431   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    _debug( 2 );
432    
433  Filters are implemented here. While simple form of filters looks like this:  =cut
434    
435    filter{name_of_filter}  sub _debug {
436            my $l = shift;
437            return $debug unless defined($l);
438            warn "debug level $l",$/ if ($l > 0);
439            $debug = $l;
440    }
441    
442  but, filters can also have variable number of parametars like this:  =head1 Functions to create C<data_structure>
443    
444    filter{name_of_filter(param,param,param)}  Those functions generally have to first in your normalization file.
445    
446  =cut  =head2 search_display
447    
448  my $warn_once;  Define output for L<search> and L<display> at the same time
449    
450  sub parse {    search_display('Title', rec('200','a') );
         my $self = shift;  
451    
         my ($rec, $format_utf8, $i, $rec_size) = @_;  
452    
453          return if (! $format_utf8);  =cut
454    
455          my $log = $self->_get_logger();  sub search_display {
456            my $name = shift or die "search_display needs name as first argument";
457            my @o = grep { defined($_) && $_ ne '' } @_;
458            return unless (@o);
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 output 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}->{display} = \@o;
476    }
477    
478          my $eval_code;  =head2 search
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
479    
480          my $filter_name;  Prepare values just for I<search>
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
481    
482          # 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;  
483    
484          my $f_step = 1;  =cut
485    
486          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  sub search {
487            my $name = shift or die "search needs name as first argument";
488            my @o = grep { defined($_) && $_ ne '' } @_;
489            return unless (@o);
490            $out->{$name}->{search} = \@o;
491    }
492    
493                  my $del = $1 || '';  =head2 marc_leader
                 $prefix = $del if ($f_step == 1);  
494    
495                  my $fld_type = lc($2);  Setup fields within MARC leader or get leader
496    
497                  # repeatable index    marc_leader('05','c');
498                  my $r = $i;    my $leader = marc_leader();
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
                         } else {  
                                 return;  
                         }  
                 }  
499    
500                  my $found = 0;  =cut
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
501    
502                  if ($found) {  sub marc_leader {
503                          $found_any->{$fld_type} += $found;          my ($offset,$value) = @_;
504    
505                          # we will skip delimiter before first occurence of field!          if ($offset) {
506                          push @out, $del unless($found_any->{$fld_type} == 1);                  $marc_leader->[ $marc_record_offset ]->{ $offset } = $value;
507                          push @out, $tmp;          } else {
508                    
509                    if (defined($marc_leader)) {
510                            die "marc_leader not array = ", dump( $marc_leader ) unless (ref($marc_leader) eq 'ARRAY');
511                            return $marc_leader->[ $marc_record_offset ];
512                    } else {
513                            return;
514                  }                  }
                 $f_step++;  
515          }          }
516    }
517    
518          # test if any fields found?  =head2 marc_fixed
         return if (! $found_any->{'v'} && ! $found_any->{'s'});  
519    
520          my $out = join('',@out);  Create control/indentifier fields with values in fixed positions
521    
522          if ($out) {    marc_fixed('008', 00, '070402');
523                  # add rest of format (suffix)    marc_fixed('008', 39, '|');
                 $out .= $format;  
524    
525                  # add prefix if not there  Positions not specified will be filled with spaces (C<0x20>).
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
526    
527                  $log->debug("result: $out");  There will be no effort to extend last specified value to full length of
528    field in standard.
529    
530    =cut
531    
532    sub marc_fixed {
533            my ($f, $pos, $val) = @_;
534            die "need marc(field, position, value)" unless defined($f) && defined($pos);
535    
536            confess "need val" unless defined $val;
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          if ($eval_code) {  Save value for MARC field
564                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
565                  $log->debug("about to eval{$eval} format: $out");    marc('900','a', rec('200','a') );
566                  return if (! $self->_eval($eval));    marc('001', rec('000') );
567    
568    =cut
569    
570    sub marc {
571            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          my $rec_size = { '_' => '_' };          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
651    
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 (my $v = $self->parse($rec,$format_utf8,$i++,\$rec_size)) {          while (@_) {
657                  push @arr, $v;                  my $sf = shift;
658                  warn "parse rec_size = ", Dumper($rec_size);                  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  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.  
684    
685   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  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  This function B<does not> perform parsing of format to inteligenty skip  =head2 marc_remove
 delimiters before fields which aren't used.  
697    
698  This method will automatically decode UTF-8 string to local code page  Remove some field or subfield from MARC record.
 if needed.  
699    
700  There is optional parametar C<$record_size> which can be used to get sizes of    marc_remove('200');
701  all C<field^subfield> combinations in this format.    marc_remove('200','a');
702    
703   my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);  This will erase field C<200> or C<200^a> from current MARC record.
704    
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            die "marc_remove needs record number" unless defined($f);
721    
722          my $log = $self->_get_logger();          my $marc = $marc_record->[ $marc_record_offset ];
723    
724          my ($rec,$format,$i,$rec_size) = @_;          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
725    
726          $log->logconfess("need data record") unless ($rec);          if ($f eq '*') {
         $log->logconfess("need format to parse") unless($format);  
727    
728          # iteration (for repeatable fields)                  delete( $marc_record->[ $marc_record_offset ] );
729          $i ||= 0;                  warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
730    
731          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));          } else {
732    
733                    my $i = 0;
734                    foreach ( 0 .. $#{ $marc } ) {
735                            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          # FIXME remove for speedup?                  warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
764    
765          if (utf8::is_utf8($format)) {                  $marc_record->[ $marc_record_offset ] = $marc;
                 $format = $self->_x($format);  
766          }          }
767    
768          my $found = 0;          warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
769          my $just_single = 1;  }
770    
771          my $eval_code;  =head2 marc_original_order
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
772    
773          my $filter_name;  Copy all subfields preserving original order to marc field.
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
774    
775          # do actual replacement of placeholders    marc_original_order( marc_field_number, original_input_field_number );
         # repeatable fields  
         if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                 $just_single = 0;  
         }  
776    
777          # non-repeatable fields  Please note that field numbers are consistent with other commands (marc
778          if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  field number first), but somewhat counter-intuitive (destination and then
779                  return if ($i > 0 && $just_single);  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          if ($found) {          my ($to, $from) = @_;
791                  $log->debug("format: $format");          die "marc_original_order needs from and to fields\n" unless ($from && $to);
792                  if ($eval_code) {  
793                          my $eval = $self->fill_in($rec,$eval_code,$i);          return unless defined($rec->{$from});
794                          return if (! $self->_eval($eval));  
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                  if ($filter_name && $self->{'filter'}->{$filter_name}) {          
808                          $log->debug("filter '$filter_name' for $format");                  my @sfs = @{ $d->{subfields} };
809                          $format = $self->{'filter'}->{$filter_name}->($format);  
810                          return unless(defined($format));                  die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);
811                          $log->debug("filter result: $format");  
812                    warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);
813    
814                    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    
833                    if ($#{$m} > 2) {
834                            push @{ $marc_record->[ $marc_record_offset ] }, $m;
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    Return all values in some field
921    
922      @v = rec1('200')
923    
924  =head2 fill_in_to_arr  TODO: order of values is probably same as in source data, need to investigate that
925    
926  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  =cut
927  for fields which have lookups, so they shouldn't be parsed but rather  
928  C<fill_id>ed.  sub rec1 {
929            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    =head2 rec2
949    
950   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  Return all values in specific field and subfield
951    
952      @v = rec2('200','a')
953    
954  =cut  =cut
955    
956  sub fill_in_to_arr {  sub rec2 {
957          my $self = shift;          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          my ($rec, $format_utf8) = @_;  =head2 rec
971    
972          my $log = $self->_get_logger();  syntaxtic sugar for
973    
974          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = rec('200')
975          return if (! $format_utf8);    @v = rec('200','a')
976    
977          my $i = 0;  If rec() returns just single value, it will
978          my @arr;  return scalar, not array.
979    
980          my $rec_size;  =cut
981    
982          while (my $v = $self->fill_in($rec,$format_utf8,$i,\$rec_size)) {  sub rec {
983                  push @arr, $v;          my @out;
984                  warn "rec_size = ", Dumper($rec_size);          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          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =head2 regex
999    
1000          return @arr;  Apply regex to some or all values
 }  
1001    
1002      @v = regex( 's/foo/bar/g', @v );
1003    
1004  =head2 get_data  =cut
1005    
1006    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  Returns value from record.  =head2 prefix
1019    
1020   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  Prefix all values with a string
1021    
1022  Required arguments are:    @v = prefix( 'my_', @v );
1023    
1024  =over 8  =cut
1025    
1026  =item C<$rec>  sub prefix {
1027            my $p = shift;
1028            return @_ unless defined( $p );
1029            return map { $p . $_ } grep { defined($_) } @_;
1030    }
1031    
1032  record reference  =head2 suffix
1033    
1034  =item C<$f>  suffix all values with a string
1035    
1036  field    @v = suffix( '_my', @v );
1037    
1038  =item C<$sf>  =cut
1039    
1040  optional subfield  sub suffix {
1041            my $s = shift;
1042            return @_ unless defined( $s );
1043            return map { $_ . $s } grep { defined($_) } @_;
1044    }
1045    
1046  =item C<$i>  =head2 surround
1047    
1048  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )  surround all values with a two strings
1049    
1050  =item C<$found>    @v = surround( 'prefix_', '_suffix', @v );
1051    
1052  optional variable that will be incremeted if preset  =cut
1053    
1054  =item C<$rec_size>  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  hash to hold maximum occurances of C<field^subfield> combinations  =head2 first
 (which can be accessed using keys in same format)  
1063    
1064  =back  Return first element
1065    
1066  Returns value or empty string, updates C<$found> and C<rec_size>    $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 . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$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                    my @vals = $what->();
1157    
1158  sub apply_format {                  push @out, ( @vals );
1159          my $self = shift;  
1160                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1161            }
1162    
1163          my ($name,$delimiter,$data) = @_;  #       if (ref($lookup->{$k}) eq 'ARRAY') {
1164    #               return @{ $lookup->{$k} };
1165    #       } else {
1166    #               return $lookup->{$k};
1167    #       }
1168    
1169          my $log = $self->_get_logger();          $rec = $old_rec;
1170    
1171          if (! $self->{'import_xml'}->{'format'}->{$name}) {          warn "## lookup returns = ", dump(@out), $/ if ($debug);
1172                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
1173                  return $data;          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    Consult config values stored in C<config.yml>
1228    
1229  Sort array ignoring case and html in data    # 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    
1234   my @sorted = $webpac->sort_arr(@unsorted);  Up to three levels are supported.
1235    
1236  =cut  =cut
1237    
1238  sub sort_arr {  sub config {
1239          my $self = shift;          return unless ($config);
1240    
1241          my $log = $self->_get_logger();          my $p = shift;
1242    
1243          # FIXME add Schwartzian Transformation?          $p ||= '';
1244    
1245          my @sorted = sort {          my $v;
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
1246    
1247          return @sorted;          warn "### getting config($p)\n" if ($debug > 1);
1248    
1249            my @p = split(/\s+/,$p);
1250            if ($#p < 0) {
1251                    $v = $config->{ '_' };  # special, database code
1252            } else {
1253    
1254                    my $c = dclone( $config );
1255    
1256                    foreach my $k (@p) {
1257                            warn "### k: $k c = ",dump($c),$/ if ($debug > 1);
1258                            if (ref($c) eq 'ARRAY') {
1259                                    $c = shift @$c;
1260                                    warn "config($p) taking first occurence of '$k', probably not what you wanted!\n";
1261                                    last;
1262                            }
1263    
1264                            if (! defined($c->{$k}) ) {
1265                                    $c = undef;
1266                                    last;
1267                            } else {
1268                                    $c = $c->{$k};
1269                            }
1270                    }
1271                    $v = $c if ($c);
1272    
1273            }
1274    
1275            warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
1276            warn "config( '$p' ) is empty\n" if (! $v);
1277    
1278            return $v;
1279  }  }
1280    
1281    =head2 id
1282    
1283  =head1 INTERNAL METHODS  Returns unique id of this record
1284    
1285  =head2 _sort_by_order    $id = id();
1286    
1287  Sort xml tags data structure accoding to C<order=""> attribute.  Returns C<42/2> for 2nd occurence of MFN 42.
1288    
1289  =cut  =cut
1290    
1291  sub _sort_by_order {  sub id {
1292          my $self = shift;          my $mfn = $config->{_mfn} || die "no _mfn in config data";
1293            return $mfn . $#{$marc_record} ? $#{$marc_record} + 1 : '';
1294    }
1295    
1296    =head2 join_with
1297    
1298    Joins walues with some delimiter
1299    
1300          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||    $v = join_with(", ", @v);
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
1301    
1302          return $va <=> $vb;  =cut
1303    
1304    sub join_with {
1305            my $d = shift;
1306            warn "### join_with('$d',",dump(@_),")\n" if ($debug > 2);
1307            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
1308            return '' unless defined($v);
1309            return $v;
1310  }  }
1311    
1312  =head2 _x  =head2 split_rec_on
1313    
1314    Split record subfield on some regex and take one of parts out
1315    
1316  Convert strings from C<conf/normalize/*.xml> encoding into application    $a_before_semi_column =
1317  specific encoding (optinally specified using C<code_page> to C<new>          split_rec_on('200','a', /\s*;\s*/, $part);
 constructor).  
1318    
1319   my $text = $n->_x('normalize text string');  C<$part> is optional number of element. First element is
1320    B<1>, not 0!
1321    
1322  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
1323    return all values produced by splitting.
1324    
1325  =cut  =cut
1326    
1327  sub _x {  sub split_rec_on {
1328          my $self = shift;          die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
1329          return shift;  
1330            my ($fld, $sf, $regex, $part) = @_;
1331            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
1332    
1333            my @r = rec( $fld, $sf );
1334            my $v = shift @r;
1335            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
1336    
1337            return '' if ( ! defined($v) || $v =~ /^\s*$/);
1338    
1339            my @s = split( $regex, $v );
1340            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
1341            if ($part && $part > 0) {
1342                    return $s[ $part - 1 ];
1343            } else {
1344                    return @s;
1345            }
1346  }  }
1347    
1348    my $hash;
1349    
1350  =head1 AUTHOR  =head2 set
1351    
1352  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>    set( key => 'value' );
1353    
1354  =head1 COPYRIGHT & LICENSE  =cut
1355    
1356  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  sub set {
1357            my ($k,$v) = @_;
1358            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
1359            $hash->{$k} = $v;
1360    };
1361    
1362  This program is free software; you can redistribute it and/or modify it  =head2 get
1363  under the same terms as Perl itself.  
1364      get( 'key' );
1365    
1366  =cut  =cut
1367    
1368  1; # End of WebPAC::Normalize  sub get {
1369            my $k = shift || return;
1370            my $v = $hash->{$k};
1371            warn "## get $k = ", dump( $v ), $/ if ( $debug );
1372            return $v;
1373    }
1374    
1375    =head2 count
1376    
1377      if ( count( @result ) == 1 ) {
1378            # do something if only 1 result is there
1379      }
1380    
1381    =cut
1382    
1383    sub count {
1384            warn "## count ",dump(@_),$/ if ( $debug );
1385            return @_ . '';
1386    }
1387    
1388    # END
1389    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26