/[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 397 by dpavlin, Wed Feb 15 15:54:12 2006 UTC revision 541 by dpavlin, Thu Jun 29 21:18:50 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    
7            tag search display
8            marc21
9    
10            rec1 rec2 rec
11            regex prefix suffix surround
12            first lookup join_with
13    /;
14    
15  use warnings;  use warnings;
16  use strict;  use strict;
17  use blib;  
18  use WebPAC::Common;  #use base qw/WebPAC::Common/;
 use base 'WebPAC::Common';  
19  use Data::Dumper;  use Data::Dumper;
20    use Encode qw/from_to/;
21    
22  =head1 NAME  =head1 NAME
23    
24  WebPAC::Normalize - data mungling for normalisation  WebPAC::Normalize - describe normalisaton rules using sets
25    
26  =head1 VERSION  =head1 VERSION
27    
28  Version 0.08  Version 0.06
29    
30  =cut  =cut
31    
32  our $VERSION = '0.08';  our $VERSION = '0.06';
33    
34  =head1 SYNOPSIS  =head1 SYNOPSIS
35    
36  This package contains code that mungle data to produce normalized format.  This module uses C<conf/normalize/*.pl> files to perform normalisation
37    from input records using perl functions which are specialized for set
38  It contains several assumptions:  processing.
39    
40  =over  Sets are implemented as arrays, and normalisation file is valid perl, which
41    means that you check it's validity before running WebPAC using
42  =item *  C<perl -c normalize.pl>.
43    
44  format of fields is defined using C<v123^a> notation for repeatable fields  Normalisation can generate multiple output normalized data. For now, supported output
45  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
46  C<a> is subfield.  C<marc21>.
   
 =item *  
   
 source data records (C<$rec>) have unique identifiers in field C<000>  
   
 =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  
   
 There is one built-in filter called C<regex> which can be use like this:  
   
   filter{regex(s/foo/bar/)}  
   
 =item *  
   
 optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.  
   
 =item *  
   
 at end, optional C<format>s rules are resolved. Format rules are similar to  
 C<sprintf> and can also contain C<lookup{...}> which is performed after  
 values are inserted in format.  
   
 =back  
   
 This also describes order in which transformations are applied (eval,  
 filter, lookup, format) which is important to undestand when deciding how to  
 solve your data mungling and normalisation process.  
   
   
   
47    
48  =head1 FUNCTIONS  =head1 FUNCTIONS
49    
50  =head2 new  Functions which start with C<_> are private and used by WebPAC internally.
51    All other functions are available for use within normalisation rules.
52    
53    =head2 data_structure
54    
55  Create new normalisation object  Return data structure
56    
57    my $n = new WebPAC::Normalize::Something(    my $ds = WebPAC::Normalize::data_structure(
58          filter => {          lookup => $lookup->lookup_hash,
59                  'filter_name_1' => sub {          row => $row,
60                          # filter code          rules => $normalize_pl_config,
61                          return length($_);          marc_encoding => 'utf-8',
                 }, ...  
         },  
         db => $db_obj,  
         lookup_regex => $lookup->regex,  
         lookup => $lookup_obj,  
         prefix => 'foobar',  
62    );    );
63    
64  Parametar C<filter> defines user supplied snippets of perl code which can  Options C<lookup>, C<row>, C<rules> and C<log> are mandatory while all
65  be use with C<filter{...}> notation.  other are optional.
66    
67  C<prefix> is used to form filename for database record (to support multiple  This function will B<die> if normalizastion can't be evaled.
 source files which are joined in one database).  
68    
69  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Since this function isn't exported you have to call it with
70  in structures. If you pass this parametar, you must also pass C<lookup>  C<WebPAC::Normalize::data_structure>.
 which is C<WebPAC::Lookup> object.  
71    
72  =cut  =cut
73    
74  sub new {  sub data_structure {
75          my $class = shift;          my $arg = {@_};
         my $self = {@_};  
         bless($self, $class);  
   
         my $r = $self->{'lookup_regex'} ? 1 : 0;  
         my $l = $self->{'lookup'} ? 1 : 0;  
   
         my $log = $self->_get_logger();  
   
         # those two must be in pair  
         if ( ($r & $l) != ($r || $l) ) {  
                 my $log = $self->_get_logger();  
                 $log->logdie("lookup_regex and lookup must be in pair");  
         }  
   
         $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));  
   
         $log->warn("no prefix defined. please check that!") unless ($self->{'prefix'});  
76    
77          $log->debug("using lookup regex: ", $self->{lookup_regex}) if ($r && $l);          die "need row argument" unless ($arg->{row});
78            die "need normalisation argument" unless ($arg->{rules});
79    
80          if (! $self->{filter} || ! $self->{filter}->{regex}) {          no strict 'subs';
81                  $log->debug("adding built-in filter regex");          _set_lookup( $arg->{lookup} );
82                  $self->{filter}->{regex} = sub {          _set_rec( $arg->{row} );
83                          my ($val, $regex) = @_;          _clean_ds( %{ $arg } );
84                          eval "\$val =~ $regex";          eval "$arg->{rules}";
85                          return $val;          die "error evaling $arg->{rules}: $@\n" if ($@);
                 };  
         }  
86    
87          $self ? return $self : return undef;          return _get_ds();
88  }  }
89    
90    =head2 _set_rec
91    
92  =head2 data_structure  Set current record hash
   
 Create in-memory data structure which represents normalized layout from  
 C<conf/normalize/*.xml>.  
   
 This structures are used to produce output.  
93    
94   my $ds = $webpac->data_structure($rec);    _set_rec( $rec );
95    
96  =cut  =cut
97    
98  sub data_structure {  my $rec;
         my $self = shift;  
   
         my $log = $self->_get_logger();  
   
         my $rec = shift;  
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
   
         $log->debug("data_structure rec = ", sub { Dumper($rec) });  
   
         $log->logdie("need unique ID (mfn) in field 000 of record " . Dumper($rec) ) unless (defined($rec->{'000'}));  
   
         my $id = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");  
   
         my $cache_file;  
99    
100          if ($self->{'db'}) {  sub _set_rec {
101                  my $ds = $self->{'db'}->load_ds( id => $id, prefix => $self->{prefix} );          $rec = shift or die "no record hash";
102                  $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });  }
                 return $ds if ($ds);  
                 $log->debug("cache miss, creating");  
         }  
   
         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) {  
   
                 my $row;  
   
 #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  
   
                 foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {  
                         my $format;  
   
                         $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');  
                         $format = $tag->{'value'} || $tag->{'content'};  
103    
104                          my @v;  =head2 _get_ds
                         if ($self->{'lookup_regex'} && $format =~ $self->{'lookup_regex'}) {  
                                 @v = $self->_rec_to_arr($rec,$format,'fill_in');  
                         } else {  
                                 @v = $self->_rec_to_arr($rec,$format,'parse');  
                         }  
                         if (! @v) {  
                                 $log->debug("$field <",$self->{tag},"> format: $format no values");  
                                 next;  
                         } else {  
                                 $log->debug("$field <",$self->{tag},"> format: $format values: ", join(",", @v));  
                         }  
105    
106                          if ($tag->{'sort'}) {  Return hash formatted as data structure
                                 @v = $self->sort_arr(@v);  
                         }  
107    
108                          # use format?    my $ds = _get_ds();
                         if ($tag->{'format_name'}) {  
                                 @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;  
                         }  
109    
110                          # delimiter will join repeatable fields  =cut
                         if ($tag->{'delimiter'}) {  
                                 @v = ( join($tag->{'delimiter'}, @v) );  
                         }  
111    
112                          # default types  my $out;
113                          my @types = qw(display search);  my $marc21;
114                          # override by type attribute  my $marc_encoding;
                         @types = ( $tag->{'type'} ) if ($tag->{'type'});  
   
                         foreach my $type (@types) {  
                                 # append to previous line?  
                                 $log->debug("tag $field / $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;  
                                 }  
                         }  
115    
116    sub _get_ds {
117            return $out;
118    }
119    
120                  }  =head2 _clean_ds
121    
122                  if ($row) {  Clean data structure hash for next record
                         $row->{'tag'} = $field;  
123    
124                          # TODO: name_sigular, name_plural    _clean_ds();
                         my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};  
                         my $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");  
                         }  
125    
126                          $ds->{$row_name} = $row;  =cut
127    
128                          $log->debug("row $field: ",sub { Dumper($row) });  sub _clean_ds {
129                  }          my $a = {@_};
130            $out = undef;
131            $marc21 = undef;
132            $marc_encoding = $a->{marc_encoding};
133    }
134    
135          }  =head2 _set_lookup
136    
137          $self->{'db'}->save_ds(  Set current lookup hash
                 id => $id,  
                 ds => $ds,  
                 prefix => $self->{prefix},  
         ) if ($self->{'db'});  
138    
139          $log->debug("ds: ", sub { Dumper($ds) });    _set_lookup( $lookup );
140    
141          $log->logconfess("data structure returned is not array any more!") if wantarray;  =cut
142    
143          return $ds;  my $lookup;
144    
145    sub _set_lookup {
146            $lookup = shift;
147  }  }
148    
149  =head2 parse  =head2 _get_marc21_fields
   
 Perform smart parsing of string, skipping delimiters for fields which aren't  
 defined. It can also eval code in format starting with C<eval{...}> and  
 return output or nothing depending on eval code.  
   
  my $text = $webpac->parse($rec,'eval{"v901^a" eq "Deskriptor"}descriptor: v250^a', $i);  
   
 Filters are implemented here. While simple form of filters looks like this:  
150    
151    filter{name_of_filter}  Get all fields defined by calls to C<marc21>
152    
153  but, filters can also have variable number of parametars like this:          $marc->add_fields( WebPAC::Normalize:_get_marc21_fields() );
   
   filter{name_of_filter(param,param,param)}  
154    
155  =cut  =cut
156    
157  my $warn_once;  sub _get_marc21_fields {
158            return @{$marc21};
159  sub parse {  }
         my $self = shift;  
160    
161          my ($rec, $format_utf8, $i, $rec_size) = @_;  =head1 Functions to create C<data_structure>
162    
163          return if (! $format_utf8);  Those functions generally have to first in your normalization file.
164    
165          my $log = $self->_get_logger();  =head2 tag
166    
167          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  Define new tag for I<search> and I<display>.
168    
169          $i = 0 if (! $i);    tag('Title', rec('200','a') );
170    
         my $format = $self->_x($format_utf8) || $log->logconfess("can't convert '$format_utf8' from UTF-8 to ",$self->{'code_page'});  
171    
172          my @out;  =cut
173    
174          $log->debug("format: $format [$i]");  sub tag {
175            my $name = shift or die "tag needs name as first argument";
176            my @o = grep { defined($_) && $_ ne '' } @_;
177            return unless (@o);
178            $out->{$name}->{tag} = $name;
179            $out->{$name}->{search} = \@o;
180            $out->{$name}->{display} = \@o;
181    }
182    
183          my $eval_code;  =head2 display
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
184    
185          my $filter_name;  Define tag just for I<display>
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
186    
187          # did we found any (att all) field from format in row?    @v = display('Title', rec('200','a') );
         my $found_any;  
         # prefix before first field which we preserve it $found_any  
         my $prefix;  
188    
189          my $f_step = 1;  =cut
190    
191          while ($format =~ s/^(.*?)(v|s)(\d+)(?:\^(\w))?//s) {  sub display {
192            my $name = shift or die "display needs name as first argument";
193            my @o = grep { defined($_) && $_ ne '' } @_;
194            return unless (@o);
195            $out->{$name}->{tag} = $name;
196            $out->{$name}->{display} = \@o;
197    }
198    
199                  my $del = $1 || '';  =head2 search
                 $prefix = $del if ($f_step == 1);  
200    
201                  my $fld_type = lc($2);  Prepare values just for I<search>
202    
203                  # repeatable index    @v = search('Title', rec('200','a') );
                 my $r = $i;  
                 if ($fld_type eq 's') {  
                         if ($found_any->{'v'}) {  
                                 $r = 0;  
                         } else {  
                                 return;  
                         }  
                 }  
204    
205                  my $found = 0;  =cut
                 my $tmp = $self->get_data(\$rec,$3,$4,$r,\$found,$rec_size);  
206    
207                  if ($found) {  sub search {
208                          $found_any->{$fld_type} += $found;          my $name = shift or die "search needs name as first argument";
209            my @o = grep { defined($_) && $_ ne '' } @_;
210            return unless (@o);
211            $out->{$name}->{tag} = $name;
212            $out->{$name}->{search} = \@o;
213    }
214    
215                          # we will skip delimiter before first occurence of field!  =head2 marc21
                         push @out, $del unless($found_any->{$fld_type} == 1);  
                         push @out, $tmp;  
                 }  
                 $f_step++;  
         }  
216    
217          # test if any fields found?  Save value for MARC field
         return if (! $found_any->{'v'} && ! $found_any->{'s'});  
218    
219          my $out = join('',@out);    marc21('900','a', rec('200','a') );
220    
221          if ($out) {  =cut
                 # add rest of format (suffix)  
                 $out .= $format;  
222    
223                  # add prefix if not there  sub marc21 {
224                  $out = $prefix . $out if ($out !~ m/^\Q$prefix\E/);          my $f = shift or die "marc21 needs field";
225            die "marc21 field must be numer" unless ($f =~ /^\d+$/);
226    
227                  $log->debug("result: $out");          my $sf = shift or die "marc21 needs subfield";
         }  
228    
229          if ($eval_code) {          foreach (@_) {
230                  my $eval = $self->fill_in($rec,$eval_code,$i) || return;                  my $v = $_;             # make var read-write for Encode
231                  $log->debug("about to eval{$eval} format: $out");                  next unless (defined($v) && $v !~ /^\s+$/);
232                  return if (! $self->_eval($eval));                  from_to($v, 'iso-8859-2', $marc_encoding) if ($marc_encoding);
233          }                  push @{ $marc21 }, [ $f, ' ', ' ', $sf => $v ];
           
         if ($filter_name) {  
                 my @filter_args;  
                 if ($filter_name =~ s/(\w+)\((.*)\)/$1/) {  
                         @filter_args = split(/,/, $2);  
                 }  
                 if ($self->{'filter'}->{$filter_name}) {  
                         $log->debug("about to filter{$filter_name} format: $out with arguments: ", join(",", @filter_args));  
                         unshift @filter_args, $out;  
                         $out = $self->{'filter'}->{$filter_name}->(@filter_args);  
                         return unless(defined($out));  
                         $log->debug("filter result: $out");  
                 } elsif (! $warn_once->{$filter_name}) {  
                         $log->warn("trying to use undefined filter $filter_name");  
                         $warn_once->{$filter_name}++;  
                 }  
234          }          }
   
         return $out;  
235  }  }
236    
237  =head2 fill_in  =head1 Functions to extract data from input
   
 Workhourse of all: takes record from in-memory structure of database and  
 strings with placeholders and returns string or array of with substituted  
 values from record.  
   
  my $text = $webpac->fill_in($rec,'v250^a');  
   
 Optional argument is ordinal number for repeatable fields. By default,  
 it's assume to be first repeatable field (fields are perl array, so first  
 element is 0).  
 Following example will read second value from repeatable field.  
238    
239   my $text = $webpac->fill_in($rec,'Title: v250^a',1);  This function should be used inside functions to create C<data_structure> described
240    above.
241    
242  This function B<does not> perform parsing of format to inteligenty skip  =head2 rec1
 delimiters before fields which aren't used.  
243    
244  This method will automatically decode UTF-8 string to local code page  Return all values in some field
 if needed.  
245    
246  There is optional parametar C<$record_size> which can be used to get sizes of    @v = rec1('200')
 all C<field^subfield> combinations in this format.  
247    
248   my $text = $webpac->fill_in($rec,'got: v900^a v900^x',0,\$rec_size);  TODO: order of values is probably same as in source data, need to investigate that
249    
250  =cut  =cut
251    
252  sub fill_in {  sub rec1 {
253          my $self = shift;          my $f = shift;
254            return unless (defined($rec) && defined($rec->{$f}));
255          my $log = $self->_get_logger();          if (ref($rec->{$f}) eq 'ARRAY') {
256                    return map {
257          my ($rec,$format,$i,$rec_size) = @_;                          if (ref($_) eq 'HASH') {
258                                    values %{$_};
         $log->logconfess("need data record") unless ($rec);  
         $log->logconfess("need format to parse") unless($format);  
   
         # iteration (for repeatable fields)  
         $i ||= 0;  
   
         $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));  
   
         # FIXME remove for speedup?  
         $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  
   
         if (utf8::is_utf8($format)) {  
                 $format = $self->_x($format);  
         }  
   
         my $found = 0;  
         my $just_single = 1;  
   
         my $eval_code;  
         # remove eval{...} from beginning  
         $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);  
   
         my $filter_name;  
         # remove filter{...} from beginning  
         $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);  
   
         {  
                 # fix warnings  
                 no warnings 'uninitialized';  
   
                 # do actual replacement of placeholders  
                 # repeatable fields  
                 if ($format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found,$rec_size)/ges) {  
                         $just_single = 0;  
                 }  
   
                 # non-repeatable fields  
                 if ($format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found,$rec_size)/ges) {  
                         return if ($i > 0 && $just_single);  
                 }  
         }  
   
         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'}) {  
                         if ($self->{'lookup'}->can('lookup')) {  
                                 my @lookup = $self->{lookup}->lookup($format);  
                                 $log->debug("lookup $format", join(", ", @lookup));  
                                 return @lookup;  
259                          } else {                          } else {
260                                  $log->warn("Have lookup object but can't invoke lookup method");                                  $_;
261                          }                          }
262                  } else {                  } @{ $rec->{$f} };
263                          return $format;          } elsif( defined($rec->{$f}) ) {
264                  }                  return $rec->{$f};
         } else {  
                 return;  
265          }          }
266  }  }
267    
268    =head2 rec2
269    
270  =head2 _rec_to_arr  Return all values in specific field and subfield
271    
272  Similar to C<parse> and C<fill_in>, but returns array of all repeatable fields. Usable    @v = rec2('200','a')
 for fields which have lookups, so they shouldn't be parsed but rather  
 C<paste>d or C<fill_id>ed. Last argument is name of operation: C<paste> or C<fill_in>.  
   
  my @arr = $webpac->fill_in_to_arr($rec,'[v900];;[v250^a]','paste');  
273    
274  =cut  =cut
275    
276  sub _rec_to_arr {  sub rec2 {
277          my $self = shift;          my $f = shift;
278            return unless (defined($rec && $rec->{$f}));
279          my ($rec, $format_utf8, $code) = @_;          my $sf = shift;
280            return map { $_->{$sf} } grep { ref($_) eq 'HASH' && $_->{$sf} } @{ $rec->{$f} };
281    }
282    
283          my $log = $self->_get_logger();  =head2 rec
284    
285          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);  syntaxtic sugar for
         return if (! $format_utf8);  
286    
287          $log->debug("using $code on $format_utf8");    @v = rec('200')
288      @v = rec('200','a')
289    
290          my $i = 0;  =cut
         my $max = 0;  
         my @arr;  
         my $rec_size = {};  
291    
292          while ($i <= $max) {  sub rec {
293                  my @v = $self->$code($rec,$format_utf8,$i++,\$rec_size);          if ($#_ == 0) {
294                  if ($rec_size) {                  return rec1(@_);
295                          foreach my $f (keys %{ $rec_size }) {          } elsif ($#_ == 1) {
296                                  $max = $rec_size->{$f} if ($rec_size->{$f} > $max);                  return rec2(@_);
                         }  
                         $log->debug("max set to $max");  
                         undef $rec_size;  
                 }  
                 if (@v) {  
                         push @arr, @v;  
                 } else {  
                         push @arr, '' if ($max > $i);  
                 }  
297          }          }
   
         $log->debug("format '$format_utf8' returned ",--$i," elements: ", sub { join(" | ",@arr) }) if (@arr);  
   
         return @arr;  
298  }  }
299    
300    =head2 regex
301    
302  =head2 get_data  Apply regex to some or all values
   
 Returns value from record.  
   
  my $text = $self->get_data(\$rec,$f,$sf,$i,\$found,\$rec_size);  
   
 Required arguments are:  
   
 =over 8  
   
 =item C<$rec>  
   
 record reference  
   
 =item C<$f>  
   
 field  
   
 =item C<$sf>  
   
 optional subfield  
   
 =item C<$i>  
303    
304  index offset for repeatable values ( 0 ... $rec_size->{'400^a'} )    @v = regex( 's/foo/bar/g', @v );
   
 =item C<$found>  
   
 optional variable that will be incremeted if preset  
   
 =item C<$rec_size>  
   
 hash to hold maximum occurances of C<field^subfield> combinations  
 (which can be accessed using keys in same format)  
   
 =back  
   
 Returns value or empty string, updates C<$found> and C<rec_size>  
 if present.  
305    
306  =cut  =cut
307    
308  sub get_data {  sub regex {
309          my $self = shift;          my $r = shift;
310            my @out;
311          my ($rec,$f,$sf,$i,$found,$cache) = @_;          #warn "r: $r\n",Dumper(\@_);
312            foreach my $t (@_) {
313          return '' unless ($$rec->{$f} && ref($$rec->{$f}) eq 'ARRAY');                  next unless ($t);
314                    eval "\$t =~ $r";
315          if (defined($$cache)) {                  push @out, $t if ($t && $t ne '');
                 $$cache->{ $f . ( $sf ? '^' . $sf : '' ) } ||= scalar @{ $$rec->{$f} };  
         }  
   
         return '' unless ($$rec->{$f}->[$i]);  
   
         {  
                 no strict 'refs';  
                 if (defined($sf)) {  
                         $$found++ if (defined($$found) && $$rec->{$f}->[$i]->{$sf});  
                         return $$rec->{$f}->[$i]->{$sf};  
                 } else {  
                         $$found++ if (defined($$found));  
                         # it still might have subfields, just  
                         # not specified, so we'll dump some debug info  
                         if ($$rec->{$f}->[$i] =~ /HASH/o) {  
                                 my $out;  
                                 foreach my $k (keys %{$$rec->{$f}->[$i]}) {  
                                         $out .= '$' . $k .':' . $$rec->{$f}->[$i]->{$k}." ";  
                                 }  
                                 return $out;  
                         } else {  
                                 return $$rec->{$f}->[$i];  
                         }  
                 }  
316          }          }
317            return @out;
318  }  }
319    
320    =head2 prefix
321    
322  =head2 apply_format  Prefix all values with a string
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
323    
324   my $text = $webpac->apply_format($format_name,$format_delimiter,$data);    @v = prefix( 'my_', @v );
   
 Formats can contain C<lookup{...}> if you need them.  
325    
326  =cut  =cut
327    
328  sub apply_format {  sub prefix {
329          my $self = shift;          my $p = shift or die "prefix needs string as first argument";
330            return map { $p . $_ } grep { defined($_) } @_;
331          my ($name,$delimiter,$data) = @_;  }
   
         my $log = $self->_get_logger();  
   
         if (! $self->{'import_xml'}->{'format'}->{$name}) {  
                 $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});  
                 return $data;  
         }  
   
         $log->warn("no delimiter for format $name") if (! $delimiter);  
332    
333          my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  =head2 suffix
334    
335          my @data = split(/\Q$delimiter\E/, $data);  suffix all values with a string
336    
337          my $out = sprintf($format, @data);    @v = suffix( '_my', @v );
         $log->debug("using format $name [$format] on $data to produce: $out");  
338    
339          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {  =cut
                 return $self->{'lookup'}->lookup($out);  
         } else {  
                 return $out;  
         }  
340    
341    sub suffix {
342            my $s = shift or die "suffix needs string as first argument";
343            return map { $_ . $s } grep { defined($_) } @_;
344  }  }
345    
346  =head2 sort_arr  =head2 surround
347    
348  Sort array ignoring case and html in data  surround all values with a two strings
349    
350   my @sorted = $webpac->sort_arr(@unsorted);    @v = surround( 'prefix_', '_suffix', @v );
351    
352  =cut  =cut
353    
354  sub sort_arr {  sub surround {
355          my $self = shift;          my $p = shift or die "surround need prefix as first argument";
356            my $s = shift or die "surround needs suffix as second argument";
357          my $log = $self->_get_logger();          return map { $p . $_ . $s } grep { defined($_) } @_;
   
         # FIXME add Schwartzian Transformation?  
   
         my @sorted = sort {  
                 $a =~ s#<[^>]+/*>##;  
                 $b =~ s#<[^>]+/*>##;  
                 lc($b) cmp lc($a)  
         } @_;  
         $log->debug("sorted values: ",sub { join(", ",@sorted) });  
   
         return @sorted;  
358  }  }
359    
360    =head2 first
361    
362  =head1 INTERNAL METHODS  Return first element
   
 =head2 _sort_by_order  
363    
364  Sort xml tags data structure accoding to C<order=""> attribute.    $v = first( @v );
365    
366  =cut  =cut
367    
368  sub _sort_by_order {  sub first {
369          my $self = shift;          my $r = shift;
370            return $r;
         my $va = $self->{'import_xml'}->{'indexer'}->{$a}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$a};  
         my $vb = $self->{'import_xml'}->{'indexer'}->{$b}->{'order'} ||  
                 $self->{'import_xml'}->{'indexer'}->{$b};  
   
         return $va <=> $vb;  
371  }  }
372    
373  =head2 _x  =head2 lookup
   
 Convert strings from C<conf/normalize/*.xml> encoding into application  
 specific encoding (optinally specified using C<code_page> to C<new>  
 constructor).  
374    
375   my $text = $n->_x('normalize text string');  Consult lookup hashes for some value
376    
377  This is a stub so that other modules doesn't have to implement it.    @v = lookup( $v );
378      @v = lookup( @v );
379    
380  =cut  =cut
381    
382  sub _x {  sub lookup {
383          my $self = shift;          my $k = shift or return;
384          return shift;          return unless (defined($lookup->{$k}));
385            if (ref($lookup->{$k}) eq 'ARRAY') {
386                    return @{ $lookup->{$k} };
387            } else {
388                    return $lookup->{$k};
389            }
390  }  }
391    
392    =head2 join_with
393    
394  =head1 AUTHOR  Joins walues with some delimiter
395    
396  Dobrica Pavlinusic, C<< <dpavlin@rot13.org> >>    $v = join_with(", ", @v);
   
 =head1 COPYRIGHT & LICENSE  
   
 Copyright 2005 Dobrica Pavlinusic, All Rights Reserved.  
   
 This program is free software; you can redistribute it and/or modify it  
 under the same terms as Perl itself.  
397    
398  =cut  =cut
399    
400  1; # End of WebPAC::Normalize  sub join_with {
401            my $d = shift;
402            return join($d, grep { defined($_) && $_ ne '' } @_);
403    }
404    
405    # END
406    1;

Legend:
Removed from v.397  
changed lines
  Added in v.541

  ViewVC Help
Powered by ViewVC 1.1.26