8 use Text::Unaccent 1.02; # 1.01 won't compile on my platform,
13 use Fcntl; # for O_RDWR
19 $config_file =~ s/\.pl$/.conf/;
20 die "FATAL: can't find configuration file '$config_file'" if (! -e $config_file);
24 #use index_DBI; # default DBI module for index
25 use index_DBI_cache; # faster DBI module using memory cache
32 # -m multiple directories
36 getopts('d:m:qs', \%opts);
38 my $path; # this is name of database
40 Text::Iconv->raise_error(0); # Conversion errors don't raise exceptions
42 # this is encoding of all files on disk, including import_xml/*.xml file and
43 # filter/*.pm files! It will be used to store strings in perl internally!
44 my $codepage = 'ISO-8859-2';
46 my $utf2cp = Text::Iconv->new('UTF-8',$codepage);
47 # this function will convert data from XML files to local encoding
49 return $utf2cp->convert($_[0]);
52 # decode isis/excel or other import codepage
55 # outgoing xml must be in UTF-8
56 my $cp2utf = Text::Iconv->new($codepage,'UTF-8');
58 # mapping between data type and tag which specify
67 my $cache; # for cacheing
69 # lookup hash (tied to file)
71 # this option will cache all lookup entries in memory.
72 # if you are tight on memory, turn this off
73 my $use_lhash_cache = 1;
81 my $add_xml = shift @_;
82 # needed to read values from configuration file
84 my $database = shift @_;
90 my $html = ""; # html formatted display output
92 my %field_usage; # counter for usage of each field
94 # sort subrouting using order="" attribute
96 my $va = $config->{indexer}->{$a}->{order} ||
97 $config->{indexer}->{$a};
98 my $vb = $config->{indexer}->{$b}->{order} ||
99 $config->{indexer}->{$b};
105 if ($cache->{tags_by_order}) {
106 @sorted_tags = @{$cache->{tags_by_order}};
108 @sorted_tags = sort by_order keys %{$config->{indexer}};
109 $cache->{tags_by_order} = \@sorted_tags;
115 # cache for field in pages
116 delete $cache->{display_data};
117 delete $cache->{swish_data};
118 delete $cache->{swish_exact_data};
119 my @page_fields; # names of fields
122 # subs used to produce output
124 sub get_field_name($$$) {
125 my ($config,$field,$field_usage) = @_;
127 # find field name (signular, plural)
129 if ($config->{indexer}->{$field}->{name_singular} && $field_usage == 1) {
130 $field_name = $config->{indexer}->{$field}->{name_singular};
131 } elsif ($config->{indexer}->{$field}->{name_plural}) {
132 $field_name = $config->{indexer}->{$field}->{name_plural};
133 } elsif ($config->{indexer}->{$field}->{name}) {
134 $field_name = $config->{indexer}->{$field}->{name};
136 print STDERR "WARNING: field '$field' doesn't have 'name' attribute!";
139 return x($field_name);
144 # begin real work: go field by field
145 foreach my $field (@sorted_tags) {
148 $field_usage{$field}++;
151 my $swish_exact_data = "";
152 my $display_data = "";
155 my ($swish,$display);
157 my $tag = $type2tag{$type} || die "can't find which tag to use for type $type";
159 # is this field page-by-page?
160 my $iterate_by_page = $config->{indexer}->{$field}->{iterate_by_page};
161 push @page_fields,$field if ($iterate_by_page);
163 # default line_delimiter if using
164 my $page_line_delimiter = $config->{indexer}->{$field}->{page_line_delimiter} || '<br/>';
166 foreach my $x (@{$config->{indexer}->{$field}->{$tag}}) {
168 my $format = x($x->{content});
169 my $delimiter = x($x->{delimiter}) || ' ';
171 my $repeat_off = 0; # init repeatable offset
173 # swish, swish_exact, display, index, index_lookup
174 # swish and display defaults
175 my ($s,$se,$d,$i,$il) = (1,0,1,0,0);
176 $s = 0 if (lc($x->{type}) eq "display");
177 $d = 0 if (lc($x->{type}) eq "swish");
178 $se = 1 if (lc($x->{type}) eq "swish_exact");
179 ($s,$d,$i) = (0,0,1) if (lc($x->{type}) eq "index");
180 $il = 1 if (lc($x->{type}) =~ /^lookup/);
183 # what will separate last line from this one?
184 if ($display_data && $x->{append} && $x->{append} eq "1") {
185 $line_delimiter = ' ';
186 } elsif ($display_data) {
187 $line_delimiter = '<br/>';
190 # init vars so that we go into while...
191 ($swish,$display) = (1,1);
193 # placeholder for all repeatable entries for index
197 my $x = shift || die "mkformat needs tag reference";
198 my $data = shift || return;
199 my $format_name = x($x->{format_name}) || return $data;
200 my $fmt = x($config->{format}->{$format_name}->{content}) || die "<format name=\"$format_name\"> is not defined!";
201 my $format_delimiter = x($x->{format_delimiter});
203 if ($format_delimiter) {
204 @data = split(/$format_delimiter/,$data);
210 my $nr = scalar $fmt =~ s/%s/%s/g;
211 if (($#data+1) == $nr) {
212 return sprintf($fmt,@data);
214 print STDERR "mkformat: [$data] can't be split on [$format_delimiter] to $nr fields!\n";
218 print STDERR "usage of link '$format_name' without defined format (<link> tag)\n";
222 # while because of repeatable fields
223 while ($swish || $display) {
224 my $page = $repeat_off;
225 $page_max{$field} = $page if ($iterate_by_page && $page > ($page_max{$field} || 0));
226 ($swish,$display) = parse_format($type, $format,$row,$repeat_off++,$import2cp);
227 if ($repeat_off > 1000) {
228 print STDERR "loop (more than 1000 repeatable fields) deteced in $row, $format\n";
232 # is this field is lookup?
233 if ($display && $x->{lookup}) {
234 my $null = "<!-- null -->";
235 if ($use_lhash_cache) {
236 if (!defined($cache->{lhash}->{$display})) {
237 my $new_display = $lhash{$display};
238 if (defined($new_display)) {
239 #print STDERR "lookup cache store '$display' = '$new_display'\n";
240 $display = $new_display;
241 $cache->{lhash}->{$display} = $new_display;
243 print STDERR "WARNING: lookup for '$display' didn't find anything.\n";
245 $cache->{lhash}->{$display} = $null;
248 $display = $cache->{lhash}->{$display};
251 $display = $lhash{$display} || $null;
255 # filter="name" ; filter this field through
257 my $filter = $x->{filter};
258 if ($filter && !$cache->{filter_loaded}->{$filter}) {
259 require "filter/".$filter.".pm";
260 $cache->{filter_loaded}->{$filter}++;
262 # type="swish" ; field for swish
264 if ($filter && ($s || $se)) {
266 my $tmp = join(" ",&$filter($swish)) if ($s || $se);
267 $swish_data .= $tmp if ($s);
268 $swish_exact_data .= $tmp if ($se);
271 $swish_data .= $swish if ($s);
272 $swish_exact_data .= $swish if ($se);
276 # type="display" ; field for display
277 if ($d && $display) {
278 if ($line_delimiter && $display_data) {
279 $display_data .= $line_delimiter;
284 $display_data .= $delimiter.join($delimiter,mkformat($x,&$filter($display)));
286 $display_data = join($delimiter,mkformat($x,&$filter($display)));
290 $display_data .= $delimiter.mkformat($x,$display);
292 $display_data = mkformat($x,$display);
297 # type="index" ; insert into index
298 if ($i && $display) {
301 $display = &$filter($display);
303 if ($x->{append} && @index_data) {
304 $index_data[$#index_data].=$display;
306 push @index_data, $display;
310 # store fields in lookup
311 if ($il && $display) {
312 if (lc($x->{type}) eq "lookup_key") {
314 print STDERR "WARNING: try to redefine lookup_key (keys shouldn't be repeatable fields!)";
316 $lookup_key = $display;
318 } elsif (lc($x->{type}) eq "lookup_val") {
320 $lhash{$lookup_key} = $display;
322 print STDERR "WARNING: no lookup_key defined for '$display'?";
328 # store data for page-by-page repeatable fields
329 if ($iterate_by_page) {
330 sub iterate_fld($$$$$$) {
331 my ($cache,$what,$field,$page,$data,$append) = @_;
333 my $line_delimiter = $page_line_delimiter;
334 $line_delimiter = " " if ($append);
335 if (! $cache->{$what}->{$field}->[$page]) {
336 $cache->{$what}->{$field}->[$page] = $data;
338 $cache->{$what}->{$field}->[$page] .= $line_delimiter.$data;
343 print STDERR "line delimiter: ",Dumper($line_delimiter) if ($line_delimiter);
344 iterate_fld($cache,'display_data',$field,$page,$display_data,$x->{append});
348 iterate_fld($cache,'swish_data',$field,$page,$swish_data,$x->{append});
351 if ($swish_exact_data) {
352 iterate_fld($cache,'swish_exact_data',$field,$page,$swish_exact_data,$x->{append});
353 $swish_exact_data = "";
359 foreach my $d (@index_data) {
360 $index->insert($field, $d, $path);
364 # now try to parse variables from configuration file
365 foreach my $x (@{$config->{indexer}->{$field}->{'config'}}) {
367 my $delimiter = x($x->{delimiter}) || ' ';
368 my $val = $cfg->val($database, x($x->{content}));
370 my ($s,$d,$i) = (1,1,0); # swish, display default
371 $s = 0 if (lc($x->{type}) eq "display");
372 $d = 0 if (lc($x->{type}) eq "swish");
373 # no support for swish exact in config.
375 ($s,$d,$i) = (0,0,1) if (lc($x->{type}) eq "index");
378 $display_data .= $delimiter.$val if ($d);
379 $swish_data .= $val if ($s);
380 $index->insert($field, $val, $path) if ($i);
383 if ($iterate_by_page) {
384 # FIXME data from config tag will appear just
388 $cache->{display_data}->{$field}->[$page] = $display_data;
392 $cache->{swish_data}->{$field}->[$page] = $swish_data;
395 if ($swish_exact_data) {
396 $cache->{swish_exact_data}->{$field}->[$page] = $swish_exact_data;
397 $swish_exact_data = "";
402 # save data page-by-page
403 foreach my $field (@page_fields) {
404 my $nr_pages = $page_max{$field} || next;
405 #print STDERR "field '$field' iterate over ",($nr_pages || 0)," pages...\n";
406 #print STDERR Dumper($cache->{display_data});
407 for (my $page=0; $page <= $nr_pages; $page++) {
409 my $display_data = $cache->{display_data}->{$field}->[$page];
410 if ($display_data) { # default
411 if ($field eq "headline") {
412 $xml .= xmlify("headline", $display_data);
415 # fallback to empty field name if needed
416 $html .= get_field_name($config,$field,$field_usage{$field}) || '';
417 $html .= "#-#".$display_data."###\n";
421 my $swish_data = $cache->{swish_data}->{$field}->[$page];
423 # remove extra spaces
424 $swish_data =~ s/ +/ /g;
425 $swish_data =~ s/ +$//g;
427 $xml .= xmlify($field."_swish", unac_string($codepage,$swish_data));
430 my $swish_exact_data = $cache->{swish_exact_data}->{$field}->[$page];
431 if ($swish_exact_data) {
432 $swish_exact_data =~ s/ +/ /g;
433 $swish_exact_data =~ s/ +$//g;
435 # add delimiters before and after word.
436 # That is required to produce exact match
437 $xml .= xmlify($field."_swish_exact", unac_string($codepage,'xxbxx '.$swish_exact_data.' xxexx'));
443 if (! $iterate_by_page) {
445 if ($field eq "headline") {
446 $xml .= xmlify("headline", $display_data);
449 # fallback to empty field name if needed
450 $html .= get_field_name($config,$field,$field_usage{$field}) || '';
451 $html .= "#-#".$display_data."###\n";
455 # remove extra spaces
456 $swish_data =~ s/ +/ /g;
457 $swish_data =~ s/ +$//g;
459 $xml .= xmlify($field."_swish", unac_string($codepage,$swish_data));
462 if ($swish_exact_data) {
463 $swish_exact_data =~ s/ +/ /g;
464 $swish_exact_data =~ s/ +$//g;
466 # add delimiters before and after word.
467 # That is required to produce exact match
468 $xml .= xmlify($field."_swish_exact", unac_string($codepage,'xxbxx '.$swish_exact_data.' xxexx'));
473 # dump formatted output in <html>
475 #$xml .= xmlify("html",$html);
476 $xml .= "<html><![CDATA[ $html ]]></html>";
480 $xml .= $add_xml if ($add_xml);
481 return "<xml>\n$xml</xml>\n";
487 ##########################################################################
489 # read configuration for this script
490 my $cfg = new Config::IniFiles( -file => $config_file );
492 # read global.conf configuration
493 my $cfg_global = new Config::IniFiles( -file => 'global.conf' );
496 $index = new index_DBI(
497 $cfg_global->val('global', 'dbi_dbd'),
498 $cfg_global->val('global', 'dbi_dsn'),
499 $cfg_global->val('global', 'dbi_user'),
500 $cfg_global->val('global', 'dbi_passwd') || '',
503 my $show_progress = $cfg_global->val('global', 'show_progress');
505 my $unac_filter = $cfg_global->val('global', 'unac_filter');
507 require $unac_filter;
510 foreach my $database ($cfg->Sections) {
512 my $type = lc($cfg -> val($database, 'type')) || die "$database doesn't have 'type' defined";
513 my $add_xml = $cfg -> val($database, 'xml'); # optional
515 # create new lookup file
516 my $lookup_file = $cfg -> val($database, 'lookup_newfile'); # optional
518 #tie %lhash, 'GDBM_File', $lookup_file, &GDBM_NEWDB, 0644;
519 tie %lhash, 'TDB_File', $lookup_file, TDB_CLEAR_IF_FIRST, O_RDWR, 0644;
520 print STDERR "creating lookup file '$lookup_file'\n";
523 # open existing lookup file
524 $lookup_file = $cfg -> val($database, 'lookup_open'); # optional
526 #tie %lhash, 'GDBM_File', $lookup_file, &GDBM_READER, 0644;
527 tie %lhash, 'TDB_File', $lookup_file, TDB_DEFAULT, O_RDWR, 0644;
528 print STDERR "opening lookup file '$lookup_file'\n";
531 print STDERR "reading ./import_xml/$type.xml\n";
533 # extract just type basic
534 my $type_base = $type;
535 $type_base =~ s/_.+$//g;
537 $config=XMLin("./import_xml/$type.xml", forcearray => [ $type2tag{$type_base}, 'config', 'format' ], forcecontent => 1);
539 # output current progress indicator
542 return if (! $show_progress);
544 my $total = shift || 1;
545 my $p = int($current * 100 / $total);
547 printf STDERR ("%5d / %5d [%-51s] %-2d %% \r",$current,$total,"=" x ($p/2).">", $p );
554 return if (! $show_progress);
555 my $current = shift @_;
557 my @ind = ('-','\\','|','/','-','\\','|','/', '-');
559 $last_p += $fake_dir;
560 $fake_dir = -$fake_dir if ($last_p > 1000 || $last_p < 0);
561 if ($last_p % 10 == 0) {
562 printf STDERR ("%5d / %5s [%-51s]\r",$current,"?"," " x ($last_p/20).$ind[($last_p/20) % $#ind]);
567 print STDERR "using: $type...\n";
569 # erase cache for tags by order in this database
570 delete $cache->{tags_by_order};
572 if ($type_base eq "isis") {
574 my $isis_db = $cfg -> val($database, 'isis_db') || die "$database doesn't have 'isis_db' defined!";
576 $import2cp = Text::Iconv->new($config->{isis_codepage},$codepage);
577 my $db = OpenIsis::open( $isis_db );
579 # check if .txt database for OpenIsis is zero length,
580 # if so, erase it and re-open database
582 my $isis_db = shift || die "need isis database name";
585 if (-e $isis_db.".TXT") {
586 print STDERR "WARNING: removing $isis_db.TXT OpenIsis database...\n";
587 unlink $isis_db.".TXT" || warn "FATAL: unlink error on '$isis_db.TXT': $!";
590 if (-e $isis_db.".PTR") {
591 print STDERR "WARNING: removing $isis_db.PTR OpenIsis database...\n";
592 unlink $isis_db.".PTR" || warn "FATAL: unlink error on '$isis_db.PTR': $!";
595 return OpenIsis::open( $isis_db ) if ($reopen);
600 $db = check_txt_db($isis_db);
602 print STDERR "FATAL: OpenIsis can't open zero size file $isis_db\n";
609 print STDERR "FATAL: OpenIsis can't find file $isis_db\n";
612 } elsif ($db == -5) {
613 print STDERR "FATAL: OpenIsis can't access file $isis_db\n";
616 print STDERR "FATAL: OpenIsis unknown error $db with file $isis_db\n";
620 my $max_rowid = OpenIsis::maxRowid( $db );
622 # if 0 records, try to rease isis .txt database
623 if ($max_rowid == 0) {
624 # force removal of database
625 $db = check_txt_db($isis_db);
626 $max_rowid = OpenIsis::maxRowid( $db );
629 print STDERR "Reading database: $isis_db [$max_rowid rows]\n";
631 my $path = $database;
633 for (my $row_id = 1; $row_id <= $max_rowid; $row_id++ ) {
634 my $row = OpenIsis::read( $db, $row_id );
635 if ($row && $row->{mfn}) {
637 progress($row->{mfn}, $max_rowid);
639 my $swishpath = $path."#".int($row->{mfn});
641 if (my $xml = data2xml($type_base,$row,$add_xml,$cfg,$database)) {
642 $xml = $cp2utf->convert($xml);
643 use bytes; # as opposed to chars
644 print "Path-Name: $swishpath\n";
645 print "Content-Length: ".(length($xml)+1)."\n";
646 print "Document-Type: XML\n\n$xml\n";
650 # for this to work with current version of OpenIsis (0.9.0)
651 # you might need my patch from
652 # http://www.rot13.org/~dpavlin/projects/openisis-0.9.0-perl_close.diff
653 OpenIsis::close($db);
656 } elsif ($type_base eq "excel") {
657 use Spreadsheet::ParseExcel;
658 use Spreadsheet::ParseExcel::Utility qw(int2col);
660 $import2cp = Text::Iconv->new($config->{excel_codepage},$codepage);
661 my $excel_file = $cfg -> val($database, 'excel_file') || die "$database doesn't have 'excel_file' defined!";
663 my $sheet = x($config->{sheet}) || die "no sheet in $type.xml";
664 my $start_row = x($config->{start_row}) - 1 || die "no start_row in $type.xml";
666 my $oBook = Spreadsheet::ParseExcel::Workbook->Parse($excel_file) || die "can't open Excel file '$excel_file'";
669 foreach my $oWks (@{$oBook->{Worksheet}}) {
670 #print STDERR "-- SHEET $sheet_nr:", $oWks->{Name}, "\n";
671 last if ($oWks->{Name} eq $sheet);
675 my $oWorksheet = $oBook->{Worksheet}[$sheet_nr];
677 print STDERR "using sheet: ",$oWorksheet->{Name},"\n";
678 defined ($oWorksheet) || die "can't find sheet '$sheet' in $excel_file";
679 my $end_row = x($config->{end_row}) || $oWorksheet->{MaxRow};
681 for(my $iR = $start_row ; defined $end_row && $iR <= $end_row ; $iR++) {
683 for(my $iC = $oWorksheet->{MinCol} ; defined $oWorksheet->{MaxCol} && $iC <= $oWorksheet->{MaxCol} ; $iC++) {
684 my $cell = $oWorksheet->{Cells}[$iR][$iC];
686 $row->{int2col($iC)} = $cell->Value;
690 progress($iR, $end_row);
692 # print "row[$iR/$end_row] ";
693 # foreach (keys %{$row}) {
694 # print "$_: ",$row->{$_},"\t";
698 my $swishpath = $database."#".$iR;
702 if (my $xml = data2xml($type_base,$row,$add_xml,$cfg,$database)) {
703 $xml = $cp2utf->convert($xml);
704 use bytes; # as opposed to chars
705 print "Path-Name: $swishpath\n";
706 print "Content-Length: ".(length($xml)+1)."\n";
707 print "Document-Type: XML\n\n$xml\n";
710 } elsif ($type_base eq "marc") {
714 $import2cp = Text::Iconv->new($config->{marc_codepage},$codepage);
715 my $marc_file = $cfg -> val($database, 'marc_file') || die "$database doesn't have 'marc_file' defined!";
717 # optional argument is format
718 my $format = x($config->{format}) || 'usmarc';
720 print STDERR "Reading MARC file '$marc_file'\n";
723 my $nr = $marc->openmarc({
724 file=>$marc_file, format=>$format
725 }) || die "Can't open MARC file '$marc_file'";
727 my $i=0; # record nr.
731 while ($marc->nextmarc(1)) {
736 my $swishpath = $database."#".$i;
738 if (my $xml = data2xml($type_base,$marc,$add_xml,$cfg,$database)) {
739 $xml = $cp2utf->convert($xml);
740 use bytes; # as opposed to chars
741 print "Path-Name: $swishpath\n";
742 print "Content-Length: ".(length($xml)+1)."\n";
743 print "Document-Type: XML\n\n$xml\n";
746 } elsif ($type_base eq "feed") {
748 $import2cp = Text::Iconv->new($config->{feed_codepage},$codepage);
749 my $prog = x($config->{prog}) || die "$database doesn't have 'prog' defined!";
751 print STDERR "Reading feed from program '$prog'\n";
753 open(FEED,"feeds/$prog |") || die "can't start $prog: $!";
755 my $i=1; # record nr.
764 my $swishpath = $database."#".$i++;
766 if (my $xml = data2xml($type_base,$data,$add_xml,$cfg,$database)) {
767 $xml = $cp2utf->convert($xml);
768 use bytes; # as opposed to chars
769 print "Path-Name: $swishpath\n";
770 print "Content-Length: ".(length($xml)+1)."\n";
771 print "Document-Type: XML\n\n$xml\n";
778 $line = $1 if (s/^(\d+):\s*//);
779 $data->{$line++} = $_;
785 untie %lhash if (%lhash);
789 # call this to commit index
794 ##########################################################################
798 all2xml.pl - read various file formats and dump XML for SWISH-E
802 This command will read ISIS data file using OpenIsis perl module, MARC
803 records using MARC module and optionally Micro$oft Excel files to
804 create one XML file for usage with I<SWISH-E> indexer. Dispite it's name,
805 this script B<isn't general xml generator> from isis files (isis allready
806 has something like that). Output of this script is tailor-made for SWISH-E.
810 Documentation is really lacking. However, in true Open Source spirit, source
811 is best documentation. I even made considerable effort to comment parts
812 which are not intuitively clear, so...
816 Dobrica Pavlinusic <dpavlin@rot13.org>
820 GNU Public License (GPL) v2 or later
824 SWISH-E web site at http://www.swish-e.org