source: gsdl/trunk/perllib/mgbuilder.pm@ 14926

Last change on this file since 14926 was 12971, checked in by kjdon, 18 years ago

removed some debug print statements

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