source: main/trunk/greenstone2/perllib/mgbuilder.pm@ 24193

Last change on this file since 24193 was 22820, checked in by davidb, 14 years ago

Need to call 'set_output_handle()' in additional places, to insure the more explict marking of the output stream to be ':utf8' is enforced

  • Property svn:keywords set to Author Date Id Revision
File size: 19.0 KB
Line 
1###########################################################################
2#
3# mgbuilder.pm -- MGBuilder object
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26package mgbuilder;
27
28use basebuilder;
29use plugin;
30use strict; no strict 'refs';
31use util;
32
33
34BEGIN {
35 @mgbuilder::ISA = ('basebuilder');
36}
37
38
39my %wanted_index_files = ('td'=>1,
40 't'=>1,
41 'idb'=>1,
42 'ib1'=>1,
43 'ib2'=>1,
44 'ib3'=>1,
45 'i'=>1,
46 'ip'=>1,
47 'tiw'=>1,
48 'wa'=>1);
49
50my $maxdocsize = $basebuilder::maxdocsize;
51
52
53sub new {
54 my $class = shift(@_);
55
56 my $self = new basebuilder (@_);
57 $self = bless $self, $class;
58
59 $self->{'buildtype'} = "mg";
60 return $self;
61}
62
63sub default_buildproc {
64 my $self = shift (@_);
65
66 return "mgbuildproc";
67}
68
69sub generate_index_list {
70 my $self = shift (@_);
71
72 if (!defined($self->{'collect_cfg'}->{'indexes'})) {
73 $self->{'collect_cfg'}->{'indexes'} = [];
74 }
75 if (scalar(@{$self->{'collect_cfg'}->{'indexes'}}) == 0) {
76 # no indexes have been specified so we'll build a "dummy:text" index
77 push (@{$self->{'collect_cfg'}->{'indexes'}}, "dummy:text");
78 }
79 # remove any ex.
80 my @orig_indexes = @{$self->{'collect_cfg'}->{'indexes'}};
81 $self->{'collect_cfg'}->{'indexes'} = [];
82 foreach my $index (@orig_indexes) {
83 $index =~ s/([:,])ex\./$1/g;
84 push (@{$self->{'collect_cfg'}->{'indexes'}}, $index);
85 }
86}
87
88sub generate_index_options {
89 my $self = shift (@_);
90 $self->SUPER::generate_index_options();
91
92 $self->{'casefold'} = 0;
93 $self->{'stem'} = 0;
94 $self->{'accentfold'} = 0; #not yet implemented for mg
95
96 if (!defined($self->{'collect_cfg'}->{'indexoptions'})) {
97 # just use default options
98 $self->{'casefold'} = 1;
99 $self->{'stem'} = 1;
100
101 } else {
102 foreach my $option (@{$self->{'collect_cfg'}->{'indexoptions'}}) {
103 if ($option =~ /stem/) {
104 $self->{'stem'} = 1;
105 } elsif ($option =~ /casefold/) {
106 $self->{'casefold'} = 1;
107 }
108 }
109 }
110
111 # now we record this for the build cfg
112 $self->{'stemindexes'} = 0;
113 if ($self->{'casefold'}) {
114 $self->{'stemindexes'} += 1;
115 }
116 if ($self->{'stem'}) {
117 $self->{'stemindexes'} += 2;
118 }
119
120
121}
122
123sub compress_text {
124 my $self = shift (@_);
125 my ($textindex) = @_;
126 my $exedir = "$ENV{'GSDLHOME'}/bin/$ENV{'GSDLOS'}";
127 my $exe = &util::get_os_exe ();
128 my $mg_passes_exe = &util::filename_cat($exedir, "mg_passes$exe");
129 my $mg_compression_dict_exe = &util::filename_cat($exedir, "mg_compression_dict$exe");
130 my $outhandle = $self->{'outhandle'};
131
132 my $maxnumeric = $self->{'maxnumeric'};
133
134 &util::mk_all_dir (&util::filename_cat($self->{'build_dir'}, "text"));
135
136 my $collect_tail = &util::get_dirsep_tail($self->{'collection'});
137 my $basefilename = &util::filename_cat("text",$collect_tail);
138 my $fulltextprefix = &util::filename_cat ($self->{'build_dir'}, $basefilename);
139
140 my $osextra = "";
141 if ($ENV{'GSDLOS'} =~ /^windows$/i) {
142 $fulltextprefix =~ s@/@\\@g;
143 } else {
144 $osextra = " -d /";
145 }
146
147 print $outhandle "\n*** creating the compressed text\n" if ($self->{'verbosity'} >= 1);
148 print STDERR "<Stage name='CompressText'>\n" if $self->{'gli'};
149
150 # collect the statistics for the text
151 # -b $maxdocsize sets the maximum document size to be 12 meg
152 print $outhandle "\n collecting text statistics\n" if ($self->{'verbosity'} >= 1);
153 print STDERR "<Phase name='CollectTextStats'/>\n" if $self->{'gli'};
154
155 my ($handle);
156 if ($self->{'debug'}) {
157 $handle = *STDOUT;
158 }
159 else {
160 if (!-e "$mg_passes_exe" ||
161 !open($handle, "| mg_passes$exe -f \"$fulltextprefix\" -b $maxdocsize -T1 -M $maxnumeric $osextra")) {
162 print STDERR "<FatalError name='NoRunMGPasses'>\n</Stage>\n" if $self->{'gli'};
163 die "mgbuilder::compress_text - couldn't run $mg_passes_exe\n";
164 }
165 }
166
167 $self->{'buildproc'}->set_output_handle ($handle);
168 $self->{'buildproc'}->set_mode ('text');
169 $self->{'buildproc'}->set_index ($textindex);
170 $self->{'buildproc'}->set_indexing_text (0);
171
172
173 if ($self->{'no_text'}) {
174 $self->{'buildproc'}->set_store_text(0);
175 } else {
176 $self->{'buildproc'}->set_store_text(1);
177 }
178 $self->{'buildproc'}->reset();
179
180 &plugin::begin($self->{'pluginfo'}, $self->{'source_dir'},
181 $self->{'buildproc'}, $self->{'maxdocs'});
182 &plugin::read ($self->{'pluginfo'}, $self->{'source_dir'},
183 "", {}, {}, $self->{'buildproc'}, $self->{'maxdocs'}, 0, $self->{'gli'});
184 &plugin::end($self->{'pluginfo'});
185
186
187 close ($handle) unless $self->{'debug'};
188
189 $self->print_stats();
190
191 # create the compression dictionary
192 # the compression dictionary is built by assuming the stats are from a seed
193 # dictionary (-S), if a novel word is encountered it is spelled out (-H),
194 # and the resulting dictionary must be less than 5 meg with the most frequent
195 # words being put into the dictionary first (-2 -k 5120)
196 if (!$self->{'debug'}) {
197 print $outhandle "\n creating the compression dictionary\n" if ($self->{'verbosity'} >= 1);
198 print STDERR "<Phase name='CreatingCompress'/>\n" if $self->{'gli'};
199 if (!-e "$mg_compression_dict_exe") {
200 die "mgbuilder::compress_text - couldn't run $mg_compression_dict_exe\n";
201 }
202 system ("mg_compression_dict$exe -f \"$fulltextprefix\" -S -H -2 -k 5120 $osextra");
203
204 # -b $maxdocsize sets the maximum document size to be 12 meg
205 if (!-e "$mg_passes_exe" ||
206 !open ($handle, "| mg_passes$exe -f \"$fulltextprefix\" -b $maxdocsize -T2 -M $maxnumeric $osextra")) {
207 print STDERR "<FatalError name='NoRunMGPasses'/>\n</Stage>\n" if $self->{'gli'};
208 die "mgbuilder::compress_text - couldn't run $mg_passes_exe\n";
209 }
210 }
211 else {
212 print STDERR "<Phase name='SkipCreatingComp'/>\n" if $self->{'gli'};
213 }
214
215 $self->{'buildproc'}->set_output_handle ($handle);
216 $self->{'buildproc'}->reset();
217
218 # compress the text
219 print $outhandle "\n compressing the text\n" if ($self->{'verbosity'} >= 1);
220 print STDERR "<Phase name='CompressingText'/>\n" if $self->{'gli'};
221
222 &plugin::read ($self->{'pluginfo'}, $self->{'source_dir'},
223 "", {}, {}, $self->{'buildproc'}, $self->{'maxdocs'}, 0, $self->{'gli'});
224
225 close ($handle) unless $self->{'debug'};
226
227 $self->print_stats();
228 print STDERR "</Stage>\n" if $self->{'gli'};
229}
230
231
232# creates directory names for each of the index descriptions
233sub create_index_mapping {
234 my $self = shift (@_);
235 my ($indexes) = @_;
236
237 my %mapping = ();
238 $mapping{'indexmaporder'} = [];
239 $mapping{'subcollectionmaporder'} = [];
240 $mapping{'languagemaporder'} = [];
241
242 # dirnames is used to check for collisions. Start this off
243 # with the manditory directory names
244 my %dirnames = ('text'=>'text',
245 'extra'=>'extra');
246 my %pnames = ('index' => {}, 'subcollection' => {}, 'languages' => {});
247 foreach my $index (@$indexes) {
248 my ($level, $gran, $subcollection, $languages) = split (":", $index);
249
250 # the directory name starts with the first character of the index level
251 my ($pindex) = $level =~ /^(.)/;
252
253 # next comes a processed version of the index
254 $pindex .= $self->process_field ($gran);
255 $pindex = lc ($pindex);
256
257 # next comes a processed version of the subcollection if there is one.
258 my $psub = $self->process_field ($subcollection);
259 $psub = lc ($psub);
260
261 # next comes a processed version of the language if there is one.
262 my $plang = $self->process_field ($languages);
263 $plang = lc ($plang);
264
265 my $dirname = $pindex . $psub . $plang;
266
267 # check to be sure all index names are unique
268 while (defined ($dirnames{$dirname})) {
269 $dirname = $self->make_unique (\%pnames, $index, \$pindex, \$psub, \$plang);
270 }
271 $mapping{$index} = $dirname;
272
273 # store the mapping orders as well as the maps
274 # also put index, subcollection and language fields into the mapping thing -
275 # (the full index name (eg document:text:subcol:lang) is not used on
276 # the query page) -these are used for collectionmeta later on
277 if (!defined $mapping{'indexmap'}{"$level:$gran"}) {
278 $mapping{'indexmap'}{"$level:$gran"} = $pindex;
279 push (@{$mapping{'indexmaporder'}}, "$level:$gran");
280 if (!defined $mapping{"$level:$gran"}) {
281 $mapping{"$level:$gran"} = $pindex;
282 }
283 }
284 if ($psub =~ /\w/ && !defined ($mapping{'subcollectionmap'}{$subcollection})) {
285 $mapping{'subcollectionmap'}{$subcollection} = $psub;
286 push (@{$mapping{'subcollectionmaporder'}}, $subcollection);
287 $mapping{$subcollection} = $psub;
288 }
289 if ($plang =~ /\w/ && !defined ($mapping{'languagemap'}{$languages})) {
290 $mapping{'languagemap'}{$languages} = $plang;
291 push (@{$mapping{'languagemaporder'}}, $languages);
292 $mapping{$languages} = $plang;
293 }
294 $dirnames{$dirname} = $index;
295 $pnames{'index'}->{$pindex} = "$level:$gran";
296 $pnames{'subcollection'}->{$psub} = $subcollection;
297 $pnames{'languages'}->{$plang} = $languages;
298 }
299
300 return \%mapping;
301}
302
303
304sub make_unique {
305 my $self = shift (@_);
306 my ($namehash, $index, $indexref, $subref, $langref) = @_;
307 my ($level, $gran, $subcollection, $languages) = split (":", $index);
308
309 if ($namehash->{'index'}->{$$indexref} ne "$level:$gran") {
310 $self->get_next_version ($indexref);
311 } elsif ($namehash->{'subcollection'}->{$$subref} ne $subcollection) {
312 $self->get_next_version ($subref);
313 } elsif ($namehash->{'languages'}->{$$langref} ne $languages) {
314 $self->get_next_version ($langref);
315 }
316 return "$$indexref$$subref$$langref";
317}
318
319sub build_index {
320 my $self = shift (@_);
321 my ($index) = @_;
322 my $outhandle = $self->{'outhandle'};
323
324 # get the full index directory path and make sure it exists
325 my $indexdir = $self->{'index_mapping'}->{$index};
326 &util::mk_all_dir (&util::filename_cat($self->{'build_dir'}, $indexdir));
327
328 my $collect_tail = &util::get_dirsep_tail($self->{'collection'});
329 my $fullindexprefix = &util::filename_cat ($self->{'build_dir'}, $indexdir,
330 $collect_tail);
331 my $fulltextprefix = &util::filename_cat ($self->{'build_dir'}, "text",
332 $collect_tail);
333
334 # get any os specific stuff
335 my $exedir = "$ENV{'GSDLHOME'}/bin/$ENV{'GSDLOS'}";
336 my $exe = &util::get_os_exe ();
337 my $mg_passes_exe = &util::filename_cat($exedir, "mg_passes$exe");
338 my $mg_perf_hash_build_exe =
339 &util::filename_cat($exedir, "mg_perf_hash_build$exe");
340 my $mg_weights_build_exe =
341 &util::filename_cat ($exedir, "mg_weights_build$exe");
342 my $mg_invf_dict_exe =
343 &util::filename_cat ($exedir, "mg_invf_dict$exe");
344 my $mg_stem_idx_exe =
345 &util::filename_cat ($exedir, "mg_stem_idx$exe");
346
347 my $maxnumeric = $self->{'maxnumeric'};
348
349 my $osextra = "";
350 if ($ENV{'GSDLOS'} =~ /^windows$/i) {
351 $fullindexprefix =~ s@/@\\@g;
352 } else {
353 $osextra = " -d /";
354 if ($outhandle ne "STDERR") {
355 # so mg_passes doesn't print to stderr if we redirect output
356 $osextra .= " 2>/dev/null";
357 }
358 }
359
360 # get the index level from the index description
361 # the index will be level 2 unless we are building a
362 # paragraph level index
363 my $index_level = 2;
364 $index_level = 3 if $index =~ /^paragraph/i;
365
366 # get the index expression if this index belongs
367 # to a subcollection
368 my $indexexparr = [];
369 my $langarr = [];
370 # there may be subcollection info, and language info.
371 my ($level, $fields, $subcollection, $language) = split (":", $index);
372 my @subcollections = ();
373 @subcollections = split /,/, $subcollection if (defined $subcollection);
374
375 foreach my $subcollection (@subcollections) {
376 if (defined ($self->{'collect_cfg'}->{'subcollection'}->{$subcollection})) {
377 push (@$indexexparr, $self->{'collect_cfg'}->{'subcollection'}->{$subcollection});
378 }
379 }
380
381 # add expressions for languages if this index belongs to
382 # a language subcollection - only put languages expressions for the
383 # ones we want in the index
384
385 my @languages = ();
386 my $languagemetadata = "Language";
387 if (defined ($self->{'collect_cfg'}->{'languagemetadata'})) {
388 $languagemetadata = $self->{'collect_cfg'}->{'languagemetadata'};
389 }
390 @languages = split /,/, $language if (defined $language);
391 foreach my $language (@languages) {
392 my $not=0;
393 if ($language =~ s/^\!//) {
394 $not = 1;
395 }
396 if($not) {
397 push (@$langarr, "!$language");
398 } else {
399 push (@$langarr, "$language");
400 }
401 }
402
403 # Build index dictionary. Uses verbatim stem method
404 print $outhandle "\n creating index dictionary\n" if ($self->{'verbosity'} >= 1);
405 print STDERR "<Phase name='CreatingIndexDic'/>\n" if $self->{'gli'};
406 my ($handle);
407 if ($self->{'debug'}) {
408 $handle = *STDOUT;
409 }
410 else {
411 if (!-e "$mg_passes_exe" ||
412 !open($handle, "| mg_passes$exe -f \"$fullindexprefix\" -b $maxdocsize " .
413 "-$index_level -m 32 -s 0 -G -t 10 -N1 -M $maxnumeric $osextra")) {
414 print STDERR "<FatalError name='NoRunMGPasses'/>\n</Stage>\n" if $self->{'gli'};
415 die "mgbuilder::build_index - couldn't run $mg_passes_exe\n";
416 }
417 }
418
419 # set up the document processor
420 $self->{'buildproc'}->set_output_handle ($handle);
421 $self->{'buildproc'}->set_mode ('text');
422 $self->{'buildproc'}->set_index ($index, $indexexparr);
423 $self->{'buildproc'}->set_index_languages ($languagemetadata, $langarr) if (defined $language);
424 $self->{'buildproc'}->set_indexing_text (1);
425 $self->{'buildproc'}->set_store_text(1);
426
427 $self->{'buildproc'}->reset();
428 &plugin::read ($self->{'pluginfo'}, $self->{'source_dir'},
429 "", {}, {}, $self->{'buildproc'}, $self->{'maxdocs'},0, $self->{'gli'});
430 close ($handle) unless $self->{'debug'};
431
432 $self->print_stats();
433
434 # now we check to see if the required files have been produced - if not we quit building this index so the whole process doesn't crap out.
435 # we check on the .id file - index dictionary
436 my $dict_file = "$fullindexprefix.id";
437 if (!-e $dict_file) {
438 print $outhandle "mgbuilder::build_index - Couldn't create index $index\n";
439 $self->{'notbuilt'}->{$index}=1;
440 return;
441 }
442 if (!$self->{'debug'}) {
443 # create the perfect hash function
444 if (!-e "$mg_perf_hash_build_exe") {
445 print STDERR "<FatalError name='NoRunMGHash'/>\n</Stage>\n" if $self->{'gli'};
446 die "mgbuilder::build_index - couldn't run $mg_perf_hash_build_exe\n";
447 }
448 system ("mg_perf_hash_build$exe -f \"$fullindexprefix\" $osextra");
449
450 if (!-e "$mg_passes_exe" ||
451 !open ($handle, "| mg_passes$exe -f \"$fullindexprefix\" -b $maxdocsize " .
452 "-$index_level -c 3 -G -t 10 -N2 -M $maxnumeric $osextra")) {
453 print STDERR "<FatalError name='NoRunMGPasses'/>\n</Stage>\n" if $self->{'gli'};
454 die "mgbuilder::build_index - couldn't run $mg_passes_exe\n";
455 }
456 }
457
458 # invert the text
459 print $outhandle "\n inverting the text\n" if ($self->{'verbosity'} >= 1);
460 print STDERR "<Phase name='InvertingText'/>\n" if $self->{'gli'};
461
462 $self->{'buildproc'}->set_output_handle ($handle);
463 $self->{'buildproc'}->reset();
464
465 &plugin::read ($self->{'pluginfo'}, $self->{'source_dir'},
466 "", {}, {}, $self->{'buildproc'}, $self->{'maxdocs'},0, $self->{'gli'});
467
468
469 $self->print_stats ();
470
471 if (!$self->{'debug'}) {
472
473 close ($handle);
474
475 # create the weights file
476 print $outhandle "\n create the weights file\n" if ($self->{'verbosity'} >= 1);
477 print STDERR "<Phase name='CreateTheWeights'/>\n" if $self->{'gli'};
478 if (!-e "$mg_weights_build_exe") {
479 print STDERR "<FatalError name='NoRunMGWeights'/>\n</Stage>\n" if $self->{'gli'};
480 die "mgbuilder::build_index - couldn't run $mg_weights_build_exe\n";
481 }
482 system ("mg_weights_build$exe -f \"$fullindexprefix\" -t \"$fulltextprefix\" $osextra");
483
484 # create 'on-disk' stemmed dictionary
485 print $outhandle "\n creating 'on-disk' stemmed dictionary\n" if ($self->{'verbosity'} >= 1);
486 print STDERR "<Phase name='CreateStemmedDic'/>\n" if $self->{'gli'};
487 if (!-e "$mg_invf_dict_exe") {
488 print STDERR "<FatalError name='NoRunMGInvf'/>\n</Stage>\n" if $self->{'gli'};
489 die "mgbuilder::build_index - couldn't run $mg_invf_dict_exe\n";
490 }
491 system ("mg_invf_dict$exe -f \"$fullindexprefix\" $osextra");
492
493
494 # creates stem index files for the various stemming methods
495 print $outhandle "\n creating stem indexes\n" if ($self->{'verbosity'} >= 1);
496 print STDERR "<Phase name='CreatingStemIndx'/>\n" if $self->{'gli'};
497 if (!-e "$mg_stem_idx_exe") {
498 print STDERR "<FatalError name='NoRunMGStem'/>\n</Stage>\n" if $self->{'gli'};
499 die "mgbuilder::build_index - couldn't run $mg_stem_idx_exe\n";
500 }
501 # currently mg wont work if we don't generate all the stem idexes
502 # so we generate them whatever, but don't advertise the fact
503 #if ($self->{'casefold'}) {
504 system ("mg_stem_idx$exe -b 4096 -s1 -f \"$fullindexprefix\" $osextra");
505 #}
506 #if ($self->{'stem'}) {
507 system ("mg_stem_idx$exe -b 4096 -s2 -f \"$fullindexprefix\" $osextra");
508 #}
509 #if ($self->{'casefold'} && $self->{'stem'}) {
510 system ("mg_stem_idx$exe -b 4096 -s3 -f \"$fullindexprefix\" $osextra");
511 #}
512
513 # remove unwanted files
514 my $tmpdir = &util::filename_cat ($self->{'build_dir'}, $indexdir);
515 opendir (DIR, $tmpdir) || die
516 "mgbuilder::build_index - couldn't read directory $tmpdir\n";
517 foreach my $file (readdir(DIR)) {
518 next if $file =~ /^\./;
519 my ($suffix) = $file =~ /\.([^\.]+)$/;
520 if (defined $suffix && !defined $wanted_index_files{$suffix}) {
521 # delete it!
522 print $outhandle "deleting $file\n" if $self->{'verbosity'} > 2;
523 &util::rm (&util::filename_cat ($tmpdir, $file));
524 }
525 }
526 closedir (DIR);
527 }
528 print STDERR "</Stage>\n" if $self->{'gli'};
529}
530
531sub build_cfg_extra {
532 my $self = shift(@_);
533 my ($build_cfg) = @_;
534
535 # get additional stats from mg
536 my $exedir = "$ENV{'GSDLHOME'}/bin/$ENV{'GSDLOS'}";
537 my $exe = &util::get_os_exe ();
538 my $mgstat_exe = &util::filename_cat($exedir, "mgstat$exe");
539
540 my $collect_tail = &util::get_dirsep_tail($self->{'collection'});
541 my $input_file = &util::filename_cat ("text", $collect_tail);
542 if (!-e "$mgstat_exe" || !open (PIPEIN, "mgstat$exe -d \"$self->{'build_dir'}\" -f \"$input_file\" |")) {
543 my $outhandle = $self->{'outhandle'};
544 print $outhandle "Warning: Couldn't open pipe to $mgstat_exe to get additional stats\n";
545 } else {
546 my $line = "";
547 while (defined ($line = <PIPEIN>)) {
548 if ($line =~ /^Words in collection \[dict\]\s+:\s+(\d+)/) {
549 ($build_cfg->{'numwords'}) = $1;
550 } elsif ($line =~ /^Documents\s+:\s+(\d+)/) {
551 ($build_cfg->{'numsections'}) = $1;
552 }
553 }
554 close PIPEIN;
555 }
556}
557
5581;
559
560
561
Note: See TracBrowser for help on using the repository browser.