/[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 13 by dpavlin, Sat Jul 16 23:56:14 2005 UTC revision 572 by dpavlin, Mon Jul 3 14:32:40 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 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 - normalisation of source file  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 could be helpful in implementing different  This module uses C<conf/normalize/*.pl> files to perform normalisation
45  normalisation front-ends.  from input records using perl functions which are specialized for set
46    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  =head1 FUNCTIONS  =head1 FUNCTIONS
57    
58  =head2 new  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  Create new normalisation object  =head2 data_structure
62    
63    my $n = new WebPAC::Normalize::Something(  Return data structure
64          cache_data_structure => './cache/ds/',  
65          lookup_regex => $lookup->regex,    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  Optional parameter C<cache_data_structure> defines path to directory  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
73  in which cache file for C<data_structure> call will be created.  other are optional.
74    
75    This function will B<die> if normalizastion can't be evaled.
76    
77  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Since this function isn't exported you have to call it with
78  in structures.  C<WebPAC::Normalize::data_structure>.
79    
80  =cut  =cut
81    
82  sub new {  sub data_structure {
83          my $class = shift;          my $arg = {@_};
         my $self = {@_};  
         bless($self, $class);  
84    
85          $self->setup_cache_dir( $self->{'cache_data_structure'} );          die "need row argument" unless ($arg->{row});
86            die "need normalisation argument" unless ($arg->{rules});
87    
88          $self ? return $self : return undef;          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  =head2 setup_cache_dir          return _get_ds();
96    }
97    
98  Check if specified cache directory exist, and if not, disable caching.  =head2 _set_rec
99    
100   $setup_cache_dir('./cache/ds/');  Set current record hash
101    
102  If you pass false or zero value to this function, it will disable    _set_rec( $rec );
 cacheing.  
103    
104  =cut  =cut
105    
106  sub setup_cache_dir {  my $rec;
         my $self = shift;  
107    
108          my $dir = shift;  sub _set_rec {
109            $rec = shift or die "no record hash";
110    }
111    
112          my $log = $self->_get_logger();  =head2 _get_ds
113    
114          if ($dir) {  Return hash formatted as data structure
                 my $msg;  
                 if (! -e $dir) {  
                         $msg = "doesn't exist";  
                 } elsif (! -d $dir) {  
                         $msg = "is not directory";  
                 } elsif (! -w $dir) {  
                         $msg = "not writable";  
                 }  
115    
116                  if ($msg) {    my $ds = _get_ds();
117                          undef $self->{'cache_data_structure'};  
118                          $log->warn("cache_data_structure $dir $msg, disabling...");  =cut
119                  } else {  
120                          $log->debug("using cache dir $dir");  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
121                  }  
122          } else {  sub _get_ds {
123                  $log->debug("disabling cache");          return $out;
                 undef $self->{'cache_data_structure'};  
         }  
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   my @ds = $webpac->data_structure($rec);  sub _clean_ds {
135            my $a = {@_};
136            ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
137            $marc_encoding = $a->{marc_encoding};
138    }
139    
140    =head2 _set_lookup
141    
142  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 (my $cache_path = $self->{'cache_data_structure'}) {          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
                 my $id = $rec->{'000'};  
                 $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);  
                 unless (defined($id)) {  
                         $log->warn("Can't use cache_data_structure on records without unique identifier in field 000");  
                         undef $self->{'cache_data_structure'};  
                 } else {  
                         $cache_file = "$cache_path/$id";  
                         if (-r $cache_file) {  
                                 my $ds_ref = retrieve($cache_file);  
                                 if ($ds_ref) {  
                                         $log->debug("cache hit: $cache_file");  
                                         my $ok = 1;  
                                         foreach my $f (qw(current_filename headline)) {  
                                                 if ($ds_ref->{$f}) {  
                                                         $self->{$f} = $ds_ref->{$f};  
                                                 } else {  
                                                         $ok = 0;  
                                                 }  
                                         };  
                                         if ($ok && $ds_ref->{'ds'}) {  
                                                 return @{ $ds_ref->{'ds'} };  
                                         } else {  
                                                 $log->warn("cache_data_structure $cache_path corrupt. Use rm $cache_path/* to re-create it on next run!");  
                                                 undef $self->{'cache_data_structure'};  
                                         }  
                                 }  
                         }  
                 }  
         }  
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];
231                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
232                          $row->{'name'} = $name ? $self->_x($name) : $field;                  # field and subfield which is key for
233                    # marc_repeatable_subfield and u
234                          # post-sort all values in field                  my $fsf = $row->[0] . ( $row->[3] || '' );
235                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {  
236                                  $log->warn("sort at field tag not implemented");                  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                          push @ds, $row;                  }
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                          $log->debug("row $field: ",sub { Dumper($row) });                          } 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                    if (! $marc_repeatable_subfield->{ $fsf }) {
278                            # make step to next subfield
279                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
280                    }
281          }          }
282    
283          if ($cache_file) {          if ($#$field >= 0) {
284                  store {                  push @m, $field;
285                          ds => \@ds,                  warn "## saved/3 ", dump( $field ),$/ if ($debug);
                         current_filename => $self->{'current_filename'},  
                         headline => $self->{'headline'},  
                 }, $cache_file;  
                 $log->debug("created storable cache file $cache_file");  
286          }          }
287    
288          return @ds;          return @m;
289    }
290    
291    =head2 _debug
292    
293    Change level of debug warnings
294    
295      _debug( 2 );
296    
297    =cut
298    
299    sub _debug {
300            my $l = shift;
301            return $debug unless defined($l);
302            warn "debug level $l",$/ if ($l > 0);
303            $debug = $l;
304  }  }
305    
306  =head2 apply_format  =head1 Functions to create C<data_structure>
307    
308    Those functions generally have to first in your normalization file.
309    
310  Apply format specified in tag with C<format_name="name"> and  =head2 tag
 C<format_delimiter=";;">.  
311    
312   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  Define new tag for I<search> and I<display>.
313    
314      tag('Title', rec('200','a') );
315    
 Formats can contain C<lookup{...}> if you need them.  
316    
317  =cut  =cut
318    
319  sub apply_format {  sub tag {
320          my $self = shift;          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    =head2 display
329    
330          my ($name,$delimiter,$data) = @_;  Define tag just for I<display>
331    
332          my $log = $self->_get_logger();    @v = display('Title', rec('200','a') );
333    
334          if (! $self->{'import_xml'}->{'format'}->{$name}) {  =cut
335                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
336                  return $data;  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 search
345    
346          $log->warn("no delimiter for format $name") if (! $delimiter);  Prepare values just for I<search>
347    
348          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");    @v = search('Title', rec('200','a') );
349    
350          my @data = split(/\Q$delimiter\E/, $data);  =cut
351    
352    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 marc_leader
361    
362    Setup fields within MARC leader or get leader
363    
364          my $out = sprintf($format, @data);    marc_leader('05','c');
365          $log->debug("using format $name [$format] on $data to produce: $out");    my $leader = marc_leader();
366    
367          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
368                  return $self->lookup($out);  
369    sub marc_leader {
370            my ($offset,$value) = @_;
371    
372            if ($offset) {
373                    $out->{' leader'}->{ $offset } = $value;
374          } else {          } else {
375                  return $out;                  return $out->{' leader'};
376          }          }
   
377  }  }
378    
379  =head2 parse  =head2 marc
380    
381  Perform smart parsing of string, skipping delimiters for fields which aren't  Save value for MARC field
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
382    
383   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    marc('900','a', rec('200','a') );
384      marc('001', rec('000') );
385    
386  =cut  =cut
387    
388  sub parse {  sub marc {
389          my $self = shift;          my $f = shift or die "marc needs field";
390            die "marc field must be numer" unless ($f =~ /^\d+$/);
391    
392          my ($rec, $format_utf8, $i) = @_;          my $sf;
393            if ($f >= 10) {
394                    $sf = shift or die "marc needs subfield";
395            }
396    
397          return if (! $format_utf8);          foreach (@_) {
398                    my $v = $_;             # make var read-write for Encode
399                    next unless (defined($v) && $v !~ /^\s*$/);
400                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
401                    my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
402                    if (defined $sf) {
403                            push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
404                    } else {
405                            push @{ $marc_record }, [ $f, $v ];
406                    }
407            }
408    }
409    
410          my $log = $self->_get_logger();  =head2 marc_repeatable_subfield
411    
412          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Save values for MARC repetable subfield
413    
414          $i = 0 if (! $i);    marc_repeatable_subfield('910', 'z', rec('909') );
415    
416          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =cut
417    
418          my @out;  sub marc_repeatable_subfield {
419            my ($f,$sf) = @_;
420            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
421            $marc_repeatable_subfield->{ $f . $sf }++;
422            marc(@_);
423    }
424    
425          $log->debug("format: $format");  =head2 marc_indicators
426    
427          my $eval_code;  Set both indicators for MARC field
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
428    
429          my $filter_name;    marc_indicators('900', ' ', 1);
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
430    
431          my $prefix;  Any indicator value other than C<0-9> will be treated as undefined.
         my $all_found=0;  
432    
433          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
434    
435                  my $del = $1 || '';  sub marc_indicators {
436                  $prefix ||= $del if ($all_found == 0);          my $f = shift || die "marc_indicators need field!\n";
437            my ($i1,$i2) = @_;
438            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
439            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
440    
441                  # repeatable index          $i1 = ' ' if ($i1 !~ /^\d$/);
442                  my $r = $i;          $i2 = ' ' if ($i2 !~ /^\d$/);
443                  $r = 0 if (lc("$2") eq 's');          @{ $marc_indicators->{$f} } = ($i1,$i2);
444    }
445    
446                  my $found = 0;  =head2 marc_compose
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
447    
448                  if ($found) {  Save values for each MARC subfield explicitly
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
449    
450          return if (! $all_found);    marc_compose('900',
451            'a', rec('200','a')
452            'b', rec('201','a')
453            'a', rec('200','b')
454            'c', rec('200','c')
455      );
456    
457          my $out = join('',@out);  =cut
458    
459          if ($out) {  sub marc_compose {
460                  # add rest of format (suffix)          my $f = shift or die "marc_compose needs field";
461                  $out .= $format;          die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
462    
463                  # add prefix if not there          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
464                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my $m = [ $f, $i1, $i2 ];
465    
466                  $log->debug("result: $out");          while (@_) {
467          }                  my $sf = shift or die "marc_compose $f needs subfield";
468                    my $v = shift;
469    
470          if ($eval_code) {                  next unless (defined($v) && $v !~ /^\s*$/);
471                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
472                  $log->debug("about to eval{$eval} format: $out");                  push @$m, ( $sf, $v );
473                  return if (! $self->_eval($eval));                  warn "## ++ marc_compose($f,$sf,$v) ", dump( $m ),$/ if ($debug > 1);
         }  
           
         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");  
474          }          }
475    
476          return $out;          warn "## marc_compose(d) ", dump( $m ),$/ if ($debug > 1);
 }  
477    
478  =head2 parse_to_arr          push @{ $marc_record }, $m if ($#{$m} > 2);
479    }
480    
 Similar to C<parse>, but returns array of all repeatable fields  
481    
482   my @arr = $webpac->parse_to_arr($rec,'v250^a');  =head1 Functions to extract data from input
483    
484  =cut  This function should be used inside functions to create C<data_structure> described
485    above.
486    
487  sub parse_to_arr {  =head2 rec1
         my $self = shift;  
488    
489          my ($rec, $format_utf8) = @_;  Return all values in some field
490    
491          my $log = $self->_get_logger();    @v = rec1('200')
492    
493          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  TODO: order of values is probably same as in source data, need to investigate that
         return if (! $format_utf8);  
494    
495          my $i = 0;  =cut
         my @arr;  
496    
497          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  sub rec1 {
498                  push @arr, $v;          my $f = shift;
499            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
500            return unless (defined($rec) && defined($rec->{$f}));
501            warn "rec1($f) = ", dump( $rec->{$f} ), $/ if ($debug > 1);
502            if (ref($rec->{$f}) eq 'ARRAY') {
503                    return map {
504                            if (ref($_) eq 'HASH') {
505                                    values %{$_};
506                            } else {
507                                    $_;
508                            }
509                    } @{ $rec->{$f} };
510            } elsif( defined($rec->{$f}) ) {
511                    return $rec->{$f};
512          }          }
513    }
514    
515          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =head2 rec2
516    
517          return @arr;  Return all values in specific field and subfield
518    
519      @v = rec2('200','a')
520    
521    =cut
522    
523    sub rec2 {
524            my $f = shift;
525            return unless (defined($rec && $rec->{$f}));
526            my $sf = shift;
527            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
528  }  }
529    
530  =head2 fill_in_to_arr  =head2 rec
531    
532  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  syntaxtic sugar for
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
533    
534   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = rec('200')
535      @v = rec('200','a')
536    
537  =cut  =cut
538    
539  sub fill_in_to_arr {  sub rec {
540          my $self = shift;          if ($#_ == 0) {
541                    return rec1(@_);
542            } elsif ($#_ == 1) {
543                    return rec2(@_);
544            }
545    }
546    
547          my ($rec, $format_utf8) = @_;  =head2 regex
548    
549          my $log = $self->_get_logger();  Apply regex to some or all values
550    
551          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = regex( 's/foo/bar/g', @v );
         return if (! $format_utf8);  
552    
553          my $i = 0;  =cut
         my @arr;  
554    
555          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub regex {
556                  push @arr, @v;          my $r = shift;
557            my @out;
558            #warn "r: $r\n", dump(\@_);
559            foreach my $t (@_) {
560                    next unless ($t);
561                    eval "\$t =~ $r";
562                    push @out, $t if ($t && $t ne '');
563          }          }
564            return @out;
565    }
566    
567    =head2 prefix
568    
569    Prefix all values with a string
570    
571      @v = prefix( 'my_', @v );
572    
573          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =cut
574    
575          return @arr;  sub prefix {
576            my $p = shift or die "prefix needs string as first argument";
577            return map { $p . $_ } grep { defined($_) } @_;
578  }  }
579    
580  =head2 sort_arr  =head2 suffix
581    
582  Sort array ignoring case and html in data  suffix all values with a string
583    
584   my @sorted = $webpac->sort_arr(@unsorted);    @v = suffix( '_my', @v );
585    
586  =cut  =cut
587    
588  sub sort_arr {  sub suffix {
589          my $self = shift;          my $s = shift or die "suffix needs string as first argument";
590            return map { $_ . $s } grep { defined($_) } @_;
591    }
592    
593    =head2 surround
594    
595          my $log = $self->_get_logger();  surround all values with a two strings
596    
597          # FIXME add Schwartzian Transformation?    @v = surround( 'prefix_', '_suffix', @v );
598    
599          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
600    
601          return @sorted;  sub surround {
602            my $p = shift or die "surround need prefix as first argument";
603            my $s = shift or die "surround needs suffix as second argument";
604            return map { $p . $_ . $s } grep { defined($_) } @_;
605  }  }
606    
607    =head2 first
608    
609  =head2 _sort_by_order  Return first element
610    
611  Sort xml tags data structure accoding to C<order=""> attribute.    $v = first( @v );
612    
613  =cut  =cut
614    
615  sub _sort_by_order {  sub first {
616          my $self = shift;          my $r = shift;
617            return $r;
618    }
619    
620          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  =head2 lookup
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
621    
622          return $va <=> $vb;  Consult lookup hashes for some value
 }  
623    
624  =head2 _x    @v = lookup( $v );
625      @v = lookup( @v );
626    
627  Convert strings from C<conf/normalize> encoding into application specific  =cut
 (optinally specified using C<code_page> to C<new> constructor.  
628    
629   my $text = $n->_x('normalize text string');  sub lookup {
630            my $k = shift or return;
631            return unless (defined($lookup->{$k}));
632            if (ref($lookup->{$k}) eq 'ARRAY') {
633                    return @{ $lookup->{$k} };
634            } else {
635                    return $lookup->{$k};
636            }
637    }
638    
639    =head2 join_with
640    
641  This is a stub so that other modules doesn't have to implement it.  Joins walues with some delimiter
642    
643      $v = join_with(", ", @v);
644    
645  =cut  =cut
646    
647  sub _x {  sub join_with {
648          my $self = shift;          my $d = shift;
649          return shift;          return join($d, grep { defined($_) && $_ ne '' } @_);
650  }  }
651    
652    =head2 split_rec_on
653    
654  =head1 AUTHOR  Split record subfield on some regex and take one of parts out
   
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
655    
656  =head1 COPYRIGHT & LICENSE    $a_before_semi_column =
657            split_rec_on('200','a', /\s*;\s*/, $part);
658    
659  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  C<$part> is optional number of element. First element is
660    B<1>, not 0!
661    
662  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
663  under the same terms as Perl itself.  return all values produced by splitting.
664    
665  =cut  =cut
666    
667  1; # End of WebPAC::DB  sub split_rec_on {
668            die "split_rec_on need (fld,sf,regex[,part]" if ($#_ < 2);
669    
670            my ($fld, $sf, $regex, $part) = @_;
671            warn "### regex ", ref($regex), $regex, $/ if ($debug > 2);
672    
673            my @r = rec( $fld, $sf );
674            my $v = shift @r;
675            warn "### first rec($fld,$sf) = ",dump($v),$/ if ($debug > 2);
676    
677            return '' if( ! defined($v) || $v =~ /^\s*$/);
678    
679            my @s = split( $regex, $v );
680            warn "## split_rec_on($fld,$sf,$regex,$part) = ",dump(@s),$/ if ($debug > 1);
681            if ($part && $part > 0) {
682                    return $s[ $part - 1 ];
683            } else {
684                    return @s;
685            }
686    }
687    
688    # END
689    1;

Legend:
Removed from v.13  
changed lines
  Added in v.572

  ViewVC Help
Powered by ViewVC 1.1.26