/[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 562 by dpavlin, Sun Jul 2 16:14:41 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
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.09  Version 0.08
37    
38  =cut  =cut
39    
40  our $VERSION = '0.09';  our $VERSION = '0.08';
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;  
121    
122          my $log = $self->_get_logger();  sub _get_ds {
123            return $out;
124          # 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 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
   
 Perform smart parsing of string, skipping delimiters for fields which aren't  
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
   
  my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  
292    
293  Filters are implemented here. While simple form of filters looks like this:  Change level of debug warnings
294    
295    filter{name_of_filter}    _debug( 2 );
   
 but, filters can also have variable number of parametars like this:  
   
   filter{name_of_filter(param,param,param)}  
296    
297  =cut  =cut
298    
299  my $warn_once;  sub _debug {
300            my $l = shift;
301  sub parse {          return $debug unless defined($l);
302          my $self = shift;          warn "debug level $l" if ($l > 0);
303            $debug = $l;
304    }
305    
306          my ($rec, $format_utf8, $i, $rec_size) = @_;  =head1 Functions to create C<data_structure>
307    
308          return if (! $format_utf8);  Those functions generally have to first in your normalization file.
309    
310          my $log = $self->_get_logger();  =head2 tag
311    
312          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Define new tag for I<search> and I<display>.
313    
314          $i = 0 if (! $i);    tag('Title', rec('200','a') );
315    
         my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  
316    
317          my @out;  =cut
318    
319          $log->debug("format: $format [$i]");  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          my $eval_code;  =head2 display
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
329    
330          my $filter_name;  Define tag just for I<display>
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
331    
332          # did we found any (att all) field from format in row?    @v = display('Title', rec('200','a') );
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
333    
334          my $f_step = 1;  =cut
335    
336          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  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 $del = $1 || '';  =head2 search
                 $prefix = $del if ($f_step == 1);  
345    
346                  my $fld_type = lc($2);  Prepare values just for I<search>
347    
348                  # repeatable index    @v = search('Title', rec('200','a') );
                 my $r = $i;  
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
                         } else {  
                                 return;  
                         }  
                 }  
349    
350                  my $found = 0;  =cut
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
351    
352                  if ($found) {  sub search {
353                          $found_any->{$fld_type} += $found;          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                          # we will skip delimiter before first occurence of field!  =head2 marc
                         push @out, $del unless($found_any->{$fld_type} == 1);  
                         push @out, $tmp if ($tmp);  
                 }  
                 $f_step++;  
         }  
361    
362          # test if any fields found?  Save value for MARC field
         return if (! $found_any->{'v'} && ! $found_any->{'s'});  
363    
364          my $out = join('',@out);    marc('900','a', rec('200','a') );
365    
366          if ($out) {  =cut
                 # add rest of format (suffix)  
                 $out .= $format;  
367    
368                  # add prefix if not there  sub marc {
369                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my $f = shift or die "marc needs field";
370            die "marc field must be numer" unless ($f =~ /^\d+$/);
371    
372                  $log->debug("result: $out");          my $sf = shift or die "marc needs subfield";
         }  
373    
374          if ($eval_code) {          foreach (@_) {
375                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  my $v = $_;             # make var read-write for Encode
376                  $log->debug("about to eval{$eval} format: $out");                  next unless (defined($v) && $v !~ /^\s*$/);
377                  return if (! $self->_eval($eval));                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
378                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
379                    push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
380          }          }
           
         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}++;  
                 }  
         }  
   
         return $out;  
381  }  }
382    
383  =head2 fill_in  =head2 marc_repeatable_subfield
384    
385  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.  
386    
387   my $text = $webpac->fill_in($rec,'v250^a');    marc_repeatable_subfield('910', 'z', rec('909') );
388    
389  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.  
390    
391   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc_repeatable_subfield {
392            my ($f,$sf) = @_;
393            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
394            $marc_repeatable_subfield->{ $f . $sf }++;
395            marc(@_);
396    }
397    
398  This function B<does not> perform parsing of format to inteligenty skip  =head2 marc_indicators
 delimiters before fields which aren't used.  
399    
400  This method will automatically decode UTF-8 string to local code page  Set both indicators for MARC field
 if needed.  
401    
402  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.  
403    
404   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.
405    
406  =cut  =cut
407    
408  sub fill_in {  sub marc_indicators {
409          my $self = shift;          my $f = shift || die "marc_indicators need field!\n";
410            my ($i1,$i2) = @_;
411          my $log = $self->_get_logger();          die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
412            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
413    
414          my ($rec,$format,$i,$rec_size) = @_;          $i1 = ' ' if ($i1 !~ /^\d$/);
415            $i2 = ' ' if ($i2 !~ /^\d$/);
416          $log->logconfess("need data record") unless ($rec);          @{ $marc_indicators->{$f} } = ($i1,$i2);
417          $log->logconfess("need format to parse") unless($format);  }
418    
419          # iteration (for repeatable fields)  =head2 marc_compose
         $i ||= 0;  
420    
421          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  Save values for each MARC subfield explicitly
422    
423          # FIXME remove for speedup?    marc_compose('900',
424          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          'a', rec('200','a')
425            'b', rec('201','a')
426            'a', rec('200','b')
427            'c', rec('200','c')
428      );
429    
430          if (utf8::is_utf8($format)) {  =cut
                 $format = $self->_x($format);  
         }  
431    
432          my $found = 0;  sub marc_compose {
433          my $just_single = 1;          my $f = shift or die "marc_compose needs field";
434            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
435    
436          my $eval_code;          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
437          # remove eval{...} from beginning          my $m = [ $f, $i1, $i2 ];
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
   
         my $filter_name;  
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
   
         {  
                 # fix warnings  
                 no warnings 'uninitialized';  
   
                 # do actual replacement of placeholders  
                 # repeatable fields  
                 if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                         $just_single = 0;  
                 }  
438    
439                  # non-repeatable fields          while (@_) {
440                  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";
441                          return if ($i > 0 && $just_single);                  my $v = shift or die "marc_compose $f needs value for subfield $sf";
                 }  
         }  
442    
443          if ($found) {                  next unless (defined($v) && $v !~ /^\s*$/);
444                  $log->debug("format: $format");                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
445                  if ($eval_code) {                  push @$m, ( $sf, $v );
446                          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;  
447          }          }
 }  
448    
449            warn "## marc_compose(d) ", dump( $m ) if ($debug > 1);
450    
451  =head2 _rec_to_arr          push @{ $marc_record }, $m;
452    }
453    
 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>.  
454    
455   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]','paste');  =head1 Functions to extract data from input
456    
457  =cut  This function should be used inside functions to create C<data_structure> described
458    above.
459    
460  sub _rec_to_arr {  =head2 rec1
         my $self = shift;  
461    
462          my ($rec, $format_utf8, $code) = @_;  Return all values in some field
463    
464          my $log = $self->_get_logger();    @v = rec1('200')
465    
466          $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);  
467    
468          $log->debug("using $code on $format_utf8");  =cut
469    
470          my $i = 0;  sub rec1 {
471          my $max = 0;          my $f = shift;
472          my @arr;          return unless (defined($rec) && defined($rec->{$f}));
473          my $rec_size = {};          if (ref($rec->{$f}) eq 'ARRAY') {
474                    return map {
475          while ($i <= $max) {                          if (ref($_) eq 'HASH') {
476                  my @v = $self->$code($rec,$format_utf8,$i++,\$rec_size);                                  values %{$_};
477                  if ($rec_size) {                          } else {
478                          foreach my $f (keys %{ $rec_size }) {                                  $_;
                                 $max = $rec_size->{$f} if ($rec_size->{$f} > $max);  
479                          }                          }
480                          $log->debug("max set to $max");                  } @{ $rec->{$f} };
481                          undef $rec_size;          } elsif( defined($rec->{$f}) ) {
482                  }                  return $rec->{$f};
                 if (@v) {  
                         push @arr, @v;  
                 } else {  
                         push @arr, '' if ($max > $i);  
                 }  
483          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
484  }  }
485    
486    =head2 rec2
487    
488  =head2 get_data  Return all values in specific field and subfield
   
 Returns value from record.  
   
  my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  
489    
490  Required arguments are:    @v = rec2('200','a')
491    
492  =over 8  =cut
493    
494  =item C<$rec>  sub rec2 {
495            my $f = shift;
496            return unless (defined($rec && $rec->{$f}));
497            my $sf = shift;
498            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
499    }
500    
501  record reference  =head2 rec
502    
503  =item C<$f>  syntaxtic sugar for
504    
505  field    @v = rec('200')
506      @v = rec('200','a')
507    
508  =item C<$sf>  =cut
509    
510  optional subfield  sub rec {
511            if ($#_ == 0) {
512                    return rec1(@_);
513            } elsif ($#_ == 1) {
514                    return rec2(@_);
515            }
516    }
517    
518  =item C<$i>  =head2 regex
519    
520  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )  Apply regex to some or all values
521    
522  =item C<$found>    @v = regex( 's/foo/bar/g', @v );
523    
524  optional variable that will be incremeted if preset  =cut
525    
526  =item C<$rec_size>  sub regex {
527            my $r = shift;
528            my @out;
529            #warn "r: $r\n", dump(\@_);
530            foreach my $t (@_) {
531                    next unless ($t);
532                    eval "\$t =~ $r";
533                    push @out, $t if ($t && $t ne '');
534            }
535            return @out;
536    }
537    
538  hash to hold maximum occurances of C<field^subfield> combinations  =head2 prefix
 (which can be accessed using keys in same format)  
539    
540  =back  Prefix all values with a string
541    
542  Returns value or empty string, updates C<$found> and C<rec_size>    @v = prefix( 'my_', @v );
 if present.  
543    
544  =cut  =cut
545    
546  sub get_data {  sub prefix {
547          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
548            return map { $p . $_ } grep { defined($_) } @_;
549    }
550    
551          my ($rec,$f,$sf,$i,$found,$cache) = @_;  =head2 suffix
552    
553          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');  suffix all values with a string
554    
555          if (defined($$cache)) {    @v = suffix( '_my', @v );
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
         }  
556    
557          return '' unless ($$rec->{$f}->[$i]);  =cut
558    
559          {  sub suffix {
560                  no strict 'refs';          my $s = shift or die "suffix needs string as first argument";
561                  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];  
                         }  
                 }  
         }  
562  }  }
563    
564    =head2 surround
565    
566  =head2 apply_format  surround all values with a two strings
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
   
  my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  
567    
568  Formats can contain C<lookup{...}> if you need them.    @v = surround( 'prefix_', '_suffix', @v );
569    
570  =cut  =cut
571    
572  sub apply_format {  sub surround {
573          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
574            my $s = shift or die "surround needs suffix as second argument";
575          my ($name,$delimiter,$data) = @_;          return map { $p . $_ . $s } grep { defined($_) } @_;
576    }
         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);  
577    
578          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =head2 first
579    
580          my @data = split(/\Q$delimiter\E/, $data);  Return first element
581    
582          my $out = sprintf($format, @data);    $v = first( @v );
         $log->debug("using format $name [$format] on $data to produce: $out");  
583    
584          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
                 return $self->{'lookup'}->lookup($out);  
         } else {  
                 return $out;  
         }  
585    
586    sub first {
587            my $r = shift;
588            return $r;
589  }  }
590    
591  =head2 sort_arr  =head2 lookup
592    
593  Sort array ignoring case and html in data  Consult lookup hashes for some value
594    
595   my @sorted = $webpac->sort_arr(@unsorted);    @v = lookup( $v );
596      @v = lookup( @v );
597    
598  =cut  =cut
599    
600  sub sort_arr {  sub lookup {
601          my $self = shift;          my $k = shift or return;
602            return unless (defined($lookup->{$k}));
603          my $log = $self->_get_logger();          if (ref($lookup->{$k}) eq 'ARRAY') {
604                    return @{ $lookup->{$k} };
605          # FIXME add Schwartzian Transformation?          } else {
606                    return $lookup->{$k};
607          my @sorted = sort {          }
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
   
         return @sorted;  
608  }  }
609    
610    =head2 join_with
611    
612  =head1 INTERNAL METHODS  Joins walues with some delimiter
   
 =head2 _sort_by_order  
613    
614  Sort xml tags data structure accoding to C<order=""> attribute.    $v = join_with(", ", @v);
615    
616  =cut  =cut
617    
618  sub _sort_by_order {  sub join_with {
619          my $self = shift;          my $d = shift;
620            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;  
621  }  }
622    
623  =head2 _x  =head2 split_rec_on
624    
625  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).  
626    
627   my $text = $n->_x('normalize text string');    $a_before_semi_column =
628            split_rec_on('200','a', /\s*;\s*/, $part);
629    
630  This is a stub so that other modules doesn't have to implement it.  C<$part> is optional number of element. First element is
631    B<1>, not 0!
632    
633  =cut  If there is no C<$part> parameter or C<$part> is 0, this function will
634    return all values produced by splitting.
 sub _x {  
         my $self = shift;  
         return shift;  
 }  
   
   
 =head1 AUTHOR  
635    
636  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  =cut
637    
638  =head1 COPYRIGHT & LICENSE  sub split_rec_on {
639            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
640    
641  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.          my ($fld, $sf, $regex, $part) = @_;
642            warn "### regex ", ref($regex), $regex if ($debug > 2);
643    
644  This program is free software; you can redistribute it and/or modify it          my @r = rec( $fld, $sf );
645  under the same terms as Perl itself.          my $v = shift @r;
646            warn "### first rec($fld,$sf) = ",dump($v) if ($debug > 2);
647    
648  =cut          my @s = split( $regex, $v );
649            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s) if ($debug > 1);
650            if ($part > 0) {
651                    return $s[ $part - 1 ];
652            } else {
653                    return @s;
654            }
655    }
656    
657  1; # End of WebPAC::Normalize  # END
658    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26