/[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 14 by dpavlin, Sun Jul 17 00:04:25 2005 UTC revision 125 by dpavlin, Thu Nov 24 11:47:15 2005 UTC
# Line 2  package WebPAC::Normalize; Line 2  package WebPAC::Normalize;
2    
3  use warnings;  use warnings;
4  use strict;  use strict;
5    use base 'WebPAC::Common';
6  use Data::Dumper;  use Data::Dumper;
 use Storable;  
7    
8  =head1 NAME  =head1 NAME
9    
10  WebPAC::Normalize - normalisation of source file  WebPAC::Normalize - data mungling for normalisation
11    
12  =head1 VERSION  =head1 VERSION
13    
14  Version 0.01  Version 0.02
15    
16  =cut  =cut
17    
18  our $VERSION = '0.01';  our $VERSION = '0.02';
19    
20  =head1 SYNOPSIS  =head1 SYNOPSIS
21    
22  This package contains code that could be helpful in implementing different  This package contains code that mungle data to produce normalized format.
23  normalisation front-ends.  
24    It contains several assumptions:
25    
26    =over
27    
28    =item *
29    
30    format of fields is defined using C<v123^a> notation for repeatable fields
31    or C<s123^a> for single (or first) value, where C<123> is field number and
32    C<a> is subfield.
33    
34    =item *
35    
36    source data records (C<$rec>) have unique identifiers in field C<000>
37    
38    =item *
39    
40    optional C<eval{length('v123^a') == 3}> tag at B<beginning of format> will be
41    perl code that is evaluated before producing output (value of field will be
42    interpolated before that)
43    
44    =item *
45    
46    optional C<filter{filter_name}> at B<begining of format> will apply perl
47    code defined as code ref on format after field substitution to producing
48    output
49    
50    =item *
51    
52    optional C<lookup{...}> will be then performed. See C<WebPAC::Lookups>.
53    
54    =item *
55    
56    at end, optional C<format>s rules are resolved. Format rules are similar to
57    C<sprintf> and can also contain C<lookup{...}> which is performed after
58    values are inserted in format.
59    
60    =back
61    
62    This also describes order in which transformations are applied (eval,
63    filter, lookup, format) which is important to undestand when deciding how to
64    solve your data mungling and normalisation process.
65    
66    
67    
68    
69  =head1 FUNCTIONS  =head1 FUNCTIONS
70    
# Line 29  normalisation front-ends. Line 73  normalisation front-ends.
73  Create new normalisation object  Create new normalisation object
74    
75    my $n = new WebPAC::Normalize::Something(    my $n = new WebPAC::Normalize::Something(
76          cache_data_structure => './cache/ds/',          filter => {
77                    'filter_name_1' => sub {
78                            # filter code
79                            return length($_);
80                    }, ...
81            },
82            db => $db_obj,
83          lookup_regex => $lookup->regex,          lookup_regex => $lookup->regex,
84            lookup => $lookup_obj,
85    );    );
86    
87  Optional parameter C<cache_data_structure> defines path to directory  Parametar C<filter> defines user supplied snippets of perl code which can
88  in which cache file for C<data_structure> call will be created.  be use with C<filter{...}> notation.
89    
90  Recommended parametar C<lookup_regex> is used to enable parsing of lookups  Recommended parametar C<lookup_regex> is used to enable parsing of lookups
91  in structures.  in structures. If you pass this parametar, you must also pass C<lookup>
92    which is C<WebPAC::Lookup> object.
93    
94  =cut  =cut
95    
# Line 46  sub new { Line 98  sub new {
98          my $self = {@_};          my $self = {@_};
99          bless($self, $class);          bless($self, $class);
100    
101          $self->setup_cache_dir( $self->{'cache_data_structure'} );          my $r = $self->{'lookup_regex'} ? 1 : 0;
102            my $l = $self->{'lookup'} ? 1 : 0;
         $self ? return $self : return undef;  
 }  
   
 =head2 setup_cache_dir  
   
 Check if specified cache directory exist, and if not, disable caching.  
   
  $setup_cache_dir('./cache/ds/');  
   
 If you pass false or zero value to this function, it will disable  
 cacheing.  
   
 =cut  
   
 sub setup_cache_dir {  
         my $self = shift;  
   
         my $dir = shift;  
103    
104          my $log = $self->_get_logger();          my $log = $self->_get_logger();
105    
106          if ($dir) {          # those two must be in pair
107                  my $msg;          if ( ($r & $l) != ($r || $l) ) {
108                  if (! -e $dir) {                  my $log = $self->_get_logger();
109                          $msg = "doesn't exist";                  $log->logdie("lookup_regex and lookup must be in pair");
                 } elsif (! -d $dir) {  
                         $msg = "is not directory";  
                 } elsif (! -w $dir) {  
                         $msg = "not writable";  
                 }  
   
                 if ($msg) {  
                         undef $self->{'cache_data_structure'};  
                         $log->warn("cache_data_structure $dir $msg, disabling...");  
                 } else {  
                         $log->debug("using cache dir $dir");  
                 }  
         } else {  
                 $log->debug("disabling cache");  
                 undef $self->{'cache_data_structure'};  
110          }          }
111    
112            $log->logdie("lookup must be WebPAC::Lookup object") if ($self->{'lookup'} && ! $self->{'lookup'}->isa('WebPAC::Lookup'));
113    
114            $self ? return $self : return undef;
115  }  }
116    
117    
# Line 99  C<conf/normalize/*.xml>. Line 122  C<conf/normalize/*.xml>.
122    
123  This structures are used to produce output.  This structures are used to produce output.
124    
125   my @ds = $webpac->data_structure($rec);   my $ds = $webpac->data_structure($rec);
   
 B<Note: historical oddity follows>  
   
 This method will also set C<< $webpac->{'currnet_filename'} >> if there is  
 C<< <filename> >> tag and C<< $webpac->{'headline'} >> if there is  
 C<< <headline> >> tag.  
126    
127  =cut  =cut
128    
# Line 117  sub data_structure { Line 134  sub data_structure {
134          my $rec = shift;          my $rec = shift;
135          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);          $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);
136    
137            $log->debug("data_structure rec = ", sub { Dumper($rec) });
138    
139            $log->logdie("need unique ID (mfn) in field 000 of record ", sub { Dumper($rec) } ) unless (defined($rec->{'000'}));
140    
141            my $mfn = $rec->{'000'}->[0] || $log->logdie("field 000 isn't array!");
142    
143          my $cache_file;          my $cache_file;
144    
145          if (my $cache_path = $self->{'cache_data_structure'}) {          if ($self->{'db'}) {
146                  my $id = $rec->{'000'};                  my $ds = $self->{'db'}->load_ds( $mfn );
147                  $id = $rec->{'000'}->[0] if ($id =~ m/^ARRAY/o);                  $log->debug("load_ds( rec = ", sub { Dumper($rec) }, ") = ", sub { Dumper($ds) });
148                  unless (defined($id)) {                  return $ds if ($ds);
149                          $log->warn("Can't use cache_data_structure on records without unique identifier in field 000");                  $log->debug("cache miss, creating");
                         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'};  
                                         }  
                                 }  
                         }  
                 }  
150          }          }
151    
152          undef $self->{'currnet_filename'};          undef $self->{'currnet_filename'};
# Line 161  sub data_structure { Line 160  sub data_structure {
160                  $self->{tags_by_order} = \@sorted_tags;                  $self->{tags_by_order} = \@sorted_tags;
161          }          }
162    
163          my @ds;          my $ds;
164    
165          $log->debug("tags: ",sub { join(", ",@sorted_tags) });          $log->debug("tags: ",sub { join(", ",@sorted_tags) });
166    
# Line 172  sub data_structure { Line 171  sub data_structure {
171  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});  #print "field $field [",$self->{'tag'},"] = ",Dumper($self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}});
172    
173                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {                  foreach my $tag (@{$self->{'import_xml'}->{'indexer'}->{$field}->{$self->{'tag'}}}) {
174                          my $format = $tag->{'value'} || $tag->{'content'};                          my $format;
175    
176                            $log->logdie("expected tag HASH and got $tag") unless (ref($tag) eq 'HASH');
177                            $format = $tag->{'value'} || $tag->{'content'};
178    
179                          $log->debug("format: $format");                          $log->debug("format: $format");
180    
# Line 193  sub data_structure { Line 195  sub data_structure {
195                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;                                  @v = map { $self->apply_format($tag->{'format_name'},$tag->{'format_delimiter'},$_) } @v;
196                          }                          }
197    
                         if ($field eq 'filename') {  
                                 $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!  
                         }  
   
198                          # delimiter will join repeatable fields                          # delimiter will join repeatable fields
199                          if ($tag->{'delimiter'}) {                          if ($tag->{'delimiter'}) {
200                                  @v = ( join($tag->{'delimiter'}, @v) );                                  @v = ( join($tag->{'delimiter'}, @v) );
201                          }                          }
202    
203                          # default types                          # default types
204                          my @types = qw(display swish);                          my @types = qw(display search);
205                          # override by type attribute                          # override by type attribute
206                          @types = ( $tag->{'type'} ) if ($tag->{'type'});                          @types = ( $tag->{'type'} ) if ($tag->{'type'});
207    
# Line 241  sub data_structure { Line 234  sub data_structure {
234    
235                          # TODO: name_sigular, name_plural                          # TODO: name_sigular, name_plural
236                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};                          my $name = $self->{'import_xml'}->{'indexer'}->{$field}->{'name'};
237                          $row->{'name'} = $name ? $self->_x($name) : $field;                          my $row_name = $name ? $self->_x($name) : $field;
238    
239                          # post-sort all values in field                          # post-sort all values in field
240                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {                          if ($self->{'import_xml'}->{'indexer'}->{$field}->{'sort'}) {
241                                  $log->warn("sort at field tag not implemented");                                  $log->warn("sort at field tag not implemented");
242                          }                          }
243    
244                          push @ds, $row;                          $ds->{$row_name} = $row;
245    
246                          $log->debug("row $field: ",sub { Dumper($row) });                          $log->debug("row $field: ",sub { Dumper($row) });
247                  }                  }
248    
249          }          }
250    
251          if ($cache_file) {          $self->{'db'}->save_ds(
252                  store {                  id => $mfn,
253                          ds => \@ds,                  ds => $ds,
254                          current_filename => $self->{'current_filename'},          ) if ($self->{'db'});
                         headline => $self->{'headline'},  
                 }, $cache_file;  
                 $log->debug("created storable cache file $cache_file");  
         }  
   
         return @ds;  
   
 }  
   
 =head2 apply_format  
   
 Apply format specified in tag with C<format_name="name"> and  
 C<format_delimiter=";;">.  
   
  my $text = $webpac->apply_format($format_name,$format_delimiter,$data);  
   
 Formats can contain C<lookup{...}> if you need them.  
   
 =cut  
   
 sub apply_format {  
         my $self = shift;  
   
         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);  
   
         my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");  
255    
256          my @data = split(/\Q$delimiter\E/, $data);          $log->debug("ds: ", sub { Dumper($ds) });
257    
258          my $out = sprintf($format, @data);          $log->logconfess("data structure returned is not array any more!") if wantarray;
         $log->debug("using format $name [$format] on $data to produce: $out");  
259    
260          if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {          return $ds;
                 return $self->lookup($out);  
         } else {  
                 return $out;  
         }  
261    
262  }  }
263    
# Line 427  sub parse_to_arr { Line 380  sub parse_to_arr {
380          return @arr;          return @arr;
381  }  }
382    
383    
384    =head2 fill_in
385    
386    Workhourse of all: takes record from in-memory structure of database and
387    strings with placeholders and returns string or array of with substituted
388    values from record.
389    
390     my $text = $webpac->fill_in($rec,'v250^a');
391    
392    Optional argument is ordinal number for repeatable fields. By default,
393    it's assume to be first repeatable field (fields are perl array, so first
394    element is 0).
395    Following example will read second value from repeatable field.
396    
397     my $text = $webpac->fill_in($rec,'Title: v250^a',1);
398    
399    This function B<does not> perform parsing of format to inteligenty skip
400    delimiters before fields which aren't used.
401    
402    This method will automatically decode UTF-8 string to local code page
403    if needed.
404    
405    =cut
406    
407    sub fill_in {
408            my $self = shift;
409    
410            my $log = $self->_get_logger();
411    
412            my $rec = shift || $log->logconfess("need data record");
413            my $format = shift || $log->logconfess("need format to parse");
414            # iteration (for repeatable fields)
415            my $i = shift || 0;
416    
417            $log->logdie("infitite loop in format $format") if ($i > ($self->{'max_mfn'} || 9999));
418    
419            # FIXME remove for speedup?
420            $log->logconfess("need HASH as first argument!") if ($rec !~ /HASH/o);
421    
422            if (utf8::is_utf8($format)) {
423                    $format = $self->_x($format);
424            }
425    
426            my $found = 0;
427    
428            my $eval_code;
429            # remove eval{...} from beginning
430            $eval_code = $1 if ($format =~ s/^eval{([^}]+)}//s);
431    
432            my $filter_name;
433            # remove filter{...} from beginning
434            $filter_name = $1 if ($format =~ s/^filter{([^}]+)}//s);
435    
436            # do actual replacement of placeholders
437            # repeatable fields
438            $format =~ s/v(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,$i,\$found)/ges;
439            # non-repeatable fields
440            $format =~ s/s(\d+)(?:\^(\w))?/$self->get_data(\$rec,$1,$2,0,\$found)/ges;
441    
442            if ($found) {
443                    $log->debug("format: $format");
444                    if ($eval_code) {
445                            my $eval = $self->fill_in($rec,$eval_code,$i);
446                            return if (! $self->_eval($eval));
447                    }
448                    if ($filter_name && $self->{'filter'}->{$filter_name}) {
449                            $log->debug("filter '$filter_name' for $format");
450                            $format = $self->{'filter'}->{$filter_name}->($format);
451                            return unless(defined($format));
452                            $log->debug("filter result: $format");
453                    }
454                    # do we have lookups?
455                    if ($self->{'lookup'}) {
456                            if ($self->{'lookup'}->can('lookup')) {
457                                    return $self->{'lookup'}->lookup($format);
458                            } else {
459                                    $log->warn("Have lookup object but can't invoke lookup method");
460                            }
461                    } else {
462                            return $format;
463                    }
464            } else {
465                    return;
466            }
467    }
468    
469    
470  =head2 fill_in_to_arr  =head2 fill_in_to_arr
471    
472  Similar to C<fill_in>, but returns array of all repeatable fields. Usable  Similar to C<fill_in>, but returns array of all repeatable fields. Usable
# Line 459  sub fill_in_to_arr { Line 499  sub fill_in_to_arr {
499          return @arr;          return @arr;
500  }  }
501    
502    
503    =head2 get_data
504    
505    Returns value from record.
506    
507     my $text = $self->get_data(\$rec,$f,$sf,$i,\$found);
508    
509    Arguments are:
510    record reference C<$rec>,
511    field C<$f>,
512    optional subfiled C<$sf>,
513    index for repeatable values C<$i>.
514    
515    Optinal variable C<$found> will be incremeted if there
516    is field.
517    
518    Returns value or empty string.
519    
520    =cut
521    
522    sub get_data {
523            my $self = shift;
524    
525            my ($rec,$f,$sf,$i,$found) = @_;
526    
527            if ($$rec->{$f}) {
528                    return '' if (! $$rec->{$f}->[$i]);
529                    no strict 'refs';
530                    if ($sf && $$rec->{$f}->[$i]->{$sf}) {
531                            $$found++ if (defined($$found));
532                            return $$rec->{$f}->[$i]->{$sf};
533                    } elsif (! $sf && $$rec->{$f}->[$i]) {
534                            $$found++ if (defined($$found));
535                            # it still might have subfield, just
536                            # not specified, so we'll dump all
537                            if ($$rec->{$f}->[$i] =~ /HASH/o) {
538                                    my $out;
539                                    foreach my $k (keys %{$$rec->{$f}->[$i]}) {
540                                            $out .= $$rec->{$f}->[$i]->{$k}." ";
541                                    }
542                                    return $out;
543                            } else {
544                                    return $$rec->{$f}->[$i];
545                            }
546                    } else {
547                            return '';
548                    }
549            } else {
550                    return '';
551            }
552    }
553    
554    
555    =head2 apply_format
556    
557    Apply format specified in tag with C<format_name="name"> and
558    C<format_delimiter=";;">.
559    
560     my $text = $webpac->apply_format($format_name,$format_delimiter,$data);
561    
562    Formats can contain C<lookup{...}> if you need them.
563    
564    =cut
565    
566    sub apply_format {
567            my $self = shift;
568    
569            my ($name,$delimiter,$data) = @_;
570    
571            my $log = $self->_get_logger();
572    
573            if (! $self->{'import_xml'}->{'format'}->{$name}) {
574                    $log->warn("<format name=\"$name\"> is not defined in ",$self->{'import_xml_file'});
575                    return $data;
576            }
577    
578            $log->warn("no delimiter for format $name") if (! $delimiter);
579    
580            my $format = $self->_x($self->{'import_xml'}->{'format'}->{$name}->{'content'}) || $log->logdie("can't find format '$name'");
581    
582            my @data = split(/\Q$delimiter\E/, $data);
583    
584            my $out = sprintf($format, @data);
585            $log->debug("using format $name [$format] on $data to produce: $out");
586    
587            if ($self->{'lookup_regex'} && $out =~ $self->{'lookup_regex'}) {
588                    return $self->{'lookup'}->lookup($out);
589            } else {
590                    return $out;
591            }
592    
593    }
594    
595  =head2 sort_arr  =head2 sort_arr
596    
597  Sort array ignoring case and html in data  Sort array ignoring case and html in data
# Line 485  sub sort_arr { Line 618  sub sort_arr {
618  }  }
619    
620    
621    =head1 INTERNAL METHODS
622    
623  =head2 _sort_by_order  =head2 _sort_by_order
624    
625  Sort xml tags data structure accoding to C<order=""> attribute.  Sort xml tags data structure accoding to C<order=""> attribute.
# Line 504  sub _sort_by_order { Line 639  sub _sort_by_order {
639    
640  =head2 _x  =head2 _x
641    
642  Convert strings from C<conf/normalize> encoding into application specific  Convert strings from C<conf/normalize/*.xml> encoding into application
643  (optinally specified using C<code_page> to C<new> constructor.  specific encoding (optinally specified using C<code_page> to C<new>
644    constructor).
645    
646   my $text = $n->_x('normalize text string');   my $text = $n->_x('normalize text string');
647    

Legend:
Removed from v.14  
changed lines
  Added in v.125

  ViewVC Help
Powered by ViewVC 1.1.26