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

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

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

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

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

  ViewVC Help
Powered by ViewVC 1.1.26