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

Legend:
Removed from v.436  
changed lines
  Added in v.571

  ViewVC Help
Powered by ViewVC 1.1.26