/[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 18 by dpavlin, Sun Jul 17 14:53:37 2005 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 Data::Dumper;  
22    #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.08
37    
38  =cut  =cut
39    
40  our $VERSION = '0.01';  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    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 => $webpac_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
   
 Create in-memory data structure which represents normalized layout from  
 C<conf/normalize/*.xml>.  
   
 This structures are used to produce output.  
129    
130   my @ds = $webpac->data_structure($rec);    _clean_ds();
   
 B<Note: historical oddity follows>  
   
 This method will also set C<< $webpac->{'currnet_filename'} >> if there is  
 C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
 C<< <headline> >> tag.  
131    
132  =cut  =cut
133    
134  sub data_structure {  sub _clean_ds {
135          my $self = shift;          my $a = {@_};
136            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
137          my $log = $self->_get_logger();          $marc_encoding = $a->{marc_encoding};
138    }
139    
140          my $rec = shift;  =head2 _set_lookup
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
141    
142          my $cache_file;  Set current lookup hash
143    
144          if ($self->{'db'}) {    _set_lookup( $lookup );
                 my @ds = $self->{'db'}->get_ds($rec);  
                 return @ds if (@ds);  
         }  
145    
146          undef $self->{'currnet_filename'};  =cut
         undef $self->{'headline'};  
147    
148          my @sorted_tags;  my $lookup;
         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;  
         }  
149    
150          my @ds;  sub _set_lookup {
151            $lookup = shift;
152    }
153    
154          $log->debug("tags: ",sub { join(", ",@sorted_tags) });  =head2 _get_marc_fields
155    
156          foreach my $field (@sorted_tags) {  Get all fields defined by calls to C<marc>
157    
158                  my $row;          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
159    
160  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  We are using I<magic> which detect repeatable fields only from
161    sequence of field/subfield data generated by normalization.
162    
163                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  Repeatable field is created when there is second occurence of same subfield or
164                          my $format = $tag->{'value'} || $tag->{'content'};  if any of indicators are different.
165    
166                          $log->debug("format: $format");  This is sane for most cases. Something like:
167    
168                          my @v;    900a-1 900b-1 900c-1
169                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {    900a-2 900b-2
170                                  @v = $self->fill_in_to_arr($rec,$format);    900a-3
                         } else {  
                                 @v = $self->parse_to_arr($rec,$format);  
                         }  
                         next if (! @v);  
171    
172                          if ($tag->{'sort'}) {  will be created from any combination of:
                                 @v = $self->sort_arr(@v);  
                         }  
173    
174                          # use format?    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
175    
176                          if ($field eq 'filename') {  and following rules:
                                 $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!  
                         }  
177    
178                          # delimiter will join repeatable fields    marc('900','a', rec('200','a') );
179                          if ($tag->{'delimiter'}) {    marc('900','b', rec('200','b') );
180                                  @v = ( join($tag->{'delimiter'}, @v) );    marc('900','c', rec('200','c') );
                         }  
181    
182                          # default types  which might not be what you have in mind. If you need repeatable subfield,
183                          my @types = qw(display swish);  define it using C<marc_repeatable_subfield> like this:
                         # override by type attribute  
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("type: $type ",sub { join(" ",@v) }, $row->{'append'} || 'no append');  
                                 if ($tag->{'append'}) {  
   
                                         # I will delimit appended part with  
                                         # delimiter (or ,)  
                                         my $d = $tag->{'delimiter'};  
                                         # default delimiter  
                                         $d ||= " ";  
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
   
                                 } else {  
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
184    
185    ....
186    
187                  }  =cut
188    
189                  if ($row) {  sub _get_marc_fields {
                         $row->{'tag'} = $field;  
190    
191                          # TODO: name_sigular, name_plural          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
                         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");  
                         }  
192    
193                          push @ds, $row;          # 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                          $log->debug("row $field: ",sub { Dumper($row) });          @sorted_marc_record = @{ $marc_record };        ### FIXME disable sorting
200                  }          
201            # output marc fields
202            my @m;
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          $self->{'db'}->put_gs(          my $len = $#sorted_marc_record;
216                  ds => \@ds,          my $visited;
217                  current_filename => $self->{'current_filename'},          my $i = 0;
218                  headline => $self->{'headline'},          my $field;
         ) if ($self->{'db'});  
   
         return @ds;  
219    
220  }          foreach ( 0 .. $len ) {
221    
222  =head2 parse                  # find next element which isn't visited
223                    while ($visited->{$i}) {
224                            $i = ($i + 1) % ($len + 1);
225                    }
226    
227  Perform smart parsing of string, skipping delimiters for fields which aren't                  # mark it visited
228  defined. It can also eval code in format starting with C<eval{...}> and                  $visited->{$i}++;
 return output or nothing depending on eval code.  
229    
230   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);                  my $row = $sorted_marc_record[$i];
231    
232  =cut                  # 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  sub parse {                  }
         my $self = shift;  
245    
246          my ($rec, $format_utf8, $i) = @_;                  # 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          return if (! $format_utf8);                          } else {
269                                    # append new subfields to existing field
270                                    push @$field, ( $row->[3], $row->[4] );
271                            }
272                    } else {
273                            # insert first field
274                            $field = $row;
275                    }
276    
277          my $log = $self->_get_logger();                  if (! $marc_repeatable_subfield->{ $fsf }) {
278                            # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
280                    }
281            }
282    
283          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          if ($#$field >= 0) {
284                    push @m, $field;
285                    warn "## saved/3 ", dump( $field ),$/ if ($debug);
286            }
287    
288          $i = 0 if (! $i);          return @m;
289    }
290    
291          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =head2 _debug
292    
293          my @out;  Change level of debug warnings
294    
295          $log->debug("format: $format");    _debug( 2 );
296    
297          my $eval_code;  =cut
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
298    
299          my $filter_name;  sub _debug {
300          # remove filter{...} from beginning          my $l = shift;
301          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);          return $debug unless defined($l);
302            warn "debug level $l" if ($l > 0);
303            $debug = $l;
304    }
305    
306          my $prefix;  =head1 Functions to create C<data_structure>
         my $all_found=0;  
307    
308          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  Those functions generally have to first in your normalization file.
309    
310                  my $del = $1 || '';  =head2 tag
                 $prefix ||= $del if ($all_found == 0);  
311    
312                  # repeatable index  Define new tag for I<search> and I<display>.
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
313    
314                  my $found = 0;    tag('Title', rec('200','a') );
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
315    
                 if ($found) {  
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
316    
317          return if (! $all_found);  =cut
318    
319          my $out = join('',@out);  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          if ($out) {  =head2 display
                 # add rest of format (suffix)  
                 $out .= $format;  
329    
330                  # add prefix if not there  Define tag just for I<display>
                 $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);  
331    
332                  $log->debug("result: $out");    @v = display('Title', rec('200','a') );
         }  
333    
334          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");  
         }  
335    
336          return $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  =head2 parse_to_arr  =head2 search
345    
346  Similar to C<parse>, but returns array of all repeatable fields  Prepare values just for I<search>
347    
348   my @arr = $webpac->parse_to_arr($rec,'v250^a');    @v = search('Title', rec('200','a') );
349    
350  =cut  =cut
351    
352  sub parse_to_arr {  sub search {
353          my $self = shift;          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 ($rec, $format_utf8) = @_;  =head2 marc
361    
362          my $log = $self->_get_logger();  Save value for MARC field
363    
364          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc('900','a', rec('200','a') );
         return if (! $format_utf8);  
365    
366          my $i = 0;  =cut
         my @arr;  
367    
368          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  sub marc {
369                  push @arr, $v;          my $f = shift or die "marc needs field";
370          }          die "marc field must be numer" unless ($f =~ /^\d+$/);
371    
372          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          my $sf = shift or die "marc needs subfield";
373    
374          return @arr;          foreach (@_) {
375                    my $v = $_;             # make var read-write for Encode
376                    next unless (defined($v) && $v !~ /^\s*$/);
377                    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            }
381  }  }
382    
383    =head2 marc_repeatable_subfield
384    
385  =head2 fill_in  Save values for MARC repetable subfield
386    
387  Workhourse of all: takes record from in-memory structure of database and    marc_repeatable_subfield('910', 'z', rec('909') );
 strings with placeholders and returns string or array of with substituted  
 values from record.  
   
  my $text = $webpac->fill_in($rec,'v250^a');  
   
 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.  
   
  my $text = $webpac->fill_in($rec,'Title: v250^a',1);  
   
 This function B<does not> perform parsing of format to inteligenty skip  
 delimiters before fields which aren't used.  
   
 This method will automatically decode UTF-8 string to local code page  
 if needed.  
388    
389  =cut  =cut
390    
391  sub fill_in {  sub marc_repeatable_subfield {
392          my $self = shift;          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          my $log = $self->_get_logger();  =head2 marc_indicators
399    
400          my $rec = shift || $log->logconfess("need data record");  Set both indicators for MARC field
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
401    
402          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));    marc_indicators('900', ' ', 1);
403    
404          # FIXME remove for speedup?  Any indicator value other than C<0-9> will be treated as undefined.
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
405    
406          if (utf8::is_utf8($format)) {  =cut
                 $format = $self->_x($format);  
         }  
407    
408          my $found = 0;  sub marc_indicators {
409            my $f = shift || die "marc_indicators need field!\n";
410            my ($i1,$i2) = @_;
411            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 $eval_code;          $i1 = ' ' if ($i1 !~ /^\d$/);
415          # remove eval{...} from beginning          $i2 = ' ' if ($i2 !~ /^\d$/);
416          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);          @{ $marc_indicators->{$f} } = ($i1,$i2);
   
         my $filter_name;  
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
   
         # do actual replacement of placeholders  
         # repeatable fields  
         $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;  
         # non-repeatable fields  
         $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;  
   
         if ($found) {  
                 $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'}) {  
                         return $self->lookup($format);  
                 } else {  
                         return $format;  
                 }  
         } else {  
                 return;  
         }  
417  }  }
418    
419    =head2 marc_compose
420    
421  =head2 fill_in_to_arr  Save values for each MARC subfield explicitly
422    
423  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    marc_compose('900',
424  for fields which have lookups, so they shouldn't be parsed but rather          'a', rec('200','a')
425  C<fill_id>ed.          'b', rec('201','a')
426            'a', rec('200','b')
427   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');          'c', rec('200','c')
428      );
429    
430  =cut  =cut
431    
432  sub fill_in_to_arr {  sub marc_compose {
433          my $self = shift;          my $f = shift or die "marc_compose needs field";
434            die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
435    
436          my ($rec, $format_utf8) = @_;          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
437            my $m = [ $f, $i1, $i2 ];
438    
439          my $log = $self->_get_logger();          while (@_) {
440                    my $sf = shift or die "marc_compose $f needs subfield";
441                    my $v = shift or die "marc_compose $f needs value for subfield $sf";
442    
443          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);                  next unless (defined($v) && $v !~ /^\s*$/);
444          return if (! $format_utf8);                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
445                    push @$m, ( $sf, $v );
446          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;  
447          }          }
448    
449          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);          warn "## marc_compose(d) ", dump( $m ) if ($debug > 1);
450    
451          return @arr;          push @{ $marc_record }, $m;
452  }  }
453    
454    
455  =head2 get_data  =head1 Functions to extract data from input
456    
457  Returns value from record.  This function should be used inside functions to create C<data_structure> described
458    above.
459    
460   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head2 rec1
461    
462  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>.  
463    
464  Optinal variable C<$found> will be incremeted if there    @v = rec1('200')
 is field.  
465    
466  Returns value or empty string.  TODO: order of values is probably same as in source data, need to investigate that
467    
468  =cut  =cut
469    
470  sub get_data {  sub rec1 {
471          my $self = shift;          my $f = shift;
472            return unless (defined($rec) && defined($rec->{$f}));
473          my ($rec,$f,$sf,$i,$found) = @_;          if (ref($rec->{$f}) eq 'ARRAY') {
474                    return map {
475          if ($$rec->{$f}) {                          if (ref($_) eq 'HASH') {
476                  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;  
477                          } else {                          } else {
478                                  return $$rec->{$f}->[$i];                                  $_;
479                          }                          }
480                  }                  } @{ $rec->{$f} };
481          } else {          } elsif( defined($rec->{$f}) ) {
482                  return '';                  return $rec->{$f};
483          }          }
484  }  }
485    
486    =head2 rec2
487    
488  =head2 apply_format  Return all values in specific field and subfield
489    
490  Apply format specified in tag with C<format_name="name"> and    @v = rec2('200','a')
 C<format_delimiter=";;">.  
491    
492   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
493    
494  Formats can contain C<lookup{...}> if you need them.  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  =cut  =head2 rec
502    
503  sub apply_format {  syntaxtic sugar for
         my $self = shift;  
504    
505          my ($name,$delimiter,$data) = @_;    @v = rec('200')
506      @v = rec('200','a')
507    
508          my $log = $self->_get_logger();  =cut
509    
510          if (! $self->{'import_xml'}->{'format'}->{$name}) {  sub rec {
511                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});          if ($#_ == 0) {
512                  return $data;                  return rec1(@_);
513            } elsif ($#_ == 1) {
514                    return rec2(@_);
515          }          }
516    }
517    
518          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 regex
519    
520          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Apply regex to some or all values
521    
522          my @data = split(/\Q$delimiter\E/, $data);    @v = regex( 's/foo/bar/g', @v );
523    
524          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
525    
526          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub regex {
527                  return $self->lookup($out);          my $r = shift;
528          } else {          my @out;
529                  return $out;          #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  =head2 sort_arr  =head2 prefix
539    
540  Sort array ignoring case and html in data  Prefix all values with a string
541    
542   my @sorted = $webpac->sort_arr(@unsorted);    @v = prefix( 'my_', @v );
543    
544  =cut  =cut
545    
546  sub sort_arr {  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 $log = $self->_get_logger();  =head2 suffix
552    
553          # FIXME add Schwartzian Transformation?  suffix all values with a string
554    
555          my @sorted = sort {    @v = suffix( '_my', @v );
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
556    
557          return @sorted;  =cut
 }  
558    
559    sub suffix {
560            my $s = shift or die "suffix needs string as first argument";
561            return map { $_ . $s } grep { defined($_) } @_;
562    }
563    
564  =head1 INTERNAL METHODS  =head2 surround
565    
566  =head2 _sort_by_order  surround all values with a two strings
567    
568  Sort xml tags data structure accoding to C<order=""> attribute.    @v = surround( 'prefix_', '_suffix', @v );
569    
570  =cut  =cut
571    
572  sub _sort_by_order {  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            return map { $p . $_ . $s } grep { defined($_) } @_;
576    }
577    
578    =head2 first
579    
580          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};  
581    
582          return $va <=> $vb;    $v = first( @v );
 }  
583    
584  =head2 _x  =cut
585    
586  Convert strings from C<conf/normalize/*.xml> encoding into application  sub first {
587  specific encoding (optinally specified using C<code_page> to C<new>          my $r = shift;
588  constructor).          return $r;
589    }
590    
591   my $text = $n->_x('normalize text string');  =head2 lookup
592    
593  This is a stub so that other modules doesn't have to implement it.  Consult lookup hashes for some value
594    
595      @v = lookup( $v );
596      @v = lookup( @v );
597    
598  =cut  =cut
599    
600  sub _x {  sub lookup {
601          my $self = shift;          my $k = shift or return;
602          return shift;          return unless (defined($lookup->{$k}));
603            if (ref($lookup->{$k}) eq 'ARRAY') {
604                    return @{ $lookup->{$k} };
605            } else {
606                    return $lookup->{$k};
607            }
608  }  }
609    
610    =head2 join_with
611    
612    Joins walues with some delimiter
613    
614      $v = join_with(", ", @v);
615    
616    =cut
617    
618    sub join_with {
619            my $d = shift;
620            return join($d, grep { defined($_) && $_ ne '' } @_);
621    }
622    
623  =head1 AUTHOR  =head2 split_rec_on
624    
625  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  Split record subfield on some regex and take one of parts out
626    
627  =head1 COPYRIGHT & LICENSE    $a_before_semi_column =
628            split_rec_on('200','a', /\s*;\s*/, $part);
629    
630  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  C<$part> is optional number of element. First element is
631    B<1>, not 0!
632    
633  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
634  under the same terms as Perl itself.  return all values produced by splitting.
635    
636  =cut  =cut
637    
638  1; # End of WebPAC::DB  sub split_rec_on {
639            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
640    
641            my ($fld, $sf, $regex, $part) = @_;
642            warn "### regex ", ref($regex), $regex if ($debug > 2);
643    
644            my @r = rec( $fld, $sf );
645            my $v = shift @r;
646            warn "### first rec($fld,$sf) = ",dump($v) if ($debug > 2);
647    
648            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    # END
658    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26