/[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 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 - normalisation of source file  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 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    Return data structure
64    
65    my $n = new WebPAC::Normalize::Something(    my $ds = WebPAC::Normalize::data_structure(
66          cache_data_structure => './cache/ds/',          lookup => $lookup->lookup_hash,
67          lookup_regex => $lookup->regex,          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  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  This function will B<die> if normalizastion can't be evaled.
76  in structures.  
77    Since this function isn't exported you have to call it with
78    C<WebPAC::Normalize::data_structure>.
79    
80  =cut  =cut
81    
82  sub new {  sub data_structure {
83          my $class = shift;          my $arg = {@_};
84          my $self = {@_};  
85          bless($self, $class);          die "need row argument" unless ($arg->{row});
86            die "need normalisation argument" unless ($arg->{rules});
87    
88          $self->setup_cache_dir( $self->{'cache_data_structure'} );          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          $self ? return $self : return undef;          return _get_ds();
96  }  }
97    
98  =head2 setup_cache_dir  =head2 _set_rec
   
 Check if specified cache directory exist, and if not, disable caching.  
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();
131  C<conf/normalize/*.xml>.  
132    =cut
133    
134  This structures are used to produce output.  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 (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;
203    
204                          foreach my $type (@types) {          # count unique field-subfields (used for offset when walking to next subfield)
205                                  # append to previous line?          my $u;
206                                  $log->debug("type: $type ",sub { join(" ",@v) }, $row->{'append'} || 'no append');          map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
207                                  if ($tag->{'append'}) {  
208            if ($debug) {
209                                          # I will delimit appended part with                  warn "## marc_repeatable_subfield ", dump( $marc_repeatable_subfield ), $/;
210                                          # delimiter (or ,)                  warn "## marc_record ", dump( $marc_record ), $/;
211                                          my $d = $tag->{'delimiter'};                  warn "## sorted_marc_record ", dump( \@sorted_marc_record ), $/;
212                                          # default delimiter                  warn "## subfield count ", dump( $u ), $/;
213                                          $d ||= " ";          }
   
                                         my $last = pop @{$row->{$type}};  
                                         $d = "" if (! $last);  
                                         $last .= $d . join($d, @v);  
                                         push @{$row->{$type}}, $last;  
   
                                 } else {  
                                         push @{$row->{$type}}, @v;  
                                 }  
                         }  
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                            } 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  Apply format specified in tag with C<format_name="name"> and  Those functions generally have to first in your normalization file.
 C<format_delimiter=";;">.  
309    
310   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =head2 tag
311    
312    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
                 $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
                 return $data;  
         }  
335    
336          $log->warn("no delimiter for format $name") if (! $delimiter);  sub display {
337            my $name = shift or die "display needs name as first argument";
338            my @o = grep { defined($_) && $_ ne '' } @_;
339            return unless (@o);
340            $out->{$name}->{tag} = $name;
341            $out->{$name}->{display} = \@o;
342    }
343    
344          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =head2 search
345    
346          my @data = split(/\Q$delimiter\E/, $data);  Prepare values just for I<search>
347    
348          my $out = sprintf($format, @data);    @v = search('Title', rec('200','a') );
         $log->debug("using format $name [$format] on $data to produce: $out");  
349    
350          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
                 return $self->lookup($out);  
         } else {  
                 return $out;  
         }  
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 parse  =head2 marc
361    
362  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.  
363    
364   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);    marc('900','a', rec('200','a') );
365    
366  =cut  =cut
367    
368  sub parse {  sub marc {
369          my $self = shift;          my $f = shift or die "marc needs field";
370            die "marc field must be numer" unless ($f =~ /^\d+$/);
371    
372          my ($rec, $format_utf8, $i) = @_;          my $sf = shift or die "marc needs subfield";
373    
374          return if (! $format_utf8);          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          my $log = $self->_get_logger();  =head2 marc_repeatable_subfield
384    
385          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Save values for MARC repetable subfield
386    
387          $i = 0 if (! $i);    marc_repeatable_subfield('910', 'z', rec('909') );
388    
389          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  =cut
390    
391          my @out;  sub marc_repeatable_subfield {
392            my ($f,$sf) = @_;
393            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
394            $marc_repeatable_subfield->{ $f . $sf }++;
395            marc(@_);
396    }
397    
398          $log->debug("format: $format");  =head2 marc_indicators
399    
400          my $eval_code;  Set both indicators for MARC field
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
401    
402          my $filter_name;    marc_indicators('900', ' ', 1);
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
403    
404          my $prefix;  Any indicator value other than C<0-9> will be treated as undefined.
         my $all_found=0;  
405    
406          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  =cut
407    
408                  my $del = $1 || '';  sub marc_indicators {
409                  $prefix ||= $del if ($all_found == 0);          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                  # repeatable index          $i1 = ' ' if ($i1 !~ /^\d$/);
415                  my $r = $i;          $i2 = ' ' if ($i2 !~ /^\d$/);
416                  $r = 0 if (lc("$2") eq 's');          @{ $marc_indicators->{$f} } = ($i1,$i2);
417    }
418    
419                  my $found = 0;  =head2 marc_compose
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);  
420    
421                  if ($found) {  Save values for each MARC subfield explicitly
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
                 }  
         }  
422    
423          return if (! $all_found);    marc_compose('900',
424            'a', rec('200','a')
425            'b', rec('201','a')
426            'a', rec('200','b')
427            'c', rec('200','c')
428      );
429    
430          my $out = join('',@out);  =cut
431    
432          if ($out) {  sub marc_compose {
433                  # add rest of format (suffix)          my $f = shift or die "marc_compose needs field";
434                  $out .= $format;          die "marc_compose field must be numer" unless ($f =~ /^\d+$/);
435    
436                  # add prefix if not there          my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
437                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my $m = [ $f, $i1, $i2 ];
438    
439                  $log->debug("result: $out");          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          if ($eval_code) {                  next unless (defined($v) && $v !~ /^\s*$/);
444                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
445                  $log->debug("about to eval{$eval} format: $out");                  push @$m, ( $sf, $v );
446                  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");  
447          }          }
448    
449          return $out;          warn "## marc_compose(d) ", dump( $m ) if ($debug > 1);
 }  
450    
451  =head2 parse_to_arr          push @{ $marc_record }, $m;
452    }
453    
 Similar to C<parse>, but returns array of all repeatable fields  
454    
455   my @arr = $webpac->parse_to_arr($rec,'v250^a');  =head1 Functions to extract data from input
456    
457  =cut  This function should be used inside functions to create C<data_structure> described
458    above.
459    
460  sub parse_to_arr {  =head2 rec1
         my $self = shift;  
461    
462          my ($rec, $format_utf8) = @_;  Return all values in some field
463    
464          my $log = $self->_get_logger();    @v = rec1('200')
465    
466          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  TODO: order of values is probably same as in source data, need to investigate that
         return if (! $format_utf8);  
467    
468          my $i = 0;  =cut
         my @arr;  
469    
470          while (my $v = $self->parse($rec,$format_utf8,$i++)) {  sub rec1 {
471                  push @arr, $v;          my $f = shift;
472            return unless (defined($rec) && defined($rec->{$f}));
473            if (ref($rec->{$f}) eq 'ARRAY') {
474                    return map {
475                            if (ref($_) eq 'HASH') {
476                                    values %{$_};
477                            } else {
478                                    $_;
479                            }
480                    } @{ $rec->{$f} };
481            } elsif( defined($rec->{$f}) ) {
482                    return $rec->{$f};
483          }          }
484    }
485    
486    =head2 rec2
487    
488    Return all values in specific field and subfield
489    
490          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);    @v = rec2('200','a')
491    
492          return @arr;  =cut
493    
494    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  =head2 fill_in_to_arr  =head2 rec
502    
503  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.  
504    
505   my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');    @v = rec('200')
506      @v = rec('200','a')
507    
508  =cut  =cut
509    
510  sub fill_in_to_arr {  sub rec {
511          my $self = shift;          if ($#_ == 0) {
512                    return rec1(@_);
513            } elsif ($#_ == 1) {
514                    return rec2(@_);
515            }
516    }
517    
518          my ($rec, $format_utf8) = @_;  =head2 regex
519    
520          my $log = $self->_get_logger();  Apply regex to some or all values
521    
522          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    @v = regex( 's/foo/bar/g', @v );
         return if (! $format_utf8);  
523    
524          my $i = 0;  =cut
         my @arr;  
525    
526          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  sub regex {
527                  push @arr, @v;          my $r = shift;
528            my @out;
529            #warn "r: $r\n", dump(\@_);
530            foreach my $t (@_) {
531                    next unless ($t);
532                    eval "\$t =~ $r";
533                    push @out, $t if ($t && $t ne '');
534          }          }
535            return @out;
536    }
537    
538          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  =head2 prefix
539    
540          return @arr;  Prefix all values with a string
541    
542      @v = prefix( 'my_', @v );
543    
544    =cut
545    
546    sub prefix {
547            my $p = shift or die "prefix needs string as first argument";
548            return map { $p . $_ } grep { defined($_) } @_;
549  }  }
550    
551  =head2 sort_arr  =head2 suffix
552    
553  Sort array ignoring case and html in data  suffix all values with a string
554    
555   my @sorted = $webpac->sort_arr(@unsorted);    @v = suffix( '_my', @v );
556    
557  =cut  =cut
558    
559  sub sort_arr {  sub suffix {
560          my $self = shift;          my $s = shift or die "suffix needs string as first argument";
561            return map { $_ . $s } grep { defined($_) } @_;
562    }
563    
564    =head2 surround
565    
566          my $log = $self->_get_logger();  surround all values with a two strings
567    
568          # FIXME add Schwartzian Transformation?    @v = surround( 'prefix_', '_suffix', @v );
569    
570          my @sorted = sort {  =cut
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
571    
572          return @sorted;  sub surround {
573            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  =head2 _sort_by_order  Return first element
581    
582  Sort xml tags data structure accoding to C<order=""> attribute.    $v = first( @v );
583    
584  =cut  =cut
585    
586  sub _sort_by_order {  sub first {
587          my $self = shift;          my $r = shift;
588            return $r;
589    }
590    
591          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};  
592    
593          return $va <=> $vb;  Consult lookup hashes for some value
594  }  
595      @v = lookup( $v );
596      @v = lookup( @v );
597    
598    =cut
599    
600  =head2 _x  sub lookup {
601            my $k = shift or return;
602            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  Convert strings from C<conf/normalize> encoding into application specific  =head2 join_with
 (optinally specified using C<code_page> to C<new> constructor.  
611    
612   my $text = $n->_x('normalize text string');  Joins walues with some delimiter
613    
614  This is a stub so that other modules doesn't have to implement it.    $v = join_with(", ", @v);
615    
616  =cut  =cut
617    
618  sub _x {  sub join_with {
619          my $self = shift;          my $d = shift;
620          return shift;          return join($d, grep { defined($_) && $_ ne '' } @_);
621  }  }
622    
623    =head2 split_rec_on
624    
625  =head1 AUTHOR  Split record subfield on some regex and take one of parts out
   
 Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>  
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.13  
changed lines
  Added in v.562

  ViewVC Help
Powered by ViewVC 1.1.26