/[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 39 by dpavlin, Sat Nov 12 21:31:47 2005 UTC revision 583 by dpavlin, Wed Jul 5 00:12:08 2006 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            _get_ds _clean_ds
6            _debug
7    
8            tag search display
9            marc marc_indicators marc_repeatable_subfield
10            marc_compose marc_leader
11            marc_duplicate marc_remove
12    
13            rec1 rec2 rec
14            regex prefix suffix surround
15            first lookup join_with
16    
17            split_rec_on
18    /;
19    
20  use warnings;  use warnings;
21  use strict;  use strict;
22  use base 'WebPAC::Common';  
23  use Data::Dumper;  #use base qw/WebPAC::Common/;
24    use Data::Dump qw/dump/;
25    use Encode qw/from_to/;
26    use Storable qw/dclone/;
27    
28    # debugging warn(s)
29    my $debug = 0;
30    
31    
32  =head1 NAME  =head1 NAME
33    
34  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
35    
36  =head1 VERSION  =head1 VERSION
37    
38  Version 0.01  Version 0.11
39    
40  =cut  =cut
41    
42  our $VERSION = '0.01';  our $VERSION = '0.11';
43    
44  =head1 SYNOPSIS  =head1 SYNOPSIS
45    
46  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
47    from input records using perl functions which are specialized for set
48    processing.
49    
50    Sets are implemented as arrays, and normalisation file is valid perl, which
51    means that you check it's validity before running WebPAC using
52    C<perl -c normalize.pl>.
53    
54    Normalisation can generate multiple output normalized data. For now, supported output
55    types (on the left side of definition) are: C<tag>, C<display>, C<search> and
56    C<marc>.
57    
58    =head1 FUNCTIONS
59    
60    Functions which start with C<_> are private and used by WebPAC internally.
61    All other functions are available for use within normalisation rules.
62    
63  It contains several assumptions:  =head2 data_structure
64    
65  =over  Return data structure
66    
67      my $ds = WebPAC::Normalize::data_structure(
68            lookup => $lookup->lookup_hash,
69            row => $row,
70            rules => $normalize_pl_config,
71            marc_encoding => 'utf-8',
72      );
73    
74  =item *  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
75    other are optional.
76    
77  format of fields is defined using C<v123^a> notation for repeatable fields  This function will B<die> if normalizastion can't be evaled.
 or C<s123^a> for single (or first) value, where C<123> is field number and  
 C<a> is subfield.  
78    
79  =item *  Since this function isn't exported you have to call it with
80    C<WebPAC::Normalize::data_structure>.
81    
82  source data records (C<$rec>) have unique identifiers in field C<000>  =cut
83    
84  =item *  sub data_structure {
85            my $arg = {@_};
86    
87  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be          die "need row argument" unless ($arg->{row});
88  perl code that is evaluated before producing output (value of field will be          die "need normalisation argument" unless ($arg->{rules});
 interpolated before that)  
89    
90  =item *          no strict 'subs';
91            _set_lookup( $arg->{lookup} );
92            _set_rec( $arg->{row} );
93            _clean_ds( %{ $arg } );
94            eval "$arg->{rules}";
95            die "error evaling $arg->{rules}: $@\n" if ($@);
96    
97  optional C<filter{filter_name}> at B<begining of format> will apply perl          return _get_ds();
98  code defined as code ref on format after field substitution to producing  }
 output  
99    
100  =item *  =head2 _set_rec
101    
102  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  Set current record hash
103    
104  =item *    _set_rec( $rec );
105    
106  at end, optional C<format>s rules are resolved. Format rules are similar to  =cut
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
107    
108  =back  my $rec;
109    
110  This also describes order in which transformations are applied (eval,  sub _set_rec {
111  filter, lookup, format) which is important to undestand when deciding how to          $rec = shift or die "no record hash";
112  solve your data mungling and normalisation process.  }
113    
114    =head2 _get_ds
115    
116    Return hash formatted as data structure
117    
118      my $ds = _get_ds();
119    
120  =head1 FUNCTIONS  =cut
121    
122  =head2 new  my ($out, $marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
123    my ($marc_record_offset, $marc_fetch_offset) = (0, 0);
124    
125  Create new normalisation object  sub _get_ds {
126            return $out;
127    }
128    
129    my $n = new WebPAC::Normalize::Something(  =head2 _clean_ds
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
   );  
130    
131  Parametar C<filter> defines user supplied snippets of perl code which can  Clean data structure hash for next record
 be use with C<filter{...}> notation.  
132    
133  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.  
134    
135  =cut  =cut
136    
137  sub new {  sub _clean_ds {
138          my $class = shift;          my $a = {@_};
139          my $self = {@_};          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
140          bless($self, $class);          ($marc_record_offset, $marc_fetch_offset) = (0,0);
141            $marc_encoding = $a->{marc_encoding};
142    }
143    
144          my $r = $self->{'lookup_regex'} ? 1 : 0;  =head2 _set_lookup
         my $l = $self->{'lookup'} ? 1 : 0;  
145    
146          my $log = $self->_get_logger();  Set current lookup hash
147    
148          # 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");  
         }  
149    
150          $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  =cut
151    
152          $self ? return $self : return undef;  my $lookup;
153    
154    sub _set_lookup {
155            $lookup = shift;
156  }  }
157    
158    =head2 _get_marc_fields
159    
160  =head2 data_structure  Get all fields defined by calls to C<marc>
161    
162  Create in-memory data structure which represents normalized layout from          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
 C<conf/normalize/*.xml>.  
163    
164  This structures are used to produce output.  We are using I<magic> which detect repeatable fields only from
165    sequence of field/subfield data generated by normalization.
166    
167   my @ds = $webpac->data_structure($rec);  Repeatable field is created when there is second occurence of same subfield or
168    if any of indicators are different.
169    
170  B<Note: historical oddity follows>  This is sane for most cases. Something like:
171    
172  This method will also set C<< $webpac->{'currnet_filename'} >> if there is    900a-1 900b-1 900c-1
173  C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is    900a-2 900b-2
174  C<< <headline> >> tag.    900a-3
175    
176  =cut  will be created from any combination of:
177    
178  sub data_structure {    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
         my $self = shift;  
179    
180          my $log = $self->_get_logger();  and following rules:
181    
182          my $rec = shift;    marc('900','a', rec('200','a') );
183          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc('900','b', rec('200','b') );
184      marc('900','c', rec('200','c') );
185    
186          my $cache_file;  which might not be what you have in mind. If you need repeatable subfield,
187    define it using C<marc_repeatable_subfield> like this:
188    
189          if ($self->{'db'}) {    marc_repeatable_subfield('900','a');
190                  my @ds = $self->{'db'}->load_ds($rec);    marc('900','a', rec('200','a') );
191                  $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper(@ds) });    marc('900','b', rec('200','b') );
192                  return @ds if ($#ds > 0);    marc('900','c', rec('200','c') );
                 $log->debug("cache miss, creating");  
         }  
193    
194          undef $self->{'currnet_filename'};  will create:
         undef $self->{'headline'};  
195    
196          my @sorted_tags;    900a-1 900a-2 900a-3 900b-1 900c-1
197          if ($self->{tags_by_order}) {    900b-2
                 @sorted_tags = @{$self->{tags_by_order}};  
         } else {  
                 @sorted_tags = sort { $self->_sort_by_order } keys %{$self->{'import_xml'}->{'indexer'}};  
                 $self->{tags_by_order} = \@sorted_tags;  
         }  
198    
199          my @ds;  There is also support for returning next or specific using:
200    
201          $log->debug("tags: ",sub { join(", ",@sorted_tags) });    while (my $mf = WebPAC::Normalize:_get_marc_fields( fetch_next => 1 ) ) {
202            # do something with $mf
203      }
204    
205          foreach my $field (@sorted_tags) {  will always return fields from next MARC record or
206    
207                  my $row;    my $mf = WebPAC::Normalize::_get_marc_fields( offset => 42 );
208    
209  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  will return 42th copy record (if it exists).
210    
211                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  =cut
                         my $format;  
212    
213                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');  sub _get_marc_fields {
                         $format = $tag->{'value'} || $tag->{'content'};  
214    
215                          $log->debug("format: $format");          my $arg = {@_};
216            warn "### _get_marc_fields arg: ", dump($arg), $/ if ($debug > 2);
217            my $offset = $marc_fetch_offset;
218            if ($arg->{offset}) {
219                    $offset = $arg->{offset};
220            } elsif($arg->{fetch_next}) {
221                    $marc_fetch_offset++;
222            }
223    
224                          my @v;          return if (! $marc_record || ref($marc_record) ne 'ARRAY');
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->fill_in_to_arr($rec,$format);  
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
225    
226                          if ($tag->{'sort'}) {          warn "### full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 2);
                                 @v = $self->sort_arr(@v);  
                         }  
227    
228                          # use format?          my $marc_rec = $marc_record->[ $offset ];
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
229    
230                          if ($field eq 'filename') {          warn "## _get_marc_fields (at offset: $offset) -- marc_record = ", dump( @$marc_rec ), $/ if ($debug > 1);
                                 $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!  
                         }  
231    
232                          # delimiter will join repeatable fields          return if (! $marc_rec || ref($marc_rec) ne 'ARRAY' || $#{ $marc_rec } < 0);
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
233    
234                          # default types          # first, sort all existing fields
235                          my @types = qw(display swish);          # XXX might not be needed, but modern perl might randomize elements in hash
236                          # override by type attribute          my @sorted_marc_record = sort {
237                          @types = ( $tag->{'type'} ) if ($tag->{'type'});                  $a->[0] . ( $a->[3] || '' ) cmp $b->[0] . ( $b->[3] || '')
238            } @{ $marc_rec };
                         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;  
239    
240                                  } else {          @sorted_marc_record = @{ $marc_rec };   ### FIXME disable sorting
241                                          push @{$row->{$type}}, @v;          
242                                  }          # output marc fields
243                          }          my @m;
244    
245            # count unique field-subfields (used for offset when walking to next subfield)
246            my $u;
247            map { $u->{ $_->[0] . ( $_->[3] || '')  }++ } @sorted_marc_record;
248    
249            if ($debug) {
250                    warn "## marc_repeatable_subfield = ", dump( $marc_repeatable_subfield ), $/ if ( $marc_repeatable_subfield );
251                    warn "## marc_record[$offset] = ", dump( $marc_rec ), $/;
252                    warn "## sorted_marc_record = ", dump( \@sorted_marc_record ), $/;
253                    warn "## subfield count = ", dump( $u ), $/;
254            }
255    
256            my $len = $#sorted_marc_record;
257            my $visited;
258            my $i = 0;
259            my $field;
260    
261            foreach ( 0 .. $len ) {
262    
263                    # find next element which isn't visited
264                    while ($visited->{$i}) {
265                            $i = ($i + 1) % ($len + 1);
266                  }                  }
267    
268                  if ($row) {                  # mark it visited
269                          $row->{'tag'} = $field;                  $visited->{$i}++;
270    
271                          # TODO: name_sigular, name_plural                  my $row = dclone( $sorted_marc_record[$i] );
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         $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");  
                         }  
272    
273                          push @ds, $row;                  # field and subfield which is key for
274                    # marc_repeatable_subfield and u
275                    my $fsf = $row->[0] . ( $row->[3] || '' );
276    
277                    if ($debug > 1) {
278    
279                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
280                            print "### this [$i]: ", dump( $row ),$/;
281                            print "### sf: ", $row->[3], " vs ", $field->[3],
282                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
283                                    if ($#$field >= 0);
284    
                         $log->debug("row $field: ",sub { Dumper($row) });  
285                  }                  }
286    
287                    # if field exists
288                    if ( $#$field >= 0 ) {
289                            if (
290                                    $row->[0] ne $field->[0] ||             # field
291                                    $row->[1] ne $field->[1] ||             # i1
292                                    $row->[2] ne $field->[2]                # i2
293                            ) {
294                                    push @m, $field;
295                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
296                                    $field = $row;
297    
298                            } elsif (
299                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
300                                    ||
301                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
302                                            ! $marc_repeatable_subfield->{ $fsf }
303                                    )
304                            ) {
305                                    push @m, $field;
306                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
307                                    $field = $row;
308    
309                            } else {
310                                    # append new subfields to existing field
311                                    push @$field, ( $row->[3], $row->[4] );
312                            }
313                    } else {
314                            # insert first field
315                            $field = $row;
316                    }
317    
318                    if (! $marc_repeatable_subfield->{ $fsf }) {
319                            # make step to next subfield
320                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
321                    }
322          }          }
323    
324          $log->logdie("there is no current_filename defined! Do you have filename tag in conf/normalize/?.xml") unless ($self->{'current_filename'});          if ($#$field >= 0) {
325                    push @m, $field;
326                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
327            }
328    
329          $self->{'db'}->save_ds(          return \@m;
330                  ds => \@ds,  }
331                  current_filename => $self->{'current_filename'},  
332                  headline => $self->{'headline'},  =head2 _debug
         ) if ($self->{'db'});  
333    
334          $log->debug("ds: ", sub { Dumper(@ds) });  Change level of debug warnings
335    
336          return @ds;    _debug( 2 );
337    
338    =cut
339    
340    sub _debug {
341            my $l = shift;
342            return $debug unless defined($l);
343            warn "debug level $l",$/ if ($l > 0);
344            $debug = $l;
345  }  }
346    
347  =head2 parse  =head1 Functions to create C<data_structure>
348    
349  Perform smart parsing of string, skipping delimiters for fields which aren't  Those functions generally have to first in your normalization file.
350  defined. It can also eval code in format starting with C<eval{...}> and  
351  return output or nothing depending on eval code.  =head2 tag
352    
353    Define new tag for I<search> and I<display>.
354    
355      tag('Title', rec('200','a') );
356    
  my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  
357    
358  =cut  =cut
359    
360  sub parse {  sub tag {
361          my $self = shift;          my $name = shift or die "tag needs name as first argument";
362            my @o = grep { defined($_) && $_ ne '' } @_;
363            return unless (@o);
364            $out->{$name}->{tag} = $name;
365            $out->{$name}->{search} = \@o;
366            $out->{$name}->{display} = \@o;
367    }
368    
369          my ($rec, $format_utf8, $i) = @_;  =head2 display
370    
371          return if (! $format_utf8);  Define tag just for I<display>
372    
373          my $log = $self->_get_logger();    @v = display('Title', rec('200','a') );
374    
375          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =cut
376    
377          $i = 0 if (! $i);  sub display {
378            my $name = shift or die "display needs name as first argument";
379            my @o = grep { defined($_) && $_ ne '' } @_;
380            return unless (@o);
381            $out->{$name}->{tag} = $name;
382            $out->{$name}->{display} = \@o;
383    }
384    
385          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head2 search
386    
387          my @out;  Prepare values just for I<search>
388    
389          $log->debug("format: $format");    @v = search('Title', rec('200','a') );
390    
391          my $eval_code;  =cut
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
392    
393          my $filter_name;  sub search {
394          # remove filter{...} from beginning          my $name = shift or die "search needs name as first argument";
395          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);          my @o = grep { defined($_) && $_ ne '' } @_;
396            return unless (@o);
397            $out->{$name}->{tag} = $name;
398            $out->{$name}->{search} = \@o;
399    }
400    
401          my $prefix;  =head2 marc_leader
         my $all_found=0;  
402    
403          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  Setup fields within MARC leader or get leader
404    
405                  my $del = $1 || '';    marc_leader('05','c');
406                  $prefix ||= $del if ($all_found == 0);    my $leader = marc_leader();
407    
408                  # repeatable index  =cut
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
409    
410                  my $found = 0;  sub marc_leader {
411                  my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);          my ($offset,$value) = @_;
412    
413                  if ($found) {          if ($offset) {
414                          push @out, $del;                  $out->{' leader'}->{ $offset } = $value;
415                          push @out, $tmp;          } else {
416                          $all_found += $found;                  return $out->{' leader'};
                 }  
417          }          }
418    }
419    
420          return if (! $all_found);  =head2 marc
421    
422          my $out = join('',@out);  Save value for MARC field
423    
424          if ($out) {    marc('900','a', rec('200','a') );
425                  # add rest of format (suffix)    marc('001', rec('000') );
                 $out .= $format;  
426    
427                  # add prefix if not there  =cut
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
428    
429                  $log->debug("result: $out");  sub marc {
430          }          my $f = shift or die "marc needs field";
431            die "marc field must be numer" unless ($f =~ /^\d+$/);
432    
433          if ($eval_code) {          my $sf;
434                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;          if ($f >= 10) {
435                  $log->debug("about to eval{$eval} format: $out");                  $sf = shift or die "marc needs subfield";
                 return if (! $self->_eval($eval));  
         }  
           
         if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                 $log->debug("about to filter{$filter_name} format: $out");  
                 $out = $self->{'filter'}->{$filter_name}->($out);  
                 return unless(defined($out));  
                 $log->debug("filter result: $out");  
436          }          }
437    
438          return $out;          foreach (@_) {
439                    my $v = $_;             # make var read-write for Encode
440                    next unless (defined($v) && $v !~ /^\s*$/);
441                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
442                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
443                    if (defined $sf) {
444                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $i1, $i2, $sf => $v ];
445                    } else {
446                            push @{ $marc_record->[ $marc_record_offset ] }, [ $f, $v ];
447                    }
448            }
449  }  }
450    
451  =head2 parse_to_arr  =head2 marc_repeatable_subfield
452    
453  Similar to C<parse>, but returns array of all repeatable fields  Save values for MARC repetable subfield
454    
455   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc_repeatable_subfield('910', 'z', rec('909') );
456    
457  =cut  =cut
458    
459  sub parse_to_arr {  sub marc_repeatable_subfield {
460          my $self = shift;          my ($f,$sf) = @_;
461            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
462            $marc_repeatable_subfield->{ $f . $sf }++;
463            marc(@_);
464    }
465    
466          my ($rec, $format_utf8) = @_;  =head2 marc_indicators
467    
468          my $log = $self->_get_logger();  Set both indicators for MARC field
469    
470          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc_indicators('900', ' ', 1);
         return if (! $format_utf8);  
471    
472          my $i = 0;  Any indicator value other than C<0-9> will be treated as undefined.
         my @arr;  
473    
474          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  =cut
                 push @arr, $v;  
         }  
475    
476          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  sub marc_indicators {
477            my $f = shift || die "marc_indicators need field!\n";
478            my ($i1,$i2) = @_;
479            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
480            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
481    
482          return @arr;          $i1 = ' ' if ($i1 !~ /^\d$/);
483            $i2 = ' ' if ($i2 !~ /^\d$/);
484            @{ $marc_indicators->{$f} } = ($i1,$i2);
485  }  }
486    
487    =head2 marc_compose
488    
489  =head2 fill_in  Save values for each MARC subfield explicitly
   
 Workhourse of all: takes record from in-memory structure of database and  
 strings with placeholders and returns string or array of with substituted  
 values from record.  
490    
491   my $text = $webpac->fill_in($rec,'v250^a');    marc_compose('900',
492            'a', rec('200','a')
493            'b', rec('201','a')
494            'a', rec('200','b')
495            'c', rec('200','c')
496      );
497    
498  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.  
499    
500   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_compose {
501            my $f = shift or die "marc_compose needs field";
502            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
503    
504  This function B<does not> perform parsing of format to inteligenty skip          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
505  delimiters before fields which aren't used.          my $m = [ $f, $i1, $i2 ];
506    
507  This method will automatically decode UTF-8 string to local code page          warn "### marc_compose input subfields = ", dump(@_),$/ if ($debug > 2);
 if needed.  
508    
509  =cut          while (@_) {
510                    my $sf = shift or die "marc_compose $f needs subfield";
511                    my $v = shift;
512    
513  sub fill_in {                  next unless (defined($v) && $v !~ /^\s*$/);
514          my $self = shift;                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
515                    push @$m, ( $sf, $v );
516                    warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
517            }
518    
519          my $log = $self->_get_logger();          warn "## marc_compose(d) ", dump( $m ),$/ if ($debug > 1);
520    
521          my $rec = shift || $log->logconfess("need data record");          push @{ $marc_record->[ $marc_record_offset ] }, $m if ($#{$m} > 2);
522          my $format = shift || $log->logconfess("need format to parse");  }
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
523    
524          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  =head2 marc_duplicate
525    
526          # FIXME remove for speedup?  Generate copy of current MARC record and continue working on copy
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
527    
528          if (utf8::is_utf8($format)) {    marc_duplicate();
                 $format = $self->_x($format);  
         }  
529    
530          my $found = 0;  Copies can be accessed using C<< _get_marc_fields( fetch_next => 1 ) >> or
531    C<< _get_marc_fields( offset => 42 ) >>.
532    
533          my $eval_code;  =cut
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
534    
535          my $filter_name;  sub marc_duplicate {
536          # remove filter{...} from beginning           my $m = $marc_record->[ -1 ];
537          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);           die "can't duplicate record which isn't defined" unless ($m);
538             push @{ $marc_record }, dclone( $m );
539             warn "## marc_duplicate = ", dump(@$marc_record), $/ if ($debug > 1);
540             $marc_record_offset = $#{ $marc_record };
541             warn "## marc_record_offset = $marc_record_offset", $/ if ($debug > 1);
542    }
543    
544          # do actual replacement of placeholders  =head2 marc_remove
         # 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;  
545    
546          if ($found) {  Remove some field or subfield from MARC record.
                 $log->debug("format: $format");  
                 if ($eval_code) {  
                         my $eval = $self->fill_in($rec,$eval_code,$i);  
                         return if (! $self->_eval($eval));  
                 }  
                 if ($filter_name && $self->{'filter'}->{$filter_name}) {  
                         $log->debug("filter '$filter_name' for $format");  
                         $format = $self->{'filter'}->{$filter_name}->($format);  
                         return unless(defined($format));  
                         $log->debug("filter result: $format");  
                 }  
                 # do we have lookups?  
                 if ($self->{'lookup'}) {  
                         if ($self->{'lookup'}->can('lookup')) {  
                                 return $self->{'lookup'}->lookup($format);  
                         } else {  
                                 $log->warn("Have lookup object but can't invoke lookup method");  
                         }  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
 }  
547    
548      marc_remove('200');
549      marc_remove('200','a');
550    
551  =head2 fill_in_to_arr  This will erase field C<200> or C<200^a> from current MARC record.
552    
553  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  This is useful after calling C<marc_duplicate> or on it's own (but, you
554  for fields which have lookups, so they shouldn't be parsed but rather  should probably just remove that subfield definition if you are not
555  C<fill_id>ed.  using C<marc_duplicate>).
556    
557   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  FIXME: support fields < 10.
558    
559  =cut  =cut
560    
561  sub fill_in_to_arr {  sub marc_remove {
562          my $self = shift;          my ($f, $sf) = @_;
563    
564          my ($rec, $format_utf8) = @_;          die "marc_remove needs record number" unless defined($f);
565    
566          my $log = $self->_get_logger();          my $marc = $marc_record->[ $marc_record_offset ];
567    
568          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          warn "### marc_remove before = ", dump( $marc ), $/ if ($debug > 2);
         return if (! $format_utf8);  
569    
570          my $i = 0;          my $i = 0;
571          my @arr;          foreach ( 0 .. $#{ $marc } ) {
572                    last unless (defined $marc->[$i]);
573          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {                  warn "#### working on ",dump( @{ $marc->[$i] }), $/ if ($debug > 3);
574                  push @arr, @v;                  if ($marc->[$i]->[0] eq $f) {
575                            if (! defined $sf) {
576                                    # remove whole field
577                                    splice @$marc, $i, 1;
578                                    warn "#### slice \@\$marc, $i, 1 = ",dump( @{ $marc }), $/ if ($debug > 3);
579                                    $i--;
580                            } else {
581                                    foreach my $j ( 0 .. (( $#{ $marc->[$i] } - 3 ) / 2) ) {
582                                            my $o = ($j * 2) + 3;
583                                            if ($marc->[$i]->[$o] eq $sf) {
584                                                    # remove subfield
585                                                    splice @{$marc->[$i]}, $o, 2;
586                                                    warn "#### slice \@{\$marc->[$i]}, $o, 2 = ", dump( @{ $marc }), $/ if ($debug > 3);
587                                                    # is record now empty?
588                                                    if ($#{ $marc->[$i] } == 2) {
589                                                            splice @$marc, $i, 1;
590                                                            warn "#### slice \@\$marc, $i, 1 = ", dump( @{ $marc }), $/ if ($debug > 3);
591                                                            $i--;
592                                                    };
593                                            }
594                                    }
595                            }
596                    }
597                    $i++;
598          }          }
599    
600          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "### marc_remove($f", $sf ? ",$sf" : "", ") after = ", dump( $marc ), $/ if ($debug > 2);
601    
602          return @arr;          $marc_record->[ $marc_record_offset ] = $marc;
 }  
603    
604            warn "## full marc_record = ", dump( @{ $marc_record }), $/ if ($debug > 1);
605    }
606    
607  =head2 get_data  =head1 Functions to extract data from input
608    
609  Returns value from record.  This function should be used inside functions to create C<data_structure> described
610    above.
611    
612   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head2 rec1
613    
614  Arguments are:  Return all values in some field
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
615    
616  Optinal variable C<$found> will be incremeted if there    @v = rec1('200')
 is field.  
617    
618  Returns value or empty string.  TODO: order of values is probably same as in source data, need to investigate that
619    
620  =cut  =cut
621    
622  sub get_data {  sub rec1 {
623          my $self = shift;          my $f = shift;
624            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
625          my ($rec,$f,$sf,$i,$found) = @_;          return unless (defined($rec) && defined($rec->{$f}));
626            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
627          if ($$rec->{$f}) {          if (ref($rec->{$f}) eq 'ARRAY') {
628                  return '' if (! $$rec->{$f}->[$i]);                  return map {
629                  no strict 'refs';                          if (ref($_) eq 'HASH') {
630                  if ($sf && $$rec->{$f}->[$i]->{$sf}) {                                  values %{$_};
                         $$found++ if (defined($$found));  
                         return $$rec->{$f}->[$i]->{$sf};  
                 } elsif ($$rec->{$f}->[$i]) {  
                         $$found++ if (defined($$found));  
                         # it still might have subfield, just  
                         # not specified, so we'll dump all  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
631                          } else {                          } else {
632                                  return $$rec->{$f}->[$i];                                  $_;
633                          }                          }
634                  }                  } @{ $rec->{$f} };
635          } else {          } elsif( defined($rec->{$f}) ) {
636                  return '';                  return $rec->{$f};
637          }          }
638  }  }
639    
640    =head2 rec2
641    
642  =head2 apply_format  Return all values in specific field and subfield
643    
644  Apply format specified in tag with C<format_name="name"> and    @v = rec2('200','a')
 C<format_delimiter=";;">.  
645    
646   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
647    
648  Formats can contain C<lookup{...}> if you need them.  sub rec2 {
649            my $f = shift;
650            return unless (defined($rec && $rec->{$f}));
651            my $sf = shift;
652            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
653    }
654    
655  =cut  =head2 rec
656    
657  sub apply_format {  syntaxtic sugar for
         my $self = shift;  
658    
659          my ($name,$delimiter,$data) = @_;    @v = rec('200')
660      @v = rec('200','a')
661    
662          my $log = $self->_get_logger();  =cut
663    
664          if (! $self->{'import_xml'}->{'format'}->{$name}) {  sub rec {
665                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});          my @out;
666                  return $data;          if ($#_ == 0) {
667                    @out = rec1(@_);
668            } elsif ($#_ == 1) {
669                    @out = rec2(@_);
670            }
671            if (@out) {
672                    return @out;
673            } else {
674                    return '';
675          }          }
676    }
677    
678          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 regex
679    
680          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Apply regex to some or all values
681    
682          my @data = split(/\Q$delimiter\E/, $data);    @v = regex( 's/foo/bar/g', @v );
683    
684          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
685    
686          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub regex {
687                  return $self->{'lookup'}->lookup($out);          my $r = shift;
688          } else {          my @out;
689                  return $out;          #warn "r: $r\n", dump(\@_);
690            foreach my $t (@_) {
691                    next unless ($t);
692                    eval "\$t =~ $r";
693                    push @out, $t if ($t && $t ne '');
694          }          }
695            return @out;
696  }  }
697    
698  =head2 sort_arr  =head2 prefix
699    
700  Sort array ignoring case and html in data  Prefix all values with a string
701    
702   my @sorted = $webpac->sort_arr(@unsorted);    @v = prefix( 'my_', @v );
703    
704  =cut  =cut
705    
706  sub sort_arr {  sub prefix {
707          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
708            return map { $p . $_ } grep { defined($_) } @_;
709    }
710    
711          my $log = $self->_get_logger();  =head2 suffix
712    
713          # FIXME add Schwartzian Transformation?  suffix all values with a string
714    
715          my @sorted = sort {    @v = suffix( '_my', @v );
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
716    
717          return @sorted;  =cut
 }  
718    
719    sub suffix {
720            my $s = shift or die "suffix needs string as first argument";
721            return map { $_ . $s } grep { defined($_) } @_;
722    }
723    
724  =head1 INTERNAL METHODS  =head2 surround
725    
726  =head2 _sort_by_order  surround all values with a two strings
727    
728  Sort xml tags data structure accoding to C<order=""> attribute.    @v = surround( 'prefix_', '_suffix', @v );
729    
730  =cut  =cut
731    
732  sub _sort_by_order {  sub surround {
733          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
734            my $s = shift or die "surround needs suffix as second argument";
735            return map { $p . $_ . $s } grep { defined($_) } @_;
736    }
737    
738    =head2 first
739    
740          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  Return first element
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
741    
742          return $va <=> $vb;    $v = first( @v );
 }  
743    
744  =head2 _x  =cut
745    
746    sub first {
747            my $r = shift;
748            return $r;
749    }
750    
751  Convert strings from C<conf/normalize/*.xml> encoding into application  =head2 lookup
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
752    
753   my $text = $n->_x('normalize text string');  Consult lookup hashes for some value
754    
755  This is a stub so that other modules doesn't have to implement it.    @v = lookup( $v );
756      @v = lookup( @v );
757    
758  =cut  =cut
759    
760  sub _x {  sub lookup {
761          my $self = shift;          my $k = shift or return;
762          return shift;          return unless (defined($lookup->{$k}));
763            if (ref($lookup->{$k}) eq 'ARRAY') {
764                    return @{ $lookup->{$k} };
765            } else {
766                    return $lookup->{$k};
767            }
768  }  }
769    
770    =head2 join_with
771    
772  =head1 AUTHOR  Joins walues with some delimiter
773    
774      $v = join_with(", ", @v);
775    
776    =cut
777    
778    sub join_with {
779            my $d = shift;
780            my $v = join($d, grep { defined($_) && $_ ne '' } @_);
781            return '' unless defined($v);
782            return $v;
783    }
784    
785  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =head2 split_rec_on
786    
787  =head1 COPYRIGHT & LICENSE  Split record subfield on some regex and take one of parts out
788    
789  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.    $a_before_semi_column =
790            split_rec_on('200','a', /\s*;\s*/, $part);
791    
792  This program is free software; you can redistribute it and/or modify it  C<$part> is optional number of element. First element is
793  under the same terms as Perl itself.  B<1>, not 0!
794    
795    If there is no C<$part> parameter or C<$part> is 0, this function will
796    return all values produced by splitting.
797    
798  =cut  =cut
799    
800  1; # End of WebPAC::DB  sub split_rec_on {
801            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
802    
803            my ($fld, $sf, $regex, $part) = @_;
804            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
805    
806            my @r = rec( $fld, $sf );
807            my $v = shift @r;
808            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
809    
810            return '' if( ! defined($v) || $v =~ /^\s*$/);
811    
812            my @s = split( $regex, $v );
813            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
814            if ($part && $part > 0) {
815                    return $s[ $part - 1 ];
816            } else {
817                    return @s;
818            }
819    }
820    
821    # END
822    1;

Legend:
Removed from v.39  
changed lines
  Added in v.583

  ViewVC Help
Powered by ViewVC 1.1.26