/[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 29 by dpavlin, Sun Jul 24 11:17:44 2005 UTC revision 565 by dpavlin, Sun Jul 2 20:33:13 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 base 'WebPAC::Common';  
22  use Data::Dumper;  #use base qw/WebPAC::Common/;
23    use Data::Dump qw/dump/;
24    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.01  Version 0.09
37    
38  =cut  =cut
39    
40  our $VERSION = '0.01';  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    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  =over  =head1 FUNCTIONS
   
 =item *  
   
 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.  
57    
58  =item *  Functions which start with C<_> are private and used by WebPAC internally.
59    All other functions are available for use within normalisation rules.
60    
61  source data records (C<$rec>) have unique identifiers in field C<000>  =head2 data_structure
62    
63  =item *  Return data structure
64    
65  optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be    my $ds = WebPAC::Normalize::data_structure(
66  perl code that is evaluated before producing output (value of field will be          lookup => $lookup->lookup_hash,
67  interpolated before that)          row => $row,
68            rules => $normalize_pl_config,
69            marc_encoding => 'utf-8',
70      );
71    
72  =item *  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
73    other are optional.
74    
75  optional C<filter{filter_name}> at B<begining of format> will apply perl  This function will B<die> if normalizastion can't be evaled.
 code defined as code ref on format after field substitution to producing  
 output  
76    
77  =item *  Since this function isn't exported you have to call it with
78    C<WebPAC::Normalize::data_structure>.
79    
80  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  =cut
81    
82  =item *  sub data_structure {
83            my $arg = {@_};
84    
85  at end, optional C<format>s rules are resolved. Format rules are similar to          die "need row argument" unless ($arg->{row});
86  C<sprintf> and can also contain C<lookup{...}> which is performed after          die "need normalisation argument" unless ($arg->{rules});
 values are inserted in format.  
87    
88  =back          no strict 'subs';
89            _set_lookup( $arg->{lookup} );
90            _set_rec( $arg->{row} );
91            _clean_ds( %{ $arg } );
92            eval "$arg->{rules}";
93            die "error evaling $arg->{rules}: $@\n" if ($@);
94    
95  This also describes order in which transformations are applied (eval,          return _get_ds();
96  filter, lookup, format) which is important to undestand when deciding how to  }
 solve your data mungling and normalisation process.  
97    
98    =head2 _set_rec
99    
100    Set current record hash
101    
102      _set_rec( $rec );
103    
104  =head1 FUNCTIONS  =cut
105    
106  =head2 new  my $rec;
107    
108  Create new normalisation object  sub _set_rec {
109            $rec = shift or die "no record hash";
110    }
111    
112    my $n = new WebPAC::Normalize::Something(  =head2 _get_ds
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
   );  
113    
114  Parametar C<filter> defines user supplied snippets of perl code which can  Return hash formatted as data structure
 be use with C<filter{...}> notation.  
115    
116  Recommended parametar C<lookup_regex> is used to enable parsing of lookups    my $ds = _get_ds();
 in structures.  
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          $self ? return $self : return undef;  sub _get_ds {
123            return $out;
124  }  }
125    
126    =head2 _clean_ds
127    
128  =head2 data_structure  Clean data structure hash for next record
129    
130  Create in-memory data structure which represents normalized layout from    _clean_ds();
 C<conf/normalize/*.xml>.  
131    
132  This structures are used to produce output.  =cut
133    
134    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   my @ds = $webpac->data_structure($rec);  =head2 _set_lookup
141    
142  B<Note: historical oddity follows>  Set current lookup hash
143    
144  This method will also set C<< $webpac->{'currnet_filename'} >> if there is    _set_lookup( $lookup );
 C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
 C<< <headline> >> tag.  
145    
146  =cut  =cut
147    
148  sub data_structure {  my $lookup;
         my $self = shift;  
149    
150          my $log = $self->_get_logger();  sub _set_lookup {
151            $lookup = shift;
152    }
153    
154          my $rec = shift;  =head2 _get_marc_fields
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
155    
156          my $cache_file;  Get all fields defined by calls to C<marc>
157    
158          if ($self->{'db'}) {          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
                 my @ds = $self->{'db'}->load_ds($rec);  
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper(@ds) });  
                 return @ds if ($#ds > 0);  
                 $log->debug("cache miss, creating");  
         }  
159    
160          undef $self->{'currnet_filename'};  We are using I<magic> which detect repeatable fields only from
161          undef $self->{'headline'};  sequence of field/subfield data generated by normalization.
162    
163          my @sorted_tags;  Repeatable field is created when there is second occurence of same subfield or
164          if ($self->{tags_by_order}) {  if any of indicators are different.
                 @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;  
         }  
165    
166          my @ds;  This is sane for most cases. Something like:
167    
168          $log->debug("tags: ",sub { join(", ",@sorted_tags) });    900a-1 900b-1 900c-1
169      900a-2 900b-2
170      900a-3
171    
172          foreach my $field (@sorted_tags) {  will be created from any combination of:
173    
174                  my $row;    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
175    
176  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  and following rules:
177    
178                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {    marc('900','a', rec('200','a') );
179                          my $format = $tag->{'value'} || $tag->{'content'};    marc('900','b', rec('200','b') );
180      marc('900','c', rec('200','c') );
181    
182                          $log->debug("format: $format");  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 @v;  ....
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->fill_in_to_arr($rec,$format);  
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
186    
187                          if ($tag->{'sort'}) {  =cut
                                 @v = $self->sort_arr(@v);  
                         }  
188    
189                          # use format?  sub _get_marc_fields {
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
190    
191                          if ($field eq 'filename') {          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
                                 $self->{'current_filename'} = join('',@v);  
                                 $log->debug("filename: ",$self->{'current_filename'});  
                         } elsif ($field eq 'headline') {  
                                 $self->{'headline'} .= join('',@v);  
                                 $log->debug("headline: ",$self->{'headline'});  
                                 next; # don't return headline in data_structure!  
                         }  
192    
193                          # delimiter will join repeatable fields          # first, sort all existing fields
194                          if ($tag->{'delimiter'}) {          # XXX might not be needed, but modern perl might randomize elements in hash
195                                  @v = ( join($tag->{'delimiter'}, @v) );          my @sorted_marc_record = sort {
196                          }                  $a->[0] . $a->[3] cmp $b->[0] . $b->[3]
197            } @{ $marc_record };
198    
199                          # default types          @sorted_marc_record = @{ $marc_record };        ### FIXME disable sorting
200                          my @types = qw(display swish);          
201                          # override by type attribute          # output marc fields
202                          @types = ( $tag->{'type'} ) if ($tag->{'type'});          my @m;
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
   
                                 } else {  
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
203    
204            # count unique field-subfields (used for offset when walking to next subfield)
205            my $u;
206            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            my $len = $#sorted_marc_record;
216            my $visited;
217            my $i = 0;
218            my $field;
219    
220            foreach ( 0 .. $len ) {
221    
222                    # find next element which isn't visited
223                    while ($visited->{$i}) {
224                            $i = ($i + 1) % ($len + 1);
225                  }                  }
226    
227                  if ($row) {                  # mark it visited
228                          $row->{'tag'} = $field;                  $visited->{$i}++;
229    
230                          # TODO: name_sigular, name_plural                  my $row = $sorted_marc_record[$i];
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         $row->{'name'} = $name ? $self->_x($name) : $field;  
   
                         # post-sort all values in field  
                         if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
                                 $log->warn("sort at field tag not implemented");  
                         }  
231    
232                          push @ds, $row;                  # 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    
                         $log->debug("row $field: ",sub { Dumper($row) });  
244                  }                  }
245    
246          }                  # if field exists
247                    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          $self->{'db'}->save_ds(                          } else {
269                  ds => \@ds,                                  # append new subfields to existing field
270                  current_filename => $self->{'current_filename'},                                  push @$field, ( $row->[3], $row->[4] );
271                  headline => $self->{'headline'},                          }
272          ) if ($self->{'db'});                  } else {
273                            # insert first field
274                            $field = $row;
275                    }
276    
277          $log->debug("ds: ", sub { Dumper(@ds) });                  if (! $marc_repeatable_subfield->{ $fsf }) {
278                            # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
280                    }
281            }
282    
283          return @ds;          if ($#$field >= 0) {
284                    push @m, $field;
285                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
286            }
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  =cut  =cut
298    
299  sub parse {  sub _debug {
300          my $self = shift;          my $l = shift;
301            return $debug unless defined($l);
302          my ($rec, $format_utf8, $i) = @_;          warn "debug level $l" if ($l > 0);
303            $debug = $l;
304          return if (! $format_utf8);  }
   
         my $log = $self->_get_logger();  
   
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
   
         $i = 0 if (! $i);  
305    
306          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head1 Functions to create C<data_structure>
307    
308          my @out;  Those functions generally have to first in your normalization file.
309    
310          $log->debug("format: $format");  =head2 tag
311    
312          my $eval_code;  Define new tag for I<search> and I<display>.
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
313    
314          my $filter_name;    tag('Title', rec('200','a') );
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
315    
         my $prefix;  
         my $all_found=0;  
316    
317          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
318    
319                  my $del = $1 || '';  sub tag {
320                  $prefix ||= $del if ($all_found == 0);          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                  # repeatable index  =head2 display
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
329    
330                  my $found = 0;  Define tag just for I<display>
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
331    
332                  if ($found) {    @v = display('Title', rec('200','a') );
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
333    
334          return if (! $all_found);  =cut
335    
336          my $out = join('',@out);  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          if ($out) {  =head2 search
                 # add rest of format (suffix)  
                 $out .= $format;  
345    
346                  # add prefix if not there  Prepare values just for I<search>
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
347    
348                  $log->debug("result: $out");    @v = search('Title', rec('200','a') );
         }  
349    
350          if ($eval_code) {  =cut
                 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 && $self->{'filter'}->{$filter_name}) {  
                 $log->debug("about to filter{$filter_name} format: $out");  
                 $out = $self->{'filter'}->{$filter_name}->($out);  
                 return unless(defined($out));  
                 $log->debug("filter result: $out");  
         }  
351    
352          return $out;  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  =head2 parse_to_arr  =head2 marc_leader
361    
362  Similar to C<parse>, but returns array of all repeatable fields  Setup fields within MARC leader or get leader
363    
364   my @arr = $webpac->parse_to_arr($rec,'v250^a');    marc_leader('05','c');
365      my $leader = marc_leader();
366    
367  =cut  =cut
368    
369  sub parse_to_arr {  sub marc_leader {
370          my $self = shift;          my ($offset,$value) = @_;
   
         my ($rec, $format_utf8) = @_;  
   
         my $log = $self->_get_logger();  
371    
372          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          if ($offset) {
373          return if (! $format_utf8);                  $out->{' leader'}->{ $offset } = $value;
374            } else {
375          my $i = 0;                  return $out->{' leader'};
         my @arr;  
   
         while (my $v = $self->parse($rec,$format_utf8,$i++)) {  
                 push @arr, $v;  
376          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
377  }  }
378    
379    =head2 marc
380    
381  =head2 fill_in  Save value for MARC field
382    
383  Workhourse of all: takes record from in-memory structure of database and    marc('900','a', rec('200','a') );
 strings with placeholders and returns string or array of with substituted  
 values from record.  
384    
385   my $text = $webpac->fill_in($rec,'v250^a');  =cut
   
 Optional argument is ordinal number for repeatable fields. By default,  
 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.  
386    
387   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  sub marc {
388            my $f = shift or die "marc needs field";
389            die "marc field must be numer" unless ($f =~ /^\d+$/);
390    
391  This function B<does not> perform parsing of format to inteligenty skip          my $sf = shift or die "marc needs subfield";
 delimiters before fields which aren't used.  
392    
393  This method will automatically decode UTF-8 string to local code page          foreach (@_) {
394  if needed.                  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  =cut  =head2 marc_repeatable_subfield
403    
404  sub fill_in {  Save values for MARC repetable subfield
         my $self = shift;  
405    
406          my $log = $self->_get_logger();    marc_repeatable_subfield('910', 'z', rec('909') );
407    
408          my $rec = shift || $log->logconfess("need data record");  =cut
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
409    
410          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  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          # FIXME remove for speedup?  =head2 marc_indicators
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
418    
419          if (utf8::is_utf8($format)) {  Set both indicators for MARC field
                 $format = $self->_x($format);  
         }  
420    
421          my $found = 0;    marc_indicators('900', ' ', 1);
422    
423          my $eval_code;  Any indicator value other than C<0-9> will be treated as undefined.
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
424    
425          my $filter_name;  =cut
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
426    
427          # do actual replacement of placeholders  sub marc_indicators {
428          # repeatable fields          my $f = shift || die "marc_indicators need field!\n";
429          $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;          my ($i1,$i2) = @_;
430          # non-repeatable fields          die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
431          $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;          die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
432    
433          if ($found) {          $i1 = ' ' if ($i1 !~ /^\d$/);
434                  $log->debug("format: $format");          $i2 = ' ' if ($i2 !~ /^\d$/);
435                  if ($eval_code) {          @{ $marc_indicators->{$f} } = ($i1,$i2);
                         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'}) {  
                         return $self->lookup($format);  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
436  }  }
437    
438    =head2 marc_compose
439    
440  =head2 fill_in_to_arr  Save values for each MARC subfield explicitly
441    
442  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    marc_compose('900',
443  for fields which have lookups, so they shouldn't be parsed but rather          'a', rec('200','a')
444  C<fill_id>ed.          'b', rec('201','a')
445            'a', rec('200','b')
446   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');          'c', rec('200','c')
447      );
448    
449  =cut  =cut
450    
451  sub fill_in_to_arr {  sub marc_compose {
452          my $self = shift;          my $f = shift or die "marc_compose needs field";
453            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
454    
455          my ($rec, $format_utf8) = @_;          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
456            my $m = [ $f, $i1, $i2 ];
457    
458          my $log = $self->_get_logger();          while (@_) {
459                    my $sf = shift or die "marc_compose $f needs subfield";
460                    my $v = shift;
461    
462          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  next unless (defined($v) && $v !~ /^\s*$/);
463          return if (! $format_utf8);                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
464                    push @$m, ( $sf, $v );
465          my $i = 0;                  warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ) if ($debug > 1);
         my @arr;  
   
         while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  
                 push @arr, @v;  
466          }          }
467    
468          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "## marc_compose(d) ", dump( $m ) if ($debug > 1);
469    
470          return @arr;          push @{ $marc_record }, $m if ($#{$m} > 2);
471  }  }
472    
473    
474  =head2 get_data  =head1 Functions to extract data from input
475    
476  Returns value from record.  This function should be used inside functions to create C<data_structure> described
477    above.
478    
479   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head2 rec1
480    
481  Arguments are:  Return all values in some field
 record reference C<$rec>,  
 field C<$f>,  
 optional subfiled C<$sf>,  
 index for repeatable values C<$i>.  
482    
483  Optinal variable C<$found> will be incremeted if there    @v = rec1('200')
 is field.  
484    
485  Returns value or empty string.  TODO: order of values is probably same as in source data, need to investigate that
486    
487  =cut  =cut
488    
489  sub get_data {  sub rec1 {
490          my $self = shift;          my $f = shift;
491            return unless (defined($rec) && defined($rec->{$f}));
492          my ($rec,$f,$sf,$i,$found) = @_;          if (ref($rec->{$f}) eq 'ARRAY') {
493                    return map {
494          if ($$rec->{$f}) {                          if (ref($_) eq 'HASH') {
495                  return '' if (! $$rec->{$f}->[$i]);                                  values %{$_};
                 no strict 'refs';  
                 if ($sf && $$rec->{$f}->[$i]->{$sf}) {  
                         $$found++ if (defined($$found));  
                         return $$rec->{$f}->[$i]->{$sf};  
                 } elsif ($$rec->{$f}->[$i]) {  
                         $$found++ if (defined($$found));  
                         # it still might have subfield, just  
                         # not specified, so we'll dump all  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
496                          } else {                          } else {
497                                  return $$rec->{$f}->[$i];                                  $_;
498                          }                          }
499                  }                  } @{ $rec->{$f} };
500          } else {          } elsif( defined($rec->{$f}) ) {
501                  return '';                  return $rec->{$f};
502          }          }
503  }  }
504    
505    =head2 rec2
506    
507  =head2 apply_format  Return all values in specific field and subfield
508    
509  Apply format specified in tag with C<format_name="name"> and    @v = rec2('200','a')
 C<format_delimiter=";;">.  
510    
511   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
512    
513  Formats can contain C<lookup{...}> if you need them.  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  =cut  =head2 rec
521    
522  sub apply_format {  syntaxtic sugar for
         my $self = shift;  
523    
524          my ($name,$delimiter,$data) = @_;    @v = rec('200')
525      @v = rec('200','a')
526    
527          my $log = $self->_get_logger();  =cut
528    
529          if (! $self->{'import_xml'}->{'format'}->{$name}) {  sub rec {
530                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});          if ($#_ == 0) {
531                  return $data;                  return rec1(@_);
532            } elsif ($#_ == 1) {
533                    return rec2(@_);
534          }          }
535    }
536    
537          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 regex
538    
539          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Apply regex to some or all values
540    
541          my @data = split(/\Q$delimiter\E/, $data);    @v = regex( 's/foo/bar/g', @v );
542    
543          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
544    
545          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub regex {
546                  return $self->lookup($out);          my $r = shift;
547          } else {          my @out;
548                  return $out;          #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  =head2 sort_arr  =head2 prefix
558    
559  Sort array ignoring case and html in data  Prefix all values with a string
560    
561   my @sorted = $webpac->sort_arr(@unsorted);    @v = prefix( 'my_', @v );
562    
563  =cut  =cut
564    
565  sub sort_arr {  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 $log = $self->_get_logger();  =head2 suffix
571    
572          # FIXME add Schwartzian Transformation?  suffix all values with a string
573    
574          my @sorted = sort {    @v = suffix( '_my', @v );
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
575    
576          return @sorted;  =cut
 }  
577    
578    sub suffix {
579            my $s = shift or die "suffix needs string as first argument";
580            return map { $_ . $s } grep { defined($_) } @_;
581    }
582    
583  =head1 INTERNAL METHODS  =head2 surround
584    
585  =head2 _sort_by_order  surround all values with a two strings
586    
587  Sort xml tags data structure accoding to C<order=""> attribute.    @v = surround( 'prefix_', '_suffix', @v );
588    
589  =cut  =cut
590    
591  sub _sort_by_order {  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            return map { $p . $_ . $s } grep { defined($_) } @_;
595    }
596    
597    =head2 first
598    
599          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  Return first element
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
600    
601          return $va <=> $vb;    $v = first( @v );
 }  
602    
603  =head2 _x  =cut
604    
605  Convert strings from C<conf/normalize/*.xml> encoding into application  sub first {
606  specific encoding (optinally specified using C<code_page> to C<new>          my $r = shift;
607  constructor).          return $r;
608    }
609    
610   my $text = $n->_x('normalize text string');  =head2 lookup
611    
612  This is a stub so that other modules doesn't have to implement it.  Consult lookup hashes for some value
613    
614      @v = lookup( $v );
615      @v = lookup( @v );
616    
617  =cut  =cut
618    
619  sub _x {  sub lookup {
620          my $self = shift;          my $k = shift or return;
621          return shift;          return unless (defined($lookup->{$k}));
622            if (ref($lookup->{$k}) eq 'ARRAY') {
623                    return @{ $lookup->{$k} };
624            } else {
625                    return $lookup->{$k};
626            }
627  }  }
628    
629    =head2 join_with
630    
631    Joins walues with some delimiter
632    
633      $v = join_with(", ", @v);
634    
635    =cut
636    
637    sub join_with {
638            my $d = shift;
639            return join($d, grep { defined($_) && $_ ne '' } @_);
640    }
641    
642  =head1 AUTHOR  =head2 split_rec_on
643    
644  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  Split record subfield on some regex and take one of parts out
645    
646  =head1 COPYRIGHT & LICENSE    $a_before_semi_column =
647            split_rec_on('200','a', /\s*;\s*/, $part);
648    
649  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  C<$part> is optional number of element. First element is
650    B<1>, not 0!
651    
652  This program is free software; you can redistribute it and/or modify it  If there is no C<$part> parameter or C<$part> is 0, this function will
653  under the same terms as Perl itself.  return all values produced by splitting.
654    
655  =cut  =cut
656    
657  1; # End of WebPAC::DB  sub split_rec_on {
658            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
659    
660            my ($fld, $sf, $regex, $part) = @_;
661            warn "### regex ", ref($regex), $regex if ($debug > 2);
662    
663            my @r = rec( $fld, $sf );
664            my $v = shift @r;
665            warn "### first rec($fld,$sf) = ",dump($v) if ($debug > 2);
666    
667            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    # END
677    1;

Legend:
Removed from v.29  
changed lines
  Added in v.565

  ViewVC Help
Powered by ViewVC 1.1.26