/[webpac2]/trunk/lib/WebPAC/Normalize.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/WebPAC/Normalize.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 29 by dpavlin, Sun Jul 24 11:17:44 2005 UTC revision 554 by dpavlin, Sat Jul 1 10:19:29 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    
11            rec1 rec2 rec
12            regex prefix suffix surround
13            first lookup join_with
14    /;
15    
16  use warnings;  use warnings;
17  use strict;  use strict;
18  use base 'WebPAC::Common';  
19  use Data::Dumper;  #use base qw/WebPAC::Common/;
20    use Data::Dump qw/dump/;
21    use Encode qw/from_to/;
22    
23    # debugging warn(s)
24    my $debug = 0;
25    
26    
27  =head1 NAME  =head1 NAME
28    
29  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
30    
31  =head1 VERSION  =head1 VERSION
32    
33  Version 0.01  Version 0.07
34    
35  =cut  =cut
36    
37  our $VERSION = '0.01';  our $VERSION = '0.07';
38    
39  =head1 SYNOPSIS  =head1 SYNOPSIS
40    
41  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
42    from input records using perl functions which are specialized for set
43  It contains several assumptions:  processing.
44    
45  =over  Sets are implemented as arrays, and normalisation file is valid perl, which
46    means that you check it's validity before running WebPAC using
47  =item *  C<perl -c normalize.pl>.
48    
49  format of fields is defined using C<v123^a> notation for repeatable fields  Normalisation can generate multiple output normalized data. For now, supported output
50  or C<s123^a> for single (or first) value, where C<123> is field number and  types (on the left side of definition) are: C<tag>, C<display>, C<search> and
51  C<a> is subfield.  C<marc>.
   
 =item *  
52    
53  source data records (C<$rec>) have unique identifiers in field C<000>  =head1 FUNCTIONS
   
 =item *  
   
 optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be  
 perl code that is evaluated before producing output (value of field will be  
 interpolated before that)  
   
 =item *  
   
 optional C<filter{filter_name}> at B<begining of format> will apply perl  
 code defined as code ref on format after field substitution to producing  
 output  
54    
55  =item *  Functions which start with C<_> are private and used by WebPAC internally.
56    All other functions are available for use within normalisation rules.
57    
58  optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  =head2 data_structure
59    
60  =item *  Return data structure
61    
62  at end, optional C<format>s rules are resolved. Format rules are similar to    my $ds = WebPAC::Normalize::data_structure(
63  C<sprintf> and can also contain C<lookup{...}> which is performed after          lookup => $lookup->lookup_hash,
64  values are inserted in format.          row => $row,
65            rules => $normalize_pl_config,
66            marc_encoding => 'utf-8',
67      );
68    
69  =back  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
70    other are optional.
71    
72  This also describes order in which transformations are applied (eval,  This function will B<die> if normalizastion can't be evaled.
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
73    
74    Since this function isn't exported you have to call it with
75    C<WebPAC::Normalize::data_structure>.
76    
77    =cut
78    
79    sub data_structure {
80            my $arg = {@_};
81    
82  =head1 FUNCTIONS          die "need row argument" unless ($arg->{row});
83            die "need normalisation argument" unless ($arg->{rules});
84    
85  =head2 new          no strict 'subs';
86            _set_lookup( $arg->{lookup} );
87            _set_rec( $arg->{row} );
88            _clean_ds( %{ $arg } );
89            eval "$arg->{rules}";
90            die "error evaling $arg->{rules}: $@\n" if ($@);
91    
92  Create new normalisation object          return _get_ds();
93    }
94    
95    my $n = new WebPAC::Normalize::Something(  =head2 _set_rec
         filter => {  
                 'filter_name_1' => sub {  
                         # filter code  
                         return length($_);  
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
   );  
96    
97  Parametar C<filter> defines user supplied snippets of perl code which can  Set current record hash
 be use with C<filter{...}> notation.  
98    
99  Recommended parametar C<lookup_regex> is used to enable parsing of lookups    _set_rec( $rec );
 in structures.  
100    
101  =cut  =cut
102    
103  sub new {  my $rec;
         my $class = shift;  
         my $self = {@_};  
         bless($self, $class);  
104    
105          $self ? return $self : return undef;  sub _set_rec {
106            $rec = shift or die "no record hash";
107  }  }
108    
109    =head2 _get_ds
110    
111  =head2 data_structure  Return hash formatted as data structure
   
 Create in-memory data structure which represents normalized layout from  
 C<conf/normalize/*.xml>.  
   
 This structures are used to produce output.  
   
  my @ds = $webpac->data_structure($rec);  
112    
113  B<Note: historical oddity follows>    my $ds = _get_ds();
   
 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.  
114    
115  =cut  =cut
116    
117  sub data_structure {  my ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators);
         my $self = shift;  
   
         my $log = $self->_get_logger();  
   
         my $rec = shift;  
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
   
         my $cache_file;  
   
         if ($self->{'db'}) {  
                 my @ds = $self->{'db'}->load_ds($rec);  
                 $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper(@ds) });  
                 return @ds if ($#ds > 0);  
                 $log->debug("cache miss, creating");  
         }  
118    
119          undef $self->{'currnet_filename'};  sub _get_ds {
120          undef $self->{'headline'};          return $out;
121    }
         my @sorted_tags;  
         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;  
         }  
   
         my @ds;  
   
         $log->debug("tags: ",sub { join(", ",@sorted_tags) });  
   
         foreach my $field (@sorted_tags) {  
122    
123                  my $row;  =head2 _clean_ds
124    
125  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  Clean data structure hash for next record
126    
127                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {    _clean_ds();
                         my $format = $tag->{'value'} || $tag->{'content'};  
128    
129                          $log->debug("format: $format");  =cut
130    
131                          my @v;  sub _clean_ds {
132                          if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {          my $a = {@_};
133                                  @v = $self->fill_in_to_arr($rec,$format);          ($out,$marc_record, $marc_encoding, $marc_repeatable_subfield, $marc_indicators) = ();
134                          } else {          $marc_encoding = $a->{marc_encoding};
135                                  @v = $self->parse_to_arr($rec,$format);  }
                         }  
                         next if (! @v);  
136    
137                          if ($tag->{'sort'}) {  =head2 _set_lookup
                                 @v = $self->sort_arr(@v);  
                         }  
138    
139                          # use format?  Set current lookup hash
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
140    
141                          if ($field eq 'filename') {    _set_lookup( $lookup );
                                 $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!  
                         }  
142    
143                          # delimiter will join repeatable fields  =cut
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
144    
145                          # default types  my $lookup;
                         my @types = qw(display swish);  
                         # 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;  
                                 }  
                         }  
146    
147    sub _set_lookup {
148            $lookup = shift;
149    }
150    
151                  }  =head2 _get_marc_fields
152    
153                  if ($row) {  Get all fields defined by calls to C<marc>
                         $row->{'tag'} = $field;  
154    
155                          # TODO: name_sigular, name_plural          $marc->add_fields( WebPAC::Normalize:_get_marc_fields() );
                         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");  
                         }  
156    
157                          push @ds, $row;  We are using I<magic> which detect repeatable fields only from
158    sequence of field/subfield data generated by normalization.
159    
160                          $log->debug("row $field: ",sub { Dumper($row) });  Repeatable field is created when there is second occurence of same subfield or
161                  }  if any of indicators are different.
162    
163          }  This is sane for most cases. Something like:
164    
165          $self->{'db'}->save_ds(    900a-1 900b-1 900c-1
166                  ds => \@ds,    900a-2 900b-2
167                  current_filename => $self->{'current_filename'},    900a-3
                 headline => $self->{'headline'},  
         ) if ($self->{'db'});  
168    
169          $log->debug("ds: ", sub { Dumper(@ds) });  will be created from any combination of:
170    
171          return @ds;    900a-1 900a-2 900a-3 900b-1 900b-2 900c-1
172    
173  }  and following rules:
174    
175  =head2 parse    marc('900','a', rec('200','a') );
176      marc('900','b', rec('200','b') );
177      marc('900','c', rec('200','c') );
178    
179  Perform smart parsing of string, skipping delimiters for fields which aren't  which might not be what you have in mind. If you need repeatable subfield,
180  defined. It can also eval code in format starting with C<eval{...}> and  define it using C<marc_repeatable_subfield> like this:
 return output or nothing depending on eval code.  
181    
182   my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  ....
183    
184  =cut  =cut
185    
186  sub parse {  sub _get_marc_fields {
         my $self = shift;  
   
         my ($rec, $format_utf8, $i) = @_;  
187    
188          return if (! $format_utf8);          return if (! $marc_record || ref($marc_record) ne 'ARRAY' || $#{ $marc_record } < 0);
189    
190          my $log = $self->_get_logger();          # first, sort all existing fields
191            # XXX might not be needed, but modern perl might randomize elements in hash
192            my @sorted_marc_record = sort {
193                    $a->[0] . $a->[3] cmp $b->[0] . $b->[3]
194            } @{ $marc_record };
195    
196          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          # output marc fields
197            my @m;
198    
199          $i = 0 if (! $i);          # count unique field-subfields (used for offset when walking to next subfield)
200            my $u;
201            map { $u->{ $_->[0] . $_->[3]  }++ } @sorted_marc_record;
202    
203          my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});          if ($debug) {
204                    warn "## marc_repeatable_subfield ", dump( $marc_repeatable_subfield ), $/;
205          my @out;                  warn "## marc_record ", dump( $marc_record ), $/;
206                    warn "## sorted_marc_record ", dump( \@sorted_marc_record ), $/;
207          $log->debug("format: $format");                  warn "## subfield count ", dump( $u ), $/;
208            }
         my $eval_code;  
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
209    
210          my $filter_name;          my $len = $#sorted_marc_record;
211          # remove filter{...} from beginning          my $visited;
212          $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);          my $i = 0;
213            my $field;
214    
215          my $prefix;          foreach ( 0 .. $len ) {
         my $all_found=0;  
216    
217          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {                  # find next element which isn't visited
218                    while ($visited->{$i}) {
219                            $i = ($i + 1) % ($len + 1);
220                    }
221    
222                  my $del = $1 || '';                  # mark it visited
223                  $prefix ||= $del if ($all_found == 0);                  $visited->{$i}++;
224    
225                  # repeatable index                  my $row = $sorted_marc_record[$i];
                 my $r = $i;  
                 $r = 0 if (lc("$2") eq 's');  
226    
227                  my $found = 0;                  # field and subfield which is key for
228                  my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found);                  # marc_repeatable_subfield and u
229                    my $fsf = $row->[0] . $row->[3];
230    
231                    if ($debug > 1) {
232    
233                            print "### field so far [", $#$field, "] : ", dump( $field ), " ", $field ? 'T' : 'F', $/;
234                            print "### this [$i]: ", dump( $row ),$/;
235                            print "### sf: ", $row->[3], " vs ", $field->[3],
236                                    $marc_repeatable_subfield->{ $row->[0] . $row->[3] } ? ' (repeatable)' : '', $/,
237                                    if ($#$field >= 0);
238    
                 if ($found) {  
                         push @out, $del;  
                         push @out, $tmp;  
                         $all_found += $found;  
239                  }                  }
         }  
   
         return if (! $all_found);  
240    
241          my $out = join('',@out);                  # if field exists
242                    if ( $#$field >= 0 ) {
243                            if (
244                                    $row->[0] ne $field->[0] ||             # field
245                                    $row->[1] ne $field->[1] ||             # i1
246                                    $row->[2] ne $field->[2]                # i2
247                            ) {
248                                    push @m, $field;
249                                    warn "## saved/1 ", dump( $field ),$/ if ($debug);
250                                    $field = $row;
251    
252                            } elsif (
253                                    ( $row->[3] lt $field->[-2] )           # subfield which is not next (e.g. a after c)
254                                    ||
255                                    ( $row->[3] eq $field->[-2] &&          # same subfield, but not repeatable
256                                            ! $marc_repeatable_subfield->{ $fsf }
257                                    )
258                            ) {
259                                    push @m, $field;
260                                    warn "## saved/2 ", dump( $field ),$/ if ($debug);
261                                    $field = $row;
262    
263          if ($out) {                          } else {
264                  # add rest of format (suffix)                                  # append new subfields to existing field
265                  $out .= $format;                                  push @$field, ( $row->[3], $row->[4] );
266                            }
267                  # add prefix if not there                  } else {
268                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);                          # insert first field
269                            $field = $row;
270                    }
271    
272                  $log->debug("result: $out");                  if (! $marc_repeatable_subfield->{ $fsf }) {
273                            # make step to next subfield
274                            $i = ($i + $u->{ $fsf } ) % ($len + 1);
275                    }
276          }          }
277    
278          if ($eval_code) {          if ($#$field >= 0) {
279                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  push @m, $field;
280                  $log->debug("about to eval{$eval} format: $out");                  warn "## saved/3 ", dump( $field ),$/ if ($debug);
                 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");  
281          }          }
282    
283          return $out;          return @m;
284  }  }
285    
286  =head2 parse_to_arr  =head2 _debug
287    
288  Similar to C<parse>, but returns array of all repeatable fields  Change level of debug warnings
289    
290   my @arr = $webpac->parse_to_arr($rec,'v250^a');    _debug( 2 );
291    
292  =cut  =cut
293    
294  sub parse_to_arr {  sub _debug {
295          my $self = shift;          my $l = shift;
296            return $debug unless defined($l);
297            $debug = $l;
298    }
299    
300          my ($rec, $format_utf8) = @_;  =head1 Functions to create C<data_structure>
301    
302          my $log = $self->_get_logger();  Those functions generally have to first in your normalization file.
303    
304          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  =head2 tag
         return if (! $format_utf8);  
305    
306          my $i = 0;  Define new tag for I<search> and I<display>.
         my @arr;  
307    
308          while (my $v = $self->parse($rec,$format_utf8,$i++)) {    tag('Title', rec('200','a') );
                 push @arr, $v;  
         }  
309    
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
310    
311          return @arr;  =cut
312    
313    sub tag {
314            my $name = shift or die "tag needs name as first argument";
315            my @o = grep { defined($_) && $_ ne '' } @_;
316            return unless (@o);
317            $out->{$name}->{tag} = $name;
318            $out->{$name}->{search} = \@o;
319            $out->{$name}->{display} = \@o;
320  }  }
321    
322    =head2 display
323    
324  =head2 fill_in  Define tag just for I<display>
325    
326  Workhourse of all: takes record from in-memory structure of database and    @v = display('Title', rec('200','a') );
 strings with placeholders and returns string or array of with substituted  
 values from record.  
327    
328   my $text = $webpac->fill_in($rec,'v250^a');  =cut
329    
330  Optional argument is ordinal number for repeatable fields. By default,  sub display {
331  it's assume to be first repeatable field (fields are perl array, so first          my $name = shift or die "display needs name as first argument";
332  element is 0).          my @o = grep { defined($_) && $_ ne '' } @_;
333  Following example will read second value from repeatable field.          return unless (@o);
334            $out->{$name}->{tag} = $name;
335            $out->{$name}->{display} = \@o;
336    }
337    
338   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  =head2 search
339    
340  This function B<does not> perform parsing of format to inteligenty skip  Prepare values just for I<search>
 delimiters before fields which aren't used.  
341    
342  This method will automatically decode UTF-8 string to local code page    @v = search('Title', rec('200','a') );
 if needed.  
343    
344  =cut  =cut
345    
346  sub fill_in {  sub search {
347          my $self = shift;          my $name = shift or die "search needs name as first argument";
348            my @o = grep { defined($_) && $_ ne '' } @_;
349            return unless (@o);
350            $out->{$name}->{tag} = $name;
351            $out->{$name}->{search} = \@o;
352    }
353    
354          my $log = $self->_get_logger();  =head2 marc
355    
356          my $rec = shift || $log->logconfess("need data record");  Save value for MARC field
         my $format = shift || $log->logconfess("need format to parse");  
         # iteration (for repeatable fields)  
         my $i = shift || 0;  
357    
358          $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));    marc('900','a', rec('200','a') );
359    
360          # FIXME remove for speedup?  =cut
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
361    
362          if (utf8::is_utf8($format)) {  sub marc {
363                  $format = $self->_x($format);          my $f = shift or die "marc needs field";
364          }          die "marc field must be numer" unless ($f =~ /^\d+$/);
365    
366          my $found = 0;          my $sf = shift or die "marc needs subfield";
367    
368          my $eval_code;          foreach (@_) {
369          # remove eval{...} from beginning                  my $v = $_;             # make var read-write for Encode
370          $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);                  next unless (defined($v) && $v !~ /^\s*$/);
371                    from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
372          my $filter_name;                  my ($i1,$i2) = defined($marc_indicators->{$f}) ? @{ $marc_indicators->{$f} } : (' ',' ');
373          # remove filter{...} from beginning                  push @{ $marc_record }, [ $f, $i1, $i2, $sf => $v ];
         $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;  
374          }          }
375  }  }
376    
377    =head2 marc_repeatable_subfield
378    
379  =head2 fill_in_to_arr  Save values for MARC repetable subfield
380    
381  Similar to C<fill_in>, but returns array of all repeatable fields. Usable    marc_repeatable_subfield('910', 'z', rec('909') );
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<fill_id>ed.  
   
  my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]');  
382    
383  =cut  =cut
384    
385  sub fill_in_to_arr {  sub marc_repeatable_subfield {
386          my $self = shift;          my ($f,$sf) = @_;
387            die "marc_repeatable_subfield need field and subfield!\n" unless ($f && $sf);
388            $marc_repeatable_subfield->{ $f . $sf }++;
389            marc(@_);
390    }
391    
392          my ($rec, $format_utf8) = @_;  =head2 marc_indicators
393    
394          my $log = $self->_get_logger();  Set both indicators for MARC field
395    
396          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);    marc_indicators('900', ' ', 1);
         return if (! $format_utf8);  
397    
398          my $i = 0;  Any indicator value other than C<0-9> will be treated as undefined.
         my @arr;  
399    
400          while (my @v = $self->fill_in($rec,$format_utf8,$i++)) {  =cut
                 push @arr, @v;  
         }  
401    
402          $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  sub marc_indicators {
403            my $f = shift || die "marc_indicators need field!\n";
404            my ($i1,$i2) = @_;
405            die "marc_indicators($f, ...) need i1!\n" unless(defined($i1));
406            die "marc_indicators($f, $i1, ...) need i2!\n" unless(defined($i2));
407    
408          return @arr;          $i1 = ' ' if ($i1 !~ /^\d$/);
409            $i2 = ' ' if ($i2 !~ /^\d$/);
410            @{ $marc_indicators->{$f} } = ($i1,$i2);
411  }  }
412    
413    
414  =head2 get_data  =head1 Functions to extract data from input
415    
416  Returns value from record.  This function should be used inside functions to create C<data_structure> described
417    above.
418    
419   my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);  =head2 rec1
420    
421  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>.  
422    
423  Optinal variable C<$found> will be incremeted if there    @v = rec1('200')
 is field.  
424    
425  Returns value or empty string.  TODO: order of values is probably same as in source data, need to investigate that
426    
427  =cut  =cut
428    
429  sub get_data {  sub rec1 {
430          my $self = shift;          my $f = shift;
431            return unless (defined($rec) && defined($rec->{$f}));
432          my ($rec,$f,$sf,$i,$found) = @_;          if (ref($rec->{$f}) eq 'ARRAY') {
433                    return map {
434          if ($$rec->{$f}) {                          if (ref($_) eq 'HASH') {
435                  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;  
436                          } else {                          } else {
437                                  return $$rec->{$f}->[$i];                                  $_;
438                          }                          }
439                  }                  } @{ $rec->{$f} };
440          } else {          } elsif( defined($rec->{$f}) ) {
441                  return '';                  return $rec->{$f};
442          }          }
443  }  }
444    
445    =head2 rec2
446    
447  =head2 apply_format  Return all values in specific field and subfield
448    
449  Apply format specified in tag with C<format_name="name"> and    @v = rec2('200','a')
 C<format_delimiter=";;">.  
450    
451   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  =cut
452    
453  Formats can contain C<lookup{...}> if you need them.  sub rec2 {
454            my $f = shift;
455            return unless (defined($rec && $rec->{$f}));
456            my $sf = shift;
457            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
458    }
459    
460  =cut  =head2 rec
461    
462  sub apply_format {  syntaxtic sugar for
         my $self = shift;  
463    
464          my ($name,$delimiter,$data) = @_;    @v = rec('200')
465      @v = rec('200','a')
466    
467          my $log = $self->_get_logger();  =cut
468    
469          if (! $self->{'import_xml'}->{'format'}->{$name}) {  sub rec {
470                  $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});          if ($#_ == 0) {
471                  return $data;                  return rec1(@_);
472            } elsif ($#_ == 1) {
473                    return rec2(@_);
474          }          }
475    }
476    
477          $log->warn("no delimiter for format $name") if (! $delimiter);  =head2 regex
478    
479          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  Apply regex to some or all values
480    
481          my @data = split(/\Q$delimiter\E/, $data);    @v = regex( 's/foo/bar/g', @v );
482    
483          my $out = sprintf($format, @data);  =cut
         $log->debug("using format $name [$format] on $data to produce: $out");  
484    
485          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  sub regex {
486                  return $self->lookup($out);          my $r = shift;
487          } else {          my @out;
488                  return $out;          #warn "r: $r\n", dump(\@_);
489            foreach my $t (@_) {
490                    next unless ($t);
491                    eval "\$t =~ $r";
492                    push @out, $t if ($t && $t ne '');
493          }          }
494            return @out;
495  }  }
496    
497  =head2 sort_arr  =head2 prefix
498    
499  Sort array ignoring case and html in data  Prefix all values with a string
500    
501   my @sorted = $webpac->sort_arr(@unsorted);    @v = prefix( 'my_', @v );
502    
503  =cut  =cut
504    
505  sub sort_arr {  sub prefix {
506          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
507            return map { $p . $_ } grep { defined($_) } @_;
508    }
509    
510          my $log = $self->_get_logger();  =head2 suffix
511    
512          # FIXME add Schwartzian Transformation?  suffix all values with a string
513    
514          my @sorted = sort {    @v = suffix( '_my', @v );
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
515    
516          return @sorted;  =cut
 }  
517    
518    sub suffix {
519            my $s = shift or die "suffix needs string as first argument";
520            return map { $_ . $s } grep { defined($_) } @_;
521    }
522    
523  =head1 INTERNAL METHODS  =head2 surround
524    
525  =head2 _sort_by_order  surround all values with a two strings
526    
527  Sort xml tags data structure accoding to C<order=""> attribute.    @v = surround( 'prefix_', '_suffix', @v );
528    
529  =cut  =cut
530    
531  sub _sort_by_order {  sub surround {
532          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
533            my $s = shift or die "surround needs suffix as second argument";
534          my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||          return map { $p . $_ . $s } grep { defined($_) } @_;
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
   
         return $va <=> $vb;  
535  }  }
536    
537  =head2 _x  =head2 first
538    
539  Convert strings from C<conf/normalize/*.xml> encoding into application  Return first element
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
540    
541   my $text = $n->_x('normalize text string');    $v = first( @v );
   
 This is a stub so that other modules doesn't have to implement it.  
542    
543  =cut  =cut
544    
545  sub _x {  sub first {
546          my $self = shift;          my $r = shift;
547          return shift;          return $r;
548  }  }
549    
550    =head2 lookup
551    
552  =head1 AUTHOR  Consult lookup hashes for some value
553    
554  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>    @v = lookup( $v );
555      @v = lookup( @v );
556    
557  =head1 COPYRIGHT & LICENSE  =cut
558    
559  Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  sub lookup {
560            my $k = shift or return;
561            return unless (defined($lookup->{$k}));
562            if (ref($lookup->{$k}) eq 'ARRAY') {
563                    return @{ $lookup->{$k} };
564            } else {
565                    return $lookup->{$k};
566            }
567    }
568    
569    =head2 join_with
570    
571  This program is free software; you can redistribute it and/or modify it  Joins walues with some delimiter
572  under the same terms as Perl itself.  
573      $v = join_with(", ", @v);
574    
575  =cut  =cut
576    
577  1; # End of WebPAC::DB  sub join_with {
578            my $d = shift;
579            return join($d, grep { defined($_) && $_ ne '' } @_);
580    }
581    
582    # END
583    1;

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

  ViewVC Help
Powered by ViewVC 1.1.26