/[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 333 by dpavlin, Sat Dec 31 13:42:11 2005 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 base 'WebPAC::Common';  
31  use Data::Dumper;  #use base qw/WebPAC::Common/;
32    use Data::Dump qw/dump/;
33    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  It contains several assumptions:  =head1 FUNCTIONS
67    
68  =over  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  =item *  =head2 data_structure
72    
73  format of fields is defined using C<v123^a> notation for repeatable fields  Return data structure
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
74    
75  =item *    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  source data records (C<$rec>) have unique identifiers in field C<000>  Options C<row>, C<rules> and C<log> are mandatory while all
88    other are optional.
89    
90  =item *  C<load_row_coderef> is closure only used when executing lookups, so they will
91    die if it's not defined.
92    
93  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  This function will B<die> if normalizastion can't be evaled.
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
94    
95  =item *  Since this function isn't exported you have to call it with
96    C<WebPAC::Normalize::data_structure>.
97    
98  optional C<filter{filter_name}> at B<begining of format> will apply perl  =cut
 code defined as code ref on format after field substitution to producing  
 output  
99    
100  There is one built-in filter called C<regex> which can be use like this:  my $load_row_coderef;
101    
102    filter{regex(s/foo/bar/)}  sub data_structure {
103            my $arg = {@_};
104    
105  =item *          die "need row argument" unless ($arg->{row});
106            die "need normalisation argument" unless ($arg->{rules});
107    
108  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.          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  =item *          eval "$arg->{rules}";
116            die "error evaling $arg->{rules}: $@\n" if ($@);
117    
118  at end, optional C<format>s rules are resolved. Format rules are similar to          return _get_ds();
119  C<sprintf> and can also contain C<lookup{...}> which is performed after  }
 values are inserted in format.  
120    
121  =back  =head2 _set_rec
122    
123  This also describes order in which transformations are applied (eval,  Set current record hash
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
124    
125      _set_rec( $rec );
126    
127    =cut
128    
129    my $rec;
130    
131  =head1 FUNCTIONS  sub _set_rec {
132            $rec = shift or die "no record hash";
133    }
134    
135  =head2 new  =head2 _set_config
136    
137  Create new normalisation object  Set current config hash
138    
139    my $n = new WebPAC::Normalize::Something(    _set_config( $config );
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
   );  
140    
141  Parametar C<filter> defines user supplied snippets of perl code which can  Magic keys are:
 be use with C<filter{...}> notation.  
142    
143  C<prefix> is used to form filename for database record (to support multiple  =over 4
 source files which are joined in one database).  
144    
145  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  =item _
146  in structures. If you pass this parametar, you must also pass C<lookup>  
147  which is C<WebPAC::Lookup> object.  Code of current database
148    
149    =item _mfn
150    
151    Current MFN
152    
153    =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    =cut
185    
186          $self ? return $self : return undef;  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  Create in-memory data structure which represents normalized layout from  my $lookup;
 C<conf/normalize/*.xml>.  
202    
203  This structures are used to produce output.  sub _set_lookup {
204            $lookup = shift;
205    }
206    
207    =head2 _get_lookup
208    
209    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>
         if ($self->{tags_by_order}) {  
                 @sorted_tags = @{$self->{tags_by_order}};  
         } else {  
                 @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
                 $self->{tags_by_order} = \@sorted_tags;  
         }  
241    
242          my $ds;          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
243    
244          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  We are using I<magic> which detect repeatable fields only from
245    sequence of field/subfield data generated by normalization.
246    
247          foreach my $field (@sorted_tags) {  Repeatable field is created when there is second occurence of same subfield or
248    if any of indicators are different.
249    
250                  my $row;  This is sane for most cases. Something like:
251    
252  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});    900a-1 900b-1 900c-1
253      900a-2 900b-2
254      900a-3
255    
256                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  will be created from any combination of:
                         my $format;  
257    
258                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
                         $format = $tag->{'value'} || $tag->{'content'};  
259    
260                          $log->debug("format: $format");  and following rules:
261    
262                          my @v;    marc('900','a', rec('200','a') );
263                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {    marc('900','b', rec('200','b') );
264                                  @v = $self->fill_in_to_arr($rec,$format);    marc('900','c', rec('200','c') );
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
265    
266                          if ($tag->{'sort'}) {  which might not be what you have in mind. If you need repeatable subfield,
267                                  @v = $self->sort_arr(@v);  define it using C<marc_repeatable_subfield> like this:
                         }  
268    
269                          # use format?    marc_repeatable_subfield('900','a');
270                          if ($tag->{'format_name'}) {    marc('900','a', rec('200','a') );
271                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;    marc('900','b', rec('200','b') );
272                          }    marc('900','c', rec('200','c') );
273    
274                          # delimiter will join repeatable fields  will create:
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
275    
276                          # default types    900a-1 900a-2 900a-3 900b-1 900c-1
277                          my @types = qw(display search);    900b-2
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, " ", $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
278    
279                                  } else {  There is also support for returning next or specific using:
280                                          push @{$row->{$type}}, @v;  
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            return if (! $marc_record || ref($marc_record) ne 'ARRAY');
307    
308            warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
309    
310            my $marc_rec = $marc_record->[ $fetch_pos ];
311    
312            warn "## _get_marc_fields (at offset: $fetch_pos) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
313    
314            return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);
315    
316            # first, sort all existing fields
317            # 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            @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
323            
324            # output marc fields
325            my @m;
326    
327            # count unique field-subfields (used for offset when walking to next subfield)
328            my $u;
329            map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
330    
331            if ($debug) {
332                    warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
333                    warn "## marc_record[$fetch_pos] = ", dump( $marc_rec ), $/;
334                    warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
335                    warn "## subfield count = ", dump( $u ), $/;
336            }
337    
338            my $len = $#sorted_marc_record;
339            my $visited;
340            my $i = 0;
341            my $field;
342    
343            foreach ( 0 .. $len ) {
344    
345                    # find next element which isn't visited
346                    while ($visited->{$i}) {
347                            $i = ($i + 1) % ($len + 1);
348                  }                  }
349    
350                  if ($row) {                  # mark it visited
351                          $row->{'tag'} = $field;                  $visited->{$i}++;
352    
353                          # TODO: name_sigular, name_plural                  my $row = dclone( $sorted_marc_record[$i] );
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         my $row_name = $name ? $self->_x($name) : $field;  
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
354    
355                          $ds->{$row_name} = $row;                  # 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    
                         $log->debug("row $field: ",sub { Dumper($row) });  
367                  }                  }
368    
369                    # if field exists
370                    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                            } else {
392                                    # append new subfields to existing field
393                                    push @$field, ( $row->[3], $row->[4] );
394                            }
395                    } else {
396                            # insert first field
397                            $field = $row;
398                    }
399    
400                    if (! $marc_repeatable_subfield->{ $fsf }) {
401                            # make step to next subfield
402                            $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,  }
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
413    
414          $log->debug("ds: ", sub { Dumper($ds) });  =head2 _get_marc_leader
415    
416          $log->logconfess("data structure returned is not array any more!") if wantarray;  Return leader from currently fetched record by L</_get_marc_fields>
417    
418          return $ds;    print WebPAC::Normalize::_get_marc_leader();
419    
420    =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) = @_;  
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    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          $log->debug("format: $format");  =head2 search
479    
480          my $eval_code;  Prepare values just for I<search>
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
481    
482          my $filter_name;    @v = search('Title', rec('200','a') );
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
483    
484          # did we found any (att all) field from format in row?  =cut
         my $found_any = 0;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
485    
486          my $f_step = 1;  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          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =head2 marc_leader
494    
495                  my $del = $1 || '';  Setup fields within MARC leader or get leader
                 $prefix = $del if ($f_step == 1);  
496    
497                  # repeatable index    marc_leader('05','c');
498                  my $r = $i;    my $leader = marc_leader();
                 $r = 0 if (lc("$2") eq 's');  
499    
500                  my $found = 0;  =cut
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
501    
502                  if ($found) {  sub marc_leader {
503                          $found_any += $found;          my ($offset,$value) = @_;
504    
505                          # we will skip delimiter before first occurence of field!          if ($offset) {
506                          push @out, $del unless($found_any == 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    =head2 marc_fixed
519    
520    Create control/indentifier fields with values in fixed positions
521    
522          return if (! $found_any);    marc_fixed('008', 00, '070402');
523      marc_fixed('008', 39, '|');
524    
525          my $out = join('',@out);  Positions not specified will be filled with spaces (C<0x20>).
526    
527          if ($out) {  There will be no effort to extend last specified value to full length of
528                  # add rest of format (suffix)  field in standard.
529                  $out .= $format;  
530    =cut
531    
532                  # add prefix if not there  sub marc_fixed {
533                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          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                  $log->debug("result: $out");          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          my ($rec, $format_utf8) = @_;  =head2 marc_compose
628    
629          my $log = $self->_get_logger();  Save values for each MARC subfield explicitly
630    
631          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc_compose('900',
632          return if (! $format_utf8);          'a', rec('200','a')
633            'b', rec('201','a')
634            'a', rec('200','b')
635            'c', rec('200','c')
636      );
637    
638          my $i = 0;  If you specify C<+> for subfield, value will be appended
639          my @arr;  to previous defined subfield.
640    
641    =cut
642    
643          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  sub marc_compose {
644                  push @arr, $v;          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            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 (@_) {
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  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  This function B<does not> perform parsing of format to inteligenty skip  }
 delimiters before fields which aren't used.  
695    
696  This method will automatically decode UTF-8 string to local code page  =head2 marc_remove
 if needed.  
697    
698  =cut  Remove some field or subfield from MARC record.
699    
700  sub fill_in {    marc_remove('200');
701          my $self = shift;    marc_remove('200','a');
702    
703          my $log = $self->_get_logger();  This will erase field C<200> or C<200^a> from current MARC record.
704    
705          my $rec = shift || $log->logconfess("need data record");    marc_remove('*');
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
706    
707          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  Will remove all fields in current MARC record.
708    
709          # FIXME remove for speedup?  This is useful after calling C<marc_duplicate> or on it's own (but, you
710          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  should probably just remove that subfield definition if you are not
711    using C<marc_duplicate>).
712    
713          if (utf8::is_utf8($format)) {  FIXME: support fields < 10.
                 $format = $self->_x($format);  
         }  
714    
715          my $found = 0;  =cut
         my $just_single = 1;  
716    
717          my $eval_code;  sub marc_remove {
718          # remove eval{...} from beginning          my ($f, $sf) = @_;
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
719    
720          my $filter_name;          die "marc_remove needs record number" unless defined($f);
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
721    
722          # do actual replacement of placeholders          my $marc = $marc_record->[ $marc_record_offset ];
723          # repeatable fields  
724          if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges) {          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
725                  $just_single = 0;  
726          }          if ($f eq '*') {
727            
728          # non-repeatable fields                  delete( $marc_record->[ $marc_record_offset ] );
729          if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges) {                  warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
730                  return if ($i > 0 && $just_single);  
731          }          } else {
732    
733          if ($found) {                  my $i = 0;
734                  $log->debug("format: $format");                  foreach ( 0 .. $#{ $marc } ) {
735                  if ($eval_code) {                          last unless (defined $marc->[$i]);
736                          my $eval = $self->fill_in($rec,$eval_code,$i);                          warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
737                          return if (! $self->_eval($eval));                          if ($marc->[$i]->[0] eq $f) {
738                  }                                  if (! defined $sf) {
739                  if ($filter_name && $self->{'filter'}->{$filter_name}) {                                          # remove whole field
740                          $log->debug("filter '$filter_name' for $format");                                          splice @$marc, $i, 1;
741                          $format = $self->{'filter'}->{$filter_name}->($format);                                          warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
742                          return unless(defined($format));                                          $i--;
743                          $log->debug("filter result: $format");                                  } else {
744                  }                                          foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
745                  # do we have lookups?                                                  my $o = ($j * 2) + 3;
746                  if ($self->{'lookup'}) {                                                  if ($marc->[$i]->[$o] eq $sf) {
747                          if ($self->{'lookup'}->can('lookup')) {                                                          # remove subfield
748                                  my @lookup = $self->{lookup}->lookup($format);                                                          splice @{$marc->[$i]}, $o, 2;
749                                  $log->debug("lookup $format", join(", ", @lookup));                                                          warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
750                                  return @lookup;                                                          # is record now empty?
751                          } else {                                                          if ($#{ $marc->[$i] } == 2) {
752                                  $log->warn("Have lookup object but can't invoke lookup method");                                                                  splice @$marc, $i, 1;
753                                                                    warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
754                                                                    $i--;
755                                                            };
756                                                    }
757                                            }
758                                    }
759                          }                          }
760                  } else {                          $i++;
                         return $format;  
761                  }                  }
762          } else {  
763                  return;                  warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
764    
765                    $marc_record->[ $marc_record_offset ] = $marc;
766          }          }
767    
768            warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
769  }  }
770    
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  =head2 fill_in_to_arr  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  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  You might want to use this command if you are just renaming subfields or
782  for fields which have lookups, so they shouldn't be parsed but rather  using pre-processing modify_record in C<config.yml> and don't need any
783  C<fill_id>ed.  post-processing or want to preserve order of original subfields.
784    
  my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  
785    
786  =cut  =cut
787    
788  sub fill_in_to_arr {  sub marc_original_order {
         my $self = shift;  
789    
790          my ($rec, $format_utf8) = @_;          my ($to, $from) = @_;
791            die "marc_original_order needs from and to fields\n" unless ($from && $to);
792    
793          my $log = $self->_get_logger();          return unless defined($rec->{$from});
794    
795          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          my $r = $rec->{$from};
796          return if (! $format_utf8);          die "record field $from isn't array\n" unless (ref($r) eq 'ARRAY');
797    
798          my $i = 0;          my ($i1,$i2) = defined($marc_indicators->{$to}) ? @{ $marc_indicators->{$to} } : (' ',' ');
799          my @arr;          warn "## marc_original_order($to,$from) source = ", dump( $r ),$/ if ($debug > 1);
800    
801          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {          foreach my $d (@$r) {
802                  push @arr, @v;  
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                    die "field $from doesn't have even number of subfields specifications\n" unless($#sfs % 2 == 1);
811    
812          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);                  warn "#--> d: ",dump($d), "\n#--> sfs: ",dump(@sfs),$/ if ($debug > 2);
813    
814          return @arr;                  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            }
837    
838            warn "## marc_record = ", dump( $marc_record ),$/ if ($debug > 1);
839  }  }
840    
841    =head2 marc_count
842    
843  =head2 get_data  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    
 Returns value from record.  
853    
854   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head1 Functions to extract data from input
855    
856  Arguments are:  This function should be used inside functions to create C<data_structure> described
857  record reference C<$rec>,  above.
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
858    
859  Optinal variable C<$found> will be incremeted if there  =head2 _pack_subfields_hash
 is field.  
860    
861  Returns value or empty string.   @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  =cut
868    
869  sub get_data {  sub _pack_subfields_hash {
870          my $self = shift;  
871            warn "## _pack_subfields_hash( ",dump(@_), " )\n" if ($debug > 1);
872    
873            my ($h,$include_subfields) = @_;
874    
875          my ($rec,$f,$sf,$i,$found) = @_;          # sanity and ease of use
876            return $h if (ref($h) ne 'HASH');
877    
878          if ($$rec->{$f}) {          if ( defined($h->{subfields}) ) {
879                  return '' if (! $$rec->{$f}->[$i]);                  my $sfs = delete $h->{subfields} || die "no subfields?";
880                  no strict 'refs';                  my @out;
881                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {                  while (@$sfs) {
882                          $$found++ if (defined($$found));                          my $sf = shift @$sfs;
883                          return $$rec->{$f}->[$i]->{$sf};                          push @out, '^' . $sf if ($include_subfields);
884                  } elsif (! $sf && $$rec->{$f}->[$i]) {                          my $o = shift @$sfs;
885                          $$found++ if (defined($$found));                          if ($o == 0 && ref( $h->{$sf} ) ne 'ARRAY' ) {
886                          # it still might have subfield, just                                  # single element subfields are not arrays
887                          # not specified, so we'll dump all  #warn "====> $sf $o / $#$sfs ", dump( $sfs, $h->{$sf} ), "\n";
888                          if ($$rec->{$f}->[$i] =~ /HASH/o) {  
889                                  my $out;                                  push @out, $h->{$sf};
890                                  foreach my $k (keys %{$$rec->{$f}->[$i]}) {                          } else {
891                                          $out .= $$rec->{$f}->[$i]->{$k}." ";  #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 {
898                            return @out;
899                    }
900            } else {
901                    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                                  return $out;                          }
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    TODO: order of values is probably same as in source data, need to investigate that
925    
926    =cut
927    
928    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 {                          } else {
939                                  return $$rec->{$f}->[$i];                                  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    Return all values in specific field and subfield
951    
952      @v = rec2('200','a')
953    
954    =cut
955    
956    sub rec2 {
957            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 {                  } else {
965                          return '';                          $_->{$sf};
966                  }                  }
967            } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
968    }
969    
970    =head2 rec
971    
972    syntaxtic sugar for
973    
974      @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 {          } else {
994                  return '';                  return '';
995          }          }
996  }  }
997    
998    =head2 regex
999    
1000    Apply regex to some or all values
1001    
1002      @v = regex( 's/foo/bar/g', @v );
1003    
1004    =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    =head2 prefix
1019    
1020  =head2 apply_format  Prefix all values with a string
1021    
1022  Apply format specified in tag with C<format_name="name"> and    @v = prefix( 'my_', @v );
 C<format_delimiter=";;">.  
1023    
1024   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
1025    
1026    sub prefix {
1027            my $p = shift;
1028            return @_ unless defined( $p );
1029            return map { $p . $_ } grep { defined($_) } @_;
1030    }
1031    
1032    =head2 suffix
1033    
1034    suffix all values with a string
1035    
1036  Formats can contain C<lookup{...}> if you need them.    @v = suffix( '_my', @v );
1037    
1038  =cut  =cut
1039    
1040  sub apply_format {  sub suffix {
1041          my $self = shift;          my $s = shift;
1042            return @_ unless defined( $s );
1043            return map { $_ . $s } grep { defined($_) } @_;
1044    }
1045    
1046    =head2 surround
1047    
1048          my ($name,$delimiter,$data) = @_;  surround all values with a two strings
1049    
1050          my $log = $self->_get_logger();    @v = surround( 'prefix_', '_suffix', @v );
1051    
1052          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =cut
1053                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
1054                  return $data;  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      $v = first( @v );
1067    
1068    =cut
1069    
1070    sub first {
1071            my $r = shift;
1072            return $r;
1073    }
1074    
1075    =head2 lookup
1076    
1077    Consult lookup hashes for some value
1078    
1079      @v = lookup(
1080            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    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            # which results to return from record recorded in lookup
1094            sub { 'ffkk/peri/mfn' . rec('000') },
1095            # from which database and input
1096            'ffkk','peri',
1097            # such that following values match
1098            sub { first(rec(200,'a')) . ' ' . first(rec('200','e')) },
1099            # if this part is missing, we will try to match same fields
1100            # from lookup record and current one, or you can override
1101            # which records to use from current record using
1102            sub { rec('900','x') . ' ' . rec('900','y') },
1103      )
1104    
1105    You can think about this lookup as SQL (if that helps):
1106    
1107      select
1108            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          $log->warn("no delimiter for format $name") if (! $delimiter);          warn "## lookup ($database, $input, $key)", $/ if ($debug > 1);
1126            return unless (defined($lookup->{$database}->{$input}->{$key}));
1127    
1128          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");          confess "lookup really need load_row_coderef added to data_structure\n" unless ($load_row_coderef);
1129    
1130          my @data = split(/\Q$delimiter\E/, $data);          my $mfns;
1131            my @having = $having->();
1132    
1133          my $out = sprintf($format, @data);          warn "## having = ", dump( @having ) if ($debug > 2);
         $log->debug("using format $name [$format] on $data to produce: $out");  
1134    
1135          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          foreach my $h ( @having ) {
1136                  return $self->{'lookup'}->lookup($out);                  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            my @mfns = sort keys %$mfns;
1145    
1146            warn "# lookup loading $database/$input/$key mfn ", join(",",@mfns)," having ",dump(@having),"\n" if ($debug);
1147    
1148            my $old_rec = $rec;
1149            my @out;
1150    
1151            foreach my $mfn (@mfns) {
1152                    $rec = $load_row_coderef->( $database, $input, $mfn );
1153    
1154                    warn "got $database/$input/$mfn = ", dump($rec), $/ if ($debug);
1155    
1156                    my @vals = $what->();
1157    
1158                    push @out, ( @vals );
1159    
1160                    warn "lookup for mfn $mfn returned ", dump(@vals), $/ if ($debug);
1161            }
1162    
1163    #       if (ref($lookup->{$k}) eq 'ARRAY') {
1164    #               return @{ $lookup->{$k} };
1165    #       } else {
1166    #               return $lookup->{$k};
1167    #       }
1168    
1169            $rec = $old_rec;
1170    
1171            warn "## lookup returns = ", dump(@out), $/ if ($debug);
1172    
1173            if ($#out == 0) {
1174                    return $out[0];
1175          } else {          } else {
1176                  return $out;                  return @out;
1177          }          }
1178    }
1179    
1180    =head2 save_into_lookup
1181    
1182    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    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 $nr = save_into_lookup($database,$input,$key,sub {
1190            # code which produce one or more values
1191      });
1192    
1193    It returns number of items saved.
1194    
1195    This function shouldn't be called directly, it's called from code created by
1196    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 $p = shift;
1242    
1243            $p ||= '';
1244    
1245            my $v;
1246    
1247          my $log = $self->_get_logger();          warn "### getting config($p)\n" if ($debug > 1);
1248    
1249          # FIXME add Schwartzian Transformation?          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          my @sorted = sort {          warn "## config( '$p' ) = ",dump( $v ),$/ if ($v && $debug);
1276                  $a =~ s#<[^>]+/*>##;          warn "config( '$p' ) is empty\n" if (! $v);
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
1277    
1278          return @sorted;          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);
1301                  $self->{'import_xml'}->{'indexer'}->{$a};  
1302          my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  =cut
                 $self->{'import_xml'}->{'indexer'}->{$b};  
1303    
1304          return $va <=> $vb;  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  Convert strings from C<conf/normalize/*.xml> encoding into application  Split record subfield on some regex and take one of parts out
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
1315    
1316   my $text = $n->_x('normalize text string');    $a_before_semi_column =
1317            split_rec_on('200','a', /\s*;\s*/, $part);
1318    
1319  This is a stub so that other modules doesn't have to implement it.  C<$part> is optional number of element. First element is
1320    B<1>, not 0!
1321    
1322    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    sub set {
1357            my ($k,$v) = @_;
1358            warn "## set ( $k => ", dump($v), " )", $/ if ( $debug );
1359            $hash->{$k} = $v;
1360    };
1361    
1362    =head2 get
1363    
1364      get( 'key' );
1365    
1366    =cut
1367    
1368    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  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  =head2 count
1376    
1377  This program is free software; you can redistribute it and/or modify it    if ( count( @result ) == 1 ) {
1378  under the same terms as Perl itself.          # do something if only 1 result is there
1379      }
1380    
1381  =cut  =cut
1382    
1383  1; # End of WebPAC::Normalize  sub count {
1384            warn "## count ",dump(@_),$/ if ( $debug );
1385            return @_ . '';
1386    }
1387    
1388    # END
1389    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26