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

Legend:
Removed from v.253  
changed lines
  Added in v.601

  ViewVC Help
Powered by ViewVC 1.1.26