invalidate memory cache when needed
[webpac] / all2xml.pl
index 76009de..13cec21 100755 (executable)
@@ -9,6 +9,9 @@ use Text::Unaccent 1.02;        # 1.01 won't compile on my platform,
 use Text::Iconv;
 use Config::IniFiles;
 use Encode;
+#use GDBM_File;
+use Fcntl;     # for O_RDWR
+use TDB_File;
 
 $|=1;
 
@@ -61,6 +64,14 @@ my %type2tag = (
        'feed' => 'feed'
 );
 
+my $cache;     # for cacheing
+
+# lookup hash (tied to file)
+my %lhash;
+# this option will cache all lookup entries in memory.
+# if you are tight on memory, turn this off
+my $use_lhash_cache = 1;
+
 sub data2xml {
 
        use xmlify;
@@ -90,7 +101,48 @@ sub data2xml {
                return $va <=> $vb;
        }
 
-       foreach my $field (sort by_order keys %{$config->{indexer}}) {
+       my @sorted_tags;
+       if ($cache->{tags_by_order}) {
+               @sorted_tags = @{$cache->{tags_by_order}};
+       } else {
+               @sorted_tags = sort by_order keys %{$config->{indexer}};
+               $cache->{tags_by_order} = \@sorted_tags;
+       }
+
+       # lookup key
+       my $lookup_key;
+
+       # cache for field in pages
+       delete $cache->{display_data};
+       delete $cache->{swish_data};
+       delete $cache->{swish_exact_data};
+       my @page_fields;        # names of fields
+
+
+       # subs used to produce output
+
+       sub get_field_name($$$) {
+               my ($config,$field,$field_usage) = @_;
+
+               # find field name (signular, plural)
+               my $field_name = "";
+               if ($config->{indexer}->{$field}->{name_singular} && $field_usage == 1) {
+                       $field_name = $config->{indexer}->{$field}->{name_singular};
+               } elsif ($config->{indexer}->{$field}->{name_plural}) {
+                       $field_name = $config->{indexer}->{$field}->{name_plural};
+               } elsif ($config->{indexer}->{$field}->{name}) {
+                       $field_name = $config->{indexer}->{$field}->{name};
+               } else {
+                       print STDERR "WARNING: field '$field' doesn't have 'name' attribute!";
+               }
+               if ($field_name) {
+                       return x($field_name);
+               }
+       }
+
+
+       # begin real work: go field by field
+       foreach my $field (@sorted_tags) {
 
                $field=x($field);
                $field_usage{$field}++;
@@ -103,18 +155,30 @@ sub data2xml {
                my ($swish,$display);
 
                my $tag = $type2tag{$type} || die "can't find which tag to use for type $type";
+
+               # is this field page-by-page?
+               my $iterate_by_page = $config->{indexer}->{$field}->{iterate_by_page};
+               push @page_fields,$field if ($iterate_by_page);
+               my %page_max = ();
+               # default line_delimiter if using
+               my $page_line_delimiter = $config->{indexer}->{$field}->{page_line_delimiter} || '<br/>';
+
                foreach my $x (@{$config->{indexer}->{$field}->{$tag}}) {
 
                        my $format = x($x->{content});
                        my $delimiter = x($x->{delimiter}) || ' ';
 
-                       my $repeat_off = 0;             # repeatable offset
+                       my $repeat_off = 0;     # init repeatable offset
 
-                       my ($s,$se,$d,$i) = (1,0,1,0);  # swish, display default
+                       # swish, swish_exact, display, index, index_lookup
+                       # swish and display defaults
+                       my ($s,$se,$d,$i,$il) = (1,0,1,0,0);
                        $s = 0 if (lc($x->{type}) eq "display");
                        $d = 0 if (lc($x->{type}) eq "swish");
                        $se = 1 if (lc($x->{type}) eq "swish_exact");
                        ($s,$d,$i) = (0,0,1) if (lc($x->{type}) eq "index");
+                       $il = 1 if (lc($x->{type}) =~ /^lookup/);
+
 
                        # what will separate last line from this one?
                        if ($display_data && $x->{append} && $x->{append} eq "1") {
@@ -128,7 +192,6 @@ sub data2xml {
 
                        # placeholder for all repeatable entries for index
                        my @index_data;
-                       my $index_filter;
 
                        sub mkformat {
                                my $x = shift || die "mkformat needs tag reference";
@@ -158,17 +221,43 @@ sub data2xml {
 
                        # while because of repeatable fields
                        while ($swish || $display) {
+                               my $page = $repeat_off;
+                               $page_max{$field} = $page if ($iterate_by_page && $page > ($page_max{$field} || 0));
                                ($swish,$display) = parse_format($type, $format,$row,$repeat_off++,$import2cp);
                                if ($repeat_off > 1000) {
                                        print STDERR "loop (more than 1000 repeatable fields) deteced in $row, $format\n";
                                        last;
                                }
-                               
+
+                               # is this field is lookup?
+                               if ($display && $x->{lookup}) {
+                                       my $null = "<!-- null -->";
+                                       if ($use_lhash_cache) {
+                                               if (!defined($cache->{lhash}->{$display})) {
+                                                       my $new_display = $lhash{$display};
+                                                       if (defined($new_display)) {
+#print STDERR "lookup cache store '$display' = '$new_display'\n";
+                                                               $display = $new_display;
+                                                               $cache->{lhash}->{$display} = $new_display;
+                                                       } else {
+                                                               print STDERR "WARNING: lookup for '$display' didn't find anything.\n";
+                                                               $display = "";
+                                                               $cache->{lhash}->{$display} = $null;
+                                                       }
+                                               } else {
+                                                       $display = $cache->{lhash}->{$display};
+                                               }
+                                       } else {
+                                               $display = $lhash{$display} || $null;
+                                       }
+                               }
+
                                # filter="name" ; filter this field through
                                # filter/[name].pm
                                my $filter = $x->{filter};
-                               if ($filter) {
+                               if ($filter && !$cache->{filter_loaded}->{$filter}) {
                                        require "filter/".$filter.".pm";
+                                       $cache->{filter_loaded}->{$filter}++;
                                }
                                # type="swish" ; field for swish
                                if ($swish) {
@@ -188,7 +277,6 @@ sub data2xml {
                                if ($d && $display) {
                                        if ($line_delimiter && $display_data) {
                                                $display_data .= $line_delimiter;
-                                               undef $line_delimiter;
                                        }
                                        if ($filter) {
                                                no strict 'refs';
@@ -208,24 +296,69 @@ sub data2xml {
                                                
                                # type="index" ; insert into index
                                if ($i && $display) {
-                                       push @index_data, $display;
-                                       $index_filter = $filter if ($filter);
+                                       if ($filter) {
+                                               no strict 'refs';
+                                               $display = &$filter($display);
+                                       }
+                                       if ($x->{append} && @index_data) {
+                                               $index_data[$#index_data].=$display;
+                                       } else {
+                                               push @index_data, $display;
+                                       }
                                }
-                       }
 
-                       # fill data in index
-                       if (@index_data) {
-                               if ($index_filter) {
-                                       no strict 'refs';
-                                       foreach my $d (@index_data) {
-                                               $index->insert($field, &$index_filter($d), $path);
+                               # store fields in lookup
+                               if ($il && $display) {
+                                       if (lc($x->{type}) eq "lookup_key") {
+                                               if ($lookup_key) {
+                                                       print STDERR "WARNING: try to redefine lookup_key (keys shouldn't be repeatable fields!)";
+                                               } else {
+                                                       $lookup_key = $display;
+                                               }
+                                       } elsif (lc($x->{type}) eq "lookup_val") {
+                                               if ($lookup_key) {
+                                                       $lhash{$lookup_key} = $display;
+                                               } else {
+                                                       print STDERR "WARNING: no lookup_key defined for  '$display'?";
+                                               }
                                        }
-                               } else {
-                                       foreach my $d (@index_data) {
-                                               $index->insert($field, $d, $path);
+
+                               }
+
+                               # store data for page-by-page repeatable fields
+                               if ($iterate_by_page) {
+                                       sub iterate_fld($$$$$$) {
+                                               my ($cache,$what,$field,$page,$data,$append) = @_;
+                                               return if (!$data);
+                                               my $line_delimiter = $page_line_delimiter;
+                                               $line_delimiter = " " if ($append);
+                                               if (! $cache->{$what}->{$field}->[$page]) {
+                                                       $cache->{$what}->{$field}->[$page] = $data;
+                                               } else {
+                                                       $cache->{$what}->{$field}->[$page] .= $line_delimiter.$data;
+                                               }
+                                       }
+
+                                       if ($display_data) {
+print STDERR "line delimiter: ",Dumper($line_delimiter) if ($line_delimiter);
+                                               iterate_fld($cache,'display_data',$field,$page,$display_data,$x->{append});
+                                       }
+                                               $display_data = "";
+                                       if ($swish_data) {
+                                               iterate_fld($cache,'swish_data',$field,$page,$swish_data,$x->{append});
+                                               $swish_data = "";
+                                       }
+                                       if ($swish_exact_data) {
+                                               iterate_fld($cache,'swish_exact_data',$field,$page,$swish_exact_data,$x->{append});
+                                               $swish_exact_data = "";
                                        }
                                }
                        }
+
+                       # fill data in index
+                       foreach my $d (@index_data) {
+                               $index->insert($field, $d, $path);
+                       }
                }
 
                # now try to parse variables from configuration file
@@ -247,50 +380,94 @@ sub data2xml {
                                $index->insert($field, $val, $path) if ($i);
                        }
 
+                       if ($iterate_by_page) {
+                               # FIXME data from config tag will appear just
+                               # on first page!!!
+                               my $page = 0;
+                               if ($display_data) {
+                                       $cache->{display_data}->{$field}->[$page] = $display_data;
+                                       $display_data = "";
+                               }
+                               if ($swish_data) {
+                                       $cache->{swish_data}->{$field}->[$page] = $swish_data;
+                                       $swish_data = "";
+                               }
+                               if ($swish_exact_data) {
+                                       $cache->{swish_exact_data}->{$field}->[$page] = $swish_exact_data;
+                                       $swish_exact_data = "";
+                               }
+                       }
                }
 
+               # save data page-by-page
+               foreach my $field (@page_fields) {
+                       my $nr_pages = $page_max{$field} || next;
+#print STDERR "field '$field' iterate over ",($nr_pages || 0)," pages...\n";
+#print STDERR Dumper($cache->{display_data});
+                       for (my $page=0; $page <= $nr_pages; $page++) {
+
+                               my $display_data = $cache->{display_data}->{$field}->[$page];
+                               if ($display_data) { # default
+                                       if ($field eq "headline") {
+                                               $xml .= xmlify("headline", $display_data);
+                                       } else {
 
-               if ($display_data) {
-
-                       if ($field eq "headline") {
-                               $xml .= xmlify("headline", $display_data);
-                       } else {
+                                               # fallback to empty field name if needed
+                                               $html .= get_field_name($config,$field,$field_usage{$field}) || '';
+                                               $html .= "#-#".$display_data."###\n";
+                                       }
+                               }
+                               
+                               my $swish_data = $cache->{swish_data}->{$field}->[$page];
+                               if ($swish_data) {
+                                       # remove extra spaces
+                                       $swish_data =~ s/ +/ /g;
+                                       $swish_data =~ s/ +$//g;
 
-                               # find field name (signular, plural)
-                               my $field_name = "";
-                               if ($config->{indexer}->{$field}->{name_singular} && $field_usage{$field} == 1) {
-                                       $field_name = $config->{indexer}->{$field}->{name_singular}."#-#";
-                               } elsif ($config->{indexer}->{$field}->{name_plural}) {
-                                       $field_name = $config->{indexer}->{$field}->{name_plural}."#-#";
-                               } elsif ($config->{indexer}->{$field}->{name}) {
-                                       $field_name = $config->{indexer}->{$field}->{name}."#-#";
-                               } else {
-                                       print STDERR "WARNING: field '$field' doesn't have 'name' attribute!";
+                                       $xml .= xmlify($field."_swish", unac_string($codepage,$swish_data));
                                }
-                               if ($field_name) {
-                                       $html .= x($field_name);
+
+                               my $swish_exact_data = $cache->{swish_exact_data}->{$field}->[$page];
+                               if ($swish_exact_data) {
+                                       $swish_exact_data =~ s/ +/ /g;
+                                       $swish_exact_data =~ s/ +$//g;
+
+                                       # add delimiters before and after word.
+                                       # That is required to produce exact match
+                                       $xml .= xmlify($field."_swish_exact", unac_string($codepage,'xxbxx '.$swish_exact_data.' xxexx'));
                                }
-                               $html .= $display_data."###\n";
                        }
+       
                }
-               if ($swish_data) {
-                       # remove extra spaces
-                       $swish_data =~ s/ +/ /g;
-                       $swish_data =~ s/ +$//g;
-
-                       $xml .= xmlify($field."_swish", unac_string($codepage,$swish_data));
-               }
+               
+               if (! $iterate_by_page) {
+                       if ($display_data) {
+                               if ($field eq "headline") {
+                                       $xml .= xmlify("headline", $display_data);
+                               } else {
 
-               if ($swish_exact_data) {
-                       $swish_exact_data =~ s/ +/ /g;
-                       $swish_exact_data =~ s/ +$//g;
+                                       # fallback to empty field name if needed
+                                       $html .= get_field_name($config,$field,$field_usage{$field}) || '';
+                                       $html .= "#-#".$display_data."###\n";
+                               }
+                       }
+                       if ($swish_data) {
+                               # remove extra spaces
+                               $swish_data =~ s/ +/ /g;
+                               $swish_data =~ s/ +$//g;
 
-                       # add delimiters before and after word.
-                       # That is required to produce exact match
-                       $xml .= xmlify($field."_swish_exact", unac_string($codepage,'xxbxx '.$swish_exact_data.' xxexx'));
-               }
+                               $xml .= xmlify($field."_swish", unac_string($codepage,$swish_data));
+                       }
 
+                       if ($swish_exact_data) {
+                               $swish_exact_data =~ s/ +/ /g;
+                               $swish_exact_data =~ s/ +$//g;
 
+                               # add delimiters before and after word.
+                               # That is required to produce exact match
+                               $xml .= xmlify($field."_swish_exact", unac_string($codepage,'xxbxx '.$swish_exact_data.' xxexx'));
+                       }
+               }
        }
 
        # dump formatted output in <html>
@@ -335,6 +512,22 @@ foreach my $database ($cfg->Sections) {
        my $type = lc($cfg -> val($database, 'type')) || die "$database doesn't have 'type' defined";
        my $add_xml = $cfg -> val($database, 'xml');    # optional
 
+       # create new lookup file
+       my $lookup_file = $cfg -> val($database, 'lookup_newfile'); # optional
+       if ($lookup_file) {
+               #tie %lhash, 'GDBM_File', $lookup_file, &GDBM_NEWDB, 0644;
+               tie %lhash, 'TDB_File', $lookup_file, TDB_CLEAR_IF_FIRST, O_RDWR, 0644;
+               print STDERR "creating lookup file '$lookup_file'\n";
+       }
+
+       # open existing lookup file
+       $lookup_file = $cfg -> val($database, 'lookup_open'); # optional
+       if ($lookup_file) {
+               #tie %lhash, 'GDBM_File', $lookup_file, &GDBM_READER, 0644;
+               tie %lhash, 'TDB_File', $lookup_file, TDB_DEFAULT, O_RDWR, 0644;
+               print STDERR "opening lookup file '$lookup_file'\n";
+       }
+
 print STDERR "reading ./import_xml/$type.xml\n";
 
        # extract just type basic
@@ -373,6 +566,9 @@ print STDERR "reading ./import_xml/$type.xml\n";
        # now read database
 print STDERR "using: $type...\n";
 
+       # erase cache for tags by order in this database
+       delete $cache->{tags_by_order};
+
        if ($type_base eq "isis") {
 
                my $isis_db = $cfg -> val($database, 'isis_db') || die "$database doesn't have 'isis_db' defined!";
@@ -585,6 +781,8 @@ print STDERR "using: $type...\n";
                        fakeprogress($i);
 
                }
+               # close lookup
+               untie %lhash if (%lhash);
        }
 }