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

Legend:
Removed from v.364  
changed lines
  Added in v.923

  ViewVC Help
Powered by ViewVC 1.1.26