/[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 375 by dpavlin, Sun Jan 8 22:21:24 2006 UTC revision 564 by dpavlin, Sun Jul 2 20:14:21 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    
36  Version 0.08  Version 0.09
37    
38  =cut  =cut
39    
40  our $VERSION = '0.08';  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  =item *  C<perl -c normalize.pl>.
51    
52  format of fields is defined using C<v123^a> notation for repeatable fields  Normalisation can generate multiple output normalized data. For now, supported output
53  or C<s123^a> for single (or first) value, where C<123> is field number and  types (on the left side of definition) are: C<tag>, C<display>, C<search> and
54  C<a> is subfield.  C<marc>.
   
 =item *  
   
 source data records (C<$rec>) have unique identifiers in field C<000>  
55    
56  =item *  =head1 FUNCTIONS
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);  
121    
122          my $r = $self->{'lookup_regex'} ? 1 : 0;  sub _get_ds {
123          my $l = $self->{'lookup'} ? 1 : 0;          return $out;
124    }
         my $log = $self->_get_logger();  
   
         # those two must be in pair  
         if ( ($r & $l) != ($r || $l) ) {  
                 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 _set_lookup
141    
142  =head2 data_structure  Set current lookup hash
143    
144  Create in-memory data structure which represents normalized layout from    _set_lookup( $lookup );
 C<conf/normalize/*.xml>.  
145    
146  This structures are used to produce output.  =cut
147    
148   my $ds = $webpac->data_structure($rec);  my $lookup;
149    
150  =cut  sub _set_lookup {
151            $lookup = shift;
152    }
153    
154  sub data_structure {  =head2 _get_marc_fields
         my $self = shift;  
155    
156          my $log = $self->_get_logger();  Get all fields defined by calls to C<marc>
157    
158          my $rec = shift;          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
159    
160          $log->debug("data_structure rec = ", sub { Dumper($rec) });  We are using I<magic> which detect repeatable fields only from
161    sequence of field/subfield data generated by normalization.
162    
163          $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));  Repeatable field is created when there is second occurence of same subfield or
164    if any of indicators are different.
165    
166          my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  This is sane for most cases. Something like:
167    
168          my $cache_file;    900a-1 900b-1 900c-1
169      900a-2 900b-2
170      900a-3
171    
172          if ($self->{'db'}) {  will be created from any combination of:
                 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");  
         }  
173    
174          my @sorted_tags;    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
         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;  
         }  
175    
176          my $ds;  and following rules:
177    
178          $log->debug("tags: ",sub { join(", ",@sorted_tags) });    marc('900','a', rec('200','a') );
179      marc('900','b', rec('200','b') );
180      marc('900','c', rec('200','c') );
181    
182          foreach my $field (@sorted_tags) {  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                  my $row;  ....
186    
187  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  =cut
188    
189                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  sub _get_marc_fields {
                         my $format;  
190    
191                          $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
                         $format = $tag->{'value'} || $tag->{'content'};  
192    
193                          my @v;          # first, sort all existing fields
194                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          # XXX might not be needed, but modern perl might randomize elements in hash
195                                  @v = $self->_rec_to_arr($rec,$format,'fill_in');          my @sorted_marc_record = sort {
196                          } else {                  $a->[0] . $a->[3] cmp $b->[0] . $b->[3]
197                                  @v = $self->_rec_to_arr($rec,$format,'parse');          } @{ $marc_record };
                         }  
                         if (! @v) {  
                                 $log->debug("$field <",$self->{tag},"> format: $format no values");  
                                 next;  
                         } else {  
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
198    
199                          if ($tag->{'sort'}) {          @sorted_marc_record = @{ $marc_record };        ### FIXME disable sorting
200                                  @v = $self->sort_arr(@v);          
201                          }          # output marc fields
202            my @m;
203    
204                          # use format?          # count unique field-subfields (used for offset when walking to next subfield)
205                          if ($tag->{'format_name'}) {          my $u;
206                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;          map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
207                          }  
208            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                          # delimiter will join repeatable fields          my $len = $#sorted_marc_record;
216                          if ($tag->{'delimiter'}) {          my $visited;
217                                  @v = ( join($tag->{'delimiter'}, @v) );          my $i = 0;
218                          }          my $field;
219    
220                          # default types          foreach ( 0 .. $len ) {
                         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;  
                                 }  
                         }  
221    
222                    # 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                  }                  }
245    
246                  if ($row) {                  # if field exists
247                          $row->{'tag'} = $field;                  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    
268                          # TODO: name_sigular, name_plural                          } else {
269                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};                                  # append new subfields to existing field
270                          my $row_name = $name ? $self->_x($name) : $field;                                  push @$field, ( $row->[3], $row->[4] );
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
271                          }                          }
272                    } else {
273                          $ds->{$row_name} = $row;                          # insert first field
274                            $field = $row;
                         $log->debug("row $field: ",sub { Dumper($row) });  
275                  }                  }
276    
277                    if (! $marc_repeatable_subfield->{ $fsf }) {
278                            # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
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;          } 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') );
                 # add rest of format (suffix)  
                 $out .= $format;  
384    
385                  # add prefix if not there  =cut
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
386    
387                  $log->debug("result: $out");  sub marc {
388          }          my $f = shift or die "marc needs field";
389            die "marc field must be numer" unless ($f =~ /^\d+$/);
390    
391          if ($eval_code) {          my $sf = shift or die "marc needs subfield";
                 my $eval = $self->fill_in($rec,$eval_code,$i) || return;  
                 $log->debug("about to eval{$eval} format: $out");  
                 return if (! $self->_eval($eval));  
         }  
           
         if ($filter_name) {  
                 my @filter_args;  
                 if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {  
                         @filter_args = split(/,/, $2);  
                 }  
                 if ($self->{'filter'}->{$filter_name}) {  
                         $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));  
                         unshift @filter_args, $out;  
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
                 }  
         }  
392    
393          return $out;          foreach (@_) {
394                    my $v = $_;             # make var read-write for Encode
395                    next unless (defined($v) && $v !~ /^\s*$/);
396                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
397                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
398                    push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
399            }
400  }  }
401    
402  =head2 fill_in  =head2 marc_repeatable_subfield
403    
404  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.  
405    
406   my $text = $webpac->fill_in($rec,'v250^a');    marc_repeatable_subfield('910', 'z', rec('909') );
407    
408  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.  
409    
410   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_repeatable_subfield {
411            my ($f,$sf) = @_;
412            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
413            $marc_repeatable_subfield->{ $f . $sf }++;
414            marc(@_);
415    }
416    
417  This function B<does not> perform parsing of format to inteligenty skip  =head2 marc_indicators
 delimiters before fields which aren't used.  
418    
419  This method will automatically decode UTF-8 string to local code page  Set both indicators for MARC field
 if needed.  
420    
421  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.  
422    
423   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.
424    
425  =cut  =cut
426    
427  sub fill_in {  sub marc_indicators {
428          my $self = shift;          my $f = shift || die "marc_indicators need field!\n";
429            my ($i1,$i2) = @_;
430          my $log = $self->_get_logger();          die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
431            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
432    
433          my ($rec,$format,$i,$rec_size) = @_;          $i1 = ' ' if ($i1 !~ /^\d$/);
434            $i2 = ' ' if ($i2 !~ /^\d$/);
435          $log->logconfess("need data record") unless ($rec);          @{ $marc_indicators->{$f} } = ($i1,$i2);
436          $log->logconfess("need format to parse") unless($format);  }
437    
438          # iteration (for repeatable fields)  =head2 marc_compose
         $i ||= 0;  
439    
440          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  Save values for each MARC subfield explicitly
441    
442          # FIXME remove for speedup?    marc_compose('900',
443          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          'a', rec('200','a')
444            'b', rec('201','a')
445            'a', rec('200','b')
446            'c', rec('200','c')
447      );
448    
449          if (utf8::is_utf8($format)) {  =cut
                 $format = $self->_x($format);  
         }  
450    
451          my $found = 0;  sub marc_compose {
452          my $just_single = 1;          my $f = shift or die "marc_compose needs field";
453            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
454    
455          my $eval_code;          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
456          # remove eval{...} from beginning          my $m = [ $f, $i1, $i2 ];
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
457    
458          my $filter_name;          while (@_) {
459          # remove filter{...} from beginning                  my $sf = shift or die "marc_compose $f needs subfield";
460          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);                  my $v = shift or die "marc_compose $f needs value for subfield $sf";
461    
462          # do actual replacement of placeholders                  next unless (defined($v) && $v !~ /^\s*$/);
463          # repeatable fields                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
464          if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {                  push @$m, ( $sf, $v );
465                  $just_single = 0;                  warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ) if ($debug > 1);
466          }          }
467    
468          # non-repeatable fields          warn "## marc_compose(d) ", dump( $m ) if ($debug > 1);
         if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  
                 return if ($i > 0 && $just_single);  
         }  
469    
470          if ($found) {          push @{ $marc_record }, $m;
                 $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;  
         }  
471  }  }
472    
473    
474  =head2 _rec_to_arr  =head1 Functions to extract data from input
   
 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>.  
475    
476   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]','paste');  This function should be used inside functions to create C<data_structure> described
477    above.
478    
479  =cut  =head2 rec1
   
 sub _rec_to_arr {  
         my $self = shift;  
480    
481          my ($rec, $format_utf8, $code) = @_;  Return all values in some field
482    
483          my $log = $self->_get_logger();    @v = rec1('200')
484    
485          $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);  
486    
487          $log->debug("using $code on $format_utf8");  =cut
488    
489          my $i = 0;  sub rec1 {
490          my $max = 0;          my $f = shift;
491          my @arr;          return unless (defined($rec) && defined($rec->{$f}));
492          my $rec_size = {};          if (ref($rec->{$f}) eq 'ARRAY') {
493                    return map {
494          while ($i <= $max) {                          if (ref($_) eq 'HASH') {
495                  my @v = $self->$code($rec,$format_utf8,$i++,\$rec_size);                                  values %{$_};
496                  if ($rec_size) {                          } else {
497                          foreach my $f (keys %{ $rec_size }) {                                  $_;
                                 $max = $rec_size->{$f} if ($rec_size->{$f} > $max);  
498                          }                          }
499                          $log->debug("max set to $max");                  } @{ $rec->{$f} };
500                          undef $rec_size;          } elsif( defined($rec->{$f}) ) {
501                  }                  return $rec->{$f};
                 if (@v) {  
                         push @arr, @v;  
                 } else {  
                         push @arr, '' if ($max > $i);  
                 }  
502          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
503  }  }
504    
505    =head2 rec2
506    
507  =head2 get_data  Return all values in specific field and subfield
508    
509  Returns value from record.    @v = rec2('200','a')
510    
511   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  =cut
   
 Required arguments are:  
   
 =over 8  
512    
513  =item C<$rec>  sub rec2 {
514            my $f = shift;
515            return unless (defined($rec && $rec->{$f}));
516            my $sf = shift;
517            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
518    }
519    
520  record reference  =head2 rec
521    
522  =item C<$f>  syntaxtic sugar for
523    
524  field    @v = rec('200')
525      @v = rec('200','a')
526    
527  =item C<$sf>  =cut
528    
529  optional subfield  sub rec {
530            if ($#_ == 0) {
531                    return rec1(@_);
532            } elsif ($#_ == 1) {
533                    return rec2(@_);
534            }
535    }
536    
537  =item C<$i>  =head2 regex
538    
539  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )  Apply regex to some or all values
540    
541  =item C<$found>    @v = regex( 's/foo/bar/g', @v );
542    
543  optional variable that will be incremeted if preset  =cut
544    
545  =item C<$rec_size>  sub regex {
546            my $r = shift;
547            my @out;
548            #warn "r: $r\n", dump(\@_);
549            foreach my $t (@_) {
550                    next unless ($t);
551                    eval "\$t =~ $r";
552                    push @out, $t if ($t && $t ne '');
553            }
554            return @out;
555    }
556    
557  hash to hold maximum occurances of C<field^subfield> combinations  =head2 prefix
 (which can be accessed using keys in same format)  
558    
559  =back  Prefix all values with a string
560    
561  Returns value or empty string, updates C<$found> and C<rec_size>    @v = prefix( 'my_', @v );
 if present.  
562    
563  =cut  =cut
564    
565  sub get_data {  sub prefix {
566          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
567            return map { $p . $_ } grep { defined($_) } @_;
568    }
569    
570          my ($rec,$f,$sf,$i,$found,$cache) = @_;  =head2 suffix
571    
572          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');  suffix all values with a string
573    
574          if (defined($$cache)) {    @v = suffix( '_my', @v );
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
         }  
575    
576          return '' unless ($$rec->{$f}->[$i]);  =cut
577    
578          {  sub suffix {
579                  no strict 'refs';          my $s = shift or die "suffix needs string as first argument";
580                  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]}) {  
                                         $out .= '$' . $k .':' . $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 }  
         }  
581  }  }
582    
583    =head2 surround
584    
585  =head2 apply_format  surround all values with a two strings
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
586    
587   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    @v = surround( 'prefix_', '_suffix', @v );
   
 Formats can contain C<lookup{...}> if you need them.  
588    
589  =cut  =cut
590    
591  sub apply_format {  sub surround {
592          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
593            my $s = shift or die "surround needs suffix as second argument";
594          my ($name,$delimiter,$data) = @_;          return map { $p . $_ . $s } grep { defined($_) } @_;
595    }
         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);  
596    
597          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =head2 first
598    
599          my @data = split(/\Q$delimiter\E/, $data);  Return first element
600    
601          my $out = sprintf($format, @data);    $v = first( @v );
         $log->debug("using format $name [$format] on $data to produce: $out");  
602    
603          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
                 return $self->{'lookup'}->lookup($out);  
         } else {  
                 return $out;  
         }  
604    
605    sub first {
606            my $r = shift;
607            return $r;
608  }  }
609    
610  =head2 sort_arr  =head2 lookup
611    
612  Sort array ignoring case and html in data  Consult lookup hashes for some value
613    
614   my @sorted = $webpac->sort_arr(@unsorted);    @v = lookup( $v );
615      @v = lookup( @v );
616    
617  =cut  =cut
618    
619  sub sort_arr {  sub lookup {
620          my $self = shift;          my $k = shift or return;
621            return unless (defined($lookup->{$k}));
622          my $log = $self->_get_logger();          if (ref($lookup->{$k}) eq 'ARRAY') {
623                    return @{ $lookup->{$k} };
624          # FIXME add Schwartzian Transformation?          } else {
625                    return $lookup->{$k};
626          my @sorted = sort {          }
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
   
         return @sorted;  
627  }  }
628    
629    =head2 join_with
630    
631  =head1 INTERNAL METHODS  Joins walues with some delimiter
   
 =head2 _sort_by_order  
632    
633  Sort xml tags data structure accoding to C<order=""> attribute.    $v = join_with(", ", @v);
634    
635  =cut  =cut
636    
637  sub _sort_by_order {  sub join_with {
638          my $self = shift;          my $d = shift;
639            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;  
640  }  }
641    
642  =head2 _x  =head2 split_rec_on
643    
644  Convert strings from C<conf/normalize/*.xml> encoding into application  Split record subfield on some regex and take one of parts out
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
645    
646   my $text = $n->_x('normalize text string');    $a_before_semi_column =
647            split_rec_on('200','a', /\s*;\s*/, $part);
648    
649  This is a stub so that other modules doesn't have to implement it.  C<$part> is optional number of element. First element is
650    B<1>, not 0!
651    
652  =cut  If there is no C<$part> parameter or C<$part> is 0, this function will
653    return all values produced by splitting.
654    
655  sub _x {  =cut
         my $self = shift;  
         return shift;  
 }  
   
   
 =head1 AUTHOR  
   
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
656    
657  =head1 COPYRIGHT & LICENSE  sub split_rec_on {
658            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
659    
660  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.          my ($fld, $sf, $regex, $part) = @_;
661            warn "### regex ", ref($regex), $regex if ($debug > 2);
662    
663  This program is free software; you can redistribute it and/or modify it          my @r = rec( $fld, $sf );
664  under the same terms as Perl itself.          my $v = shift @r;
665            warn "### first rec($fld,$sf) = ",dump($v) if ($debug > 2);
666    
667  =cut          my @s = split( $regex, $v );
668            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s) if ($debug > 1);
669            if ($part > 0) {
670                    return $s[ $part - 1 ];
671            } else {
672                    return @s;
673            }
674    }
675    
676  1; # End of WebPAC::Normalize  # END
677    1;

Legend:
Removed from v.375  
changed lines
  Added in v.564

  ViewVC Help
Powered by ViewVC 1.1.26