root/main/trunk/greenstone2/perllib/buildConfigxml.pm @ 27803

Revision 27803, 23.6 KB (checked in by kjdon, 7 years ago)

code for sort and facet lists

  • Property svn:keywords set to Author Date Id Revision
Line 
1###########################################################################
2#
3# buildConfigxml.pm --
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
26# reads in buildConfig.xml
27# Note, only implemented the bits that are currently used, eg by incremental
28# build code.
29# The resulting data is not a full representation on buildConfig.xml.
30
31package buildConfigxml;
32
33use strict;
34no strict 'refs';
35no strict 'subs';
36
37use XMLParser;
38
39
40# A mapping hash to resolve name discrepancy between gs2 and gs3.
41my $nameMap = {"numDocs" => "numdocs",
42           "buildType" => "buildtype",
43           "orthogonalBuildTypes" => "orthogonalbuildtypes"
44           };
45
46
47# A hash structure which is returned by sub read_cfg_file.
48my $data = {};
49
50# use those unique attribute values to locate the text within the elements
51my $currentLocation = "";
52my $stringexp = q/^(buildType|numDocs)$/;
53my $arrayexp = q/^(orthogonalBuildTypes)$/;
54
55my $indexmap_name = "";
56my $haveindexfields = 0;
57
58# Reads in the model collection configuration file, collectionConfig.xml,
59# into a structure which complies with the one used by gs2 (i.e. one read
60# in by &cfgread::read_cfg_file).
61sub read_cfg_file {
62    my ($filename) = @_;
63    $data = {};
64    if ($filename !~ /buildConfig\.xml$/ || !-f $filename) {
65        return undef;
66    }
67
68    # Removed ProtocolEncoding (see MetadataXMLPlugin for details)
69
70    # create XML::Parser object for parsing metadata.xml files
71    my $parser = new XML::Parser('Style' => 'Stream',
72                 'Pkg' => 'buildConfigxml',
73                 'Handlers' => {'Char' => \&Char,
74                         'Doctype' => \&Doctype
75                         });
76
77    if (!open (COLCFG, $filename)) {
78    print STDERR "buildConfigxml::read_cfg_file couldn't read the cfg file $filename\n";
79    } else {
80
81      $parser->parsefile ($filename);# (COLCFG);
82      close (COLCFG);
83    }
84
85    #&Display;
86    return $data;
87}
88
89sub StartTag {
90# Those marked with #@ will not be executed at the same time when this sub is being called
91# so that if/elsif is used to avoid unnecessary tests
92    my ($expat, $element) = @_;
93   
94    my $name = $_{'name'};
95    my $shortname = $_{'shortname'};
96
97   
98    #@ handling block metadataList
99    if (defined $name && (($name =~ m/$stringexp/) || ($name =~ m/$arrayexp/))) {
100      $currentLocation = $name;
101      # the value will be retrieved later in Text sub
102    }
103
104    #@ handle indexes - store indexmap (mg) or indexfields and indexfieldmap (mgpp/lucene/solr)
105    elsif ($element =~ /^indexList$/) {
106    # set up the data arrays
107    # this assumes that the build type has been read already, which is
108    # currently the order we save the file in.
109    if ($data->{'buildtype'} eq "mg") {
110        $indexmap_name = "indexmap";
111        if (!defined $data->{"indexmap"}) {
112        $data->{"indexmap"} = [];
113        }
114    }
115    else {
116        # mgpp, lucene or solr
117        $indexmap_name = "indexfieldmap";
118        $haveindexfields = 1;
119        if (!defined $data->{"indexfieldmap"}) {
120        $data->{"indexfieldmap"} = [];
121        }
122        if (!defined $data->{"indexfields"}) {
123        $data->{"indexfields"} = [];
124        }
125
126    }
127   
128    }
129   
130    elsif ($element =~ /index/) {
131    # store each index in the map
132    if (defined $name && defined $shortname) {
133        push @{$data->{$indexmap_name}}, "$name->$shortname";
134        if ($haveindexfields) {
135        push @{$data->{'indexfields'}}, $name;
136        }
137    }
138    }
139
140
141}
142
143sub EndTag {
144    my ($expat, $element) = @_;
145}
146
147sub Text {
148    if (defined $currentLocation) {
149    #@ Handling block metadataList(numDocs, buildType)
150    if ($currentLocation =~ /$stringexp/) {
151        #print $currentLocation;
152        my $key = $nameMap->{$currentLocation};
153        $data->{$key} = $_;
154        undef $currentLocation;
155    }   
156    elsif ($currentLocation =~ /$arrayexp/) {
157        #print $currentLocation;
158        my $key = $nameMap->{$currentLocation};
159        push(@{$data->{$key}},$_);
160        undef $currentLocation;
161    }   
162
163    }   
164}
165
166# This sub is for debugging purposes
167sub Display {
168
169    print "NumDocs = ".$data->{'numdocs'}."\n" if (defined $data->{'numdocs'});
170    print "BuildType = ".$data->{'buildtype'}."\n" if (defined $data->{'buildtype'});
171    print "OrthogonalBuildTypes = ".join(",",@{$data->{'orthogonalbuildtypes'}})."\n" if (defined $data->{'orthogonalbuildtypes'});
172    print  "IndexMap = ". join(" ",@{$data->{'indexmap'}})."\n" if (defined $data->{'indexmap'});
173    print  "IndexFieldMap = ". join(" ",@{$data->{'indexfieldmap'}})."\n" if (defined $data->{'indexfieldmap'});
174    print  "IndexFields = ". join(" ",@{$data->{'indexfields'}})."\n" if (defined $data->{'indexfields'});
175
176}
177
178# is this actually used??
179sub Doctype {
180    my ($expat, $name, $sysid, $pubid, $internal) = @_;
181
182    die if ($name !~ /^buildConfig$/);
183}
184
185# This Char function overrides the one in XML::Parser::Stream to overcome a
186# problem where $expat->{Text} is treated as the return value, slowing
187# things down significantly in some cases.
188sub Char {
189    if ($]<5.008) {
190    use bytes;  # Necessary to prevent encoding issues with XML::Parser 2.31+ and Perl 5.6
191    }
192    $_[0]->{'Text'} .= $_[1];
193    return undef;
194}
195
196
197
198sub write_line {
199    my ($filehandle, $line) = @_;
200    print $filehandle join ("", @$line), "\n";
201}
202
203sub search_and_retrieve_settings
204{
205    my ($buildcfg,$collectcfg) = @_;
206
207    my $settings = {};
208
209    if (defined $buildcfg->{"buildtype"}) {
210    $settings->{'buildtype'} = $buildcfg->{"buildtype"};
211    } else {
212    $settings->{'buildtype'} = "mgpp";
213    }
214    my $buildtype = $settings->{'buildtype'};
215
216    if (defined $collectcfg->{"orthogonalbuildtypes"}) {
217    # Note the use of collectcfg, not bulidcfg
218    $settings->{'orthogonalbuildtypes'} = $collectcfg->{"orthogonalbuildtypes"};
219    } else {
220    $settings->{'orthogonalbuildtypes '}= [];
221    }
222
223    if (defined $buildcfg->{"numdocs"}) {
224    $settings->{'numdocs'} = $buildcfg->{"numdocs"};
225    }
226    else {
227    $settings->{'numdocs'} = 0;
228    }
229
230    my $service_type = "MGPP";
231    if ($buildtype eq "mg") {
232    $service_type = "MG";
233    } elsif ($buildtype eq "lucene") {
234    $service_type = "Lucene";
235    } elsif ($buildtype eq "solr") {
236    $service_type = "Solr";
237    }
238    $settings->{'service_type'} = $service_type;
239
240
241    if (defined $buildcfg->{"infodbtype"}) {
242    $settings->{'infodbtype'} = $buildcfg->{'infodbtype'};
243    }
244    else {
245    $settings->{'infodbtype'} = "gdbm";
246    }
247
248
249    #--
250    # indexes
251    #--
252   
253    my $indexmap = {};  # maps index name to shortname
254    my $indexlist = []; # keeps the order for indexes
255    my $defaultindex = "";
256    my $maptype = ($buildtype eq "mg")  ? "indexmap" : "indexfieldmap";
257
258    if (defined $buildcfg->{$maptype}) {
259    my $first = 1;
260    my $indexmap_t = $buildcfg->{$maptype};
261    foreach my $i (@$indexmap_t) {
262        my ($k, $v) = $i =~ /^(.*)\-\>(.*)$/;
263        $indexmap->{$k} = $v;
264        push @$indexlist, $k;
265        if ($first) {
266        $defaultindex = $v;
267        $first = 0;
268        }
269    }
270       # now if the user has assigned a default index, we use it
271    if (defined $collectcfg->{"defaultindex"}) {
272        $defaultindex = $indexmap->{$collectcfg->{"defaultindex"}};
273    }
274    } else {
275    print STDERR "$maptype not defined\n";
276    }
277
278    $settings->{'num_indexes'} = $buildcfg->{'num_indexes'};
279    $settings->{'defaultindex'} = $defaultindex;
280    $settings->{'indexmap'} = $indexmap;
281    $settings->{'indexlist'} = $indexlist;
282
283    #--
284    # default lang
285    #--
286    $settings->{'default_lang'} = "";
287    $settings->{'default_lang_short'} = "";
288
289    if (defined $buildcfg->{"languagemap"}) {
290      my $langmap_t = $buildcfg->{"languagemap"};
291      if ((defined $langmap_t) && (scalar(@$langmap_t)>=1)) {
292      my $l = $langmap_t->[0];
293      my ($k, $v) = $l =~ m/^(.*)\-\>(.*)$/;
294      $settings->{'default_lang'} = $k; #name
295      $settings->{'default_lang_short'} = $v; #short name
296      }
297
298      # now if the user has assigned a default language (as "en", "ru" etc.)
299      if (defined $collectcfg->{"defaultlanguage"}) {
300    $settings->{'default_lang'} = $collectcfg->{"defaultlanguage"};
301    # what about default_lang_short ?? ####
302      }
303    }
304
305    # default subcol
306    $settings->{'default_subcol'} = "";
307    if (defined $buildcfg->{'subcollectionmap'}) {
308    my $subcolmap_t = $buildcfg->{'subcollectionmap'};
309    if ((defined $subcolmap_t) && (scalar(@$subcolmap_t)>=1)) {
310        my $l = $subcolmap_t->[0];
311        my ($k, $v) = $l =~ m/^(.*)\-\>(.*)$/;
312
313        $settings->{'default_subcol'} = $v;
314    }
315    }
316
317
318    #--
319    # indexstem
320    #--
321    if (defined $buildcfg->{'indexstem'}) {
322    $settings->{'indexstem'} = $buildcfg->{'indexstem'};
323    }
324
325    #--
326    # levelList
327    #--
328
329    my $levelmap = {};
330    my $levellist = [];
331    my $default_search_level = "Doc";
332    my $default_retrieve_level = "Doc";
333    my $default_db_level = "Doc";
334
335    if ($buildtype eq "mgpp" || $buildtype eq "lucene" || $buildtype eq "solr") {
336    if (defined $buildcfg->{'levelmap'}) {
337        my $first = 1;
338
339        my $levelmap_t = $buildcfg->{'levelmap'};
340        foreach my $l (@$levelmap_t) {
341        my ($key, $val) = $l =~ /^(.*)\-\>(.*)$/;
342        $levelmap->{$key} = $val;
343        push @$levellist, $key;
344        if ($first) {
345            # let default search level follow the first level in the level list
346            $default_search_level = $val;
347            # retrieve/database levels may get modified later if text level is defined
348            $default_retrieve_level = $val;
349            $default_db_level = $val;
350            $first = 0;
351        }
352        }
353    }
354    # the default level assigned by the user is no longer ignored [Shaoqun], but the retrievel level stays the same.
355    if (defined $collectcfg->{"defaultlevel"}) {
356        $default_search_level = $levelmap->{$collectcfg->{"defaultlevel"}};
357        #  $default_retrieve_level = $default_search_level;
358    }
359   
360    if (defined $buildcfg->{'textlevel'}) {
361       # let the retrieve/database levels always follow the textlevel
362           $default_retrieve_level = $buildcfg->{'textlevel'};
363       $default_db_level = $buildcfg->{'textlevel'};
364         
365    }
366    }
367    $settings->{'levelmap'} = $levelmap;
368    $settings->{'levellist'} = $levellist;
369    $settings->{'default_search_level'} = $default_search_level if $default_search_level;
370    $settings->{'default_retrieve_level'} = $default_retrieve_level;
371    $settings->{'default_db_level'} = $default_db_level;
372
373    # sort field list
374    ######
375
376    my $sortmap = {};  # maps index name to shortname
377    my $sortlist = []; # keeps the order for indexes
378
379    if (defined ($buildcfg->{"indexsortfieldmap"})) {
380    my $sortmap_t = $buildcfg->{"indexsortfieldmap"};
381    foreach my $s (@$sortmap_t) {
382        my ($k, $v) = $s =~ /^(.*)\-\>(.*)$/;
383        $sortmap->{$v} = $k;
384    }
385    }
386    if (defined ($buildcfg->{"indexsortfields"})) {
387    $sortlist = $buildcfg->{"indexsortfields"};
388    }
389
390    $settings->{'sortlist'} = $sortlist;
391    $settings->{'sortmap'} = $sortmap;
392
393    ### TODO make these use facets not the sort list
394    $settings->{'facetlist'} = $sortlist;
395    $settings->{'facetmap'} = $sortmap;
396
397
398    return $settings;
399}
400
401
402sub write_search_servicerack
403{
404    my ($buildcfg,$settings) = @_;
405
406    my $buildtype    = $settings->{'buildtype'};
407    my $infodbtype   = $settings->{'infodbtype'};
408    my $service_type = $settings->{'service_type'};
409
410    # there's no searching and therefore no search services if there are no indexes
411    return if($settings->{'num_indexes'} <= 0);
412   
413    # do the search service
414    &write_line('COLCFG', ["<serviceRack name=\"GS2", $service_type, "Search\">"]);
415    if (defined $buildcfg->{'indexstem'}) {
416      my $indexstem = $buildcfg->{'indexstem'};
417      &write_line('COLCFG', ["<indexStem name=\"", $indexstem, "\" />"]);     
418    }
419    if (defined $buildcfg->{'infodbtype'}) {
420        &write_line('COLCFG', ["<databaseType name=\"", $infodbtype, "\" />"]);     
421    }
422
423    #indexes
424    my $indexmap = $settings->{'indexmap'};
425    my $indexlist = $settings->{'indexlist'};
426    my $defaultindex = $settings->{'defaultindex'};
427
428    #for each index in indexList, write them out
429    &write_line('COLCFG', ["<indexList>"]);
430    foreach my $i (@$indexlist) {
431    my $index = $indexmap->{$i};
432    &write_line('COLCFG', ["<index name=\"", $i, "\" ", "shortname=\"", $index, "\" />"]);
433    }   
434    &write_line('COLCFG', ["</indexList>"]);
435
436   
437    #$defaultindex = "ZZ" if (!$defaultindex); # index allfields by default
438    if ($defaultindex) {
439    &write_line('COLCFG', ["<defaultIndex shortname=\"", $defaultindex, "\" />"]);
440    }
441
442
443    # do indexOptionList
444    if ($buildtype eq "mg" || $buildtype eq "mgpp") {
445        &write_line('COLCFG', ["<indexOptionList>"]);
446    my $stemindexes = 3; # default is stem and casefold
447    if (defined $buildcfg->{'stemindexes'} && $buildcfg->{'stemindexes'} =~ /^\d+$/ ) {
448        $stemindexes = $buildcfg->{'stemindexes'};
449    }
450    &write_line('COLCFG', ["<indexOption name=\"stemIndexes\" value=\"", $stemindexes, "\" />"]);
451   
452    my $maxnumeric = 4; # default
453    if (defined $buildcfg->{'maxnumeric'} && $buildcfg->{'maxnumeric'} =~ /^\d+$/) {
454        $maxnumeric = $buildcfg->{'maxnumeric'};
455    }
456    &write_line('COLCFG', ["<indexOption name=\"maxnumeric\" value=\"", $maxnumeric, "\" />"]);
457        &write_line('COLCFG', ["</indexOptionList>"]);
458    }
459
460    #--
461    # levelList
462    #--
463    my $levelmap = $settings->{'levelmap'};
464    my $levellist = $settings->{'levellist'};
465    my $default_search_level = $settings->{'default_search_level'};
466    my $default_retrieve_level = $settings->{'default_retrieve_level'};
467    my $default_db_level = $settings->{'default_db_level'};
468
469    #for each level in levelList, write them out
470    if ($buildtype ne "mg") {
471    &write_line('COLCFG', ["<levelList>"]);
472    foreach my $lv (@$levellist) {
473        my $level = $levelmap->{$lv};
474        &write_line('COLCFG', ["<level name=\"", $lv, "\" shortname=\"", $level, "\" />"]);
475    }   
476    &write_line('COLCFG', ["</levelList>"]);
477    }
478    # add in defaultLevel as the same level as indexLevelList, making the reading job easier
479    if ($buildtype eq "lucene" || $buildtype eq "mgpp" || $buildtype eq "solr") {
480    &write_line('COLCFG', ["<defaultLevel shortname=\"", $default_search_level, "\" />"]);
481    }
482    if ($buildtype eq "lucene" || $buildtype eq "mgpp" || $buildtype eq "solr") {
483        &write_line('COLCFG', ["<defaultDBLevel shortname=\"", $default_db_level, "\" />"]);
484    }
485
486    # do sort list
487    if ($buildtype eq "lucene" || $buildtype eq "solr") {
488    my $sortlist = $settings->{'sortlist'};
489    my $sortmap = $settings->{'sortmap'};
490    &write_line('COLCFG', ["<sortList>"]);
491    foreach my $sf (@$sortlist) {
492        my $sortf = $sortmap->{$sf};
493        &write_line('COLCFG', ["<sort name=\"", $sortf, "\" shortname=\"", $sf, "\" />"]);
494    }
495    &write_line('COLCFG', ["</sortList>"]);
496    }
497
498    # do facet list
499    if ($buildtype eq "solr") {
500    &write_line('COLCFG', ["<facetList>"]);
501    my $facetlist = $settings->{'facetlist'};
502    my $facetmap = $settings->{'facetmap'};
503    foreach my $ff (@$facetlist) {
504        my $facetf = $facetmap->{$ff};
505        &write_line('COLCFG', ["<facet name=\"", $ff, "\" shortname=\"", $facetf, "\" />"]);
506    }
507    &write_line('COLCFG', ["</facetList>"]);
508    }
509    # do searchTypeList
510    if ($buildtype eq "mgpp" || $buildtype eq "lucene" || $buildtype eq "solr") {
511      &write_line('COLCFG', ["<searchTypeList>"]);
512     
513      if (defined $buildcfg->{"searchtype"}) {
514      my $searchtype_t = $buildcfg->{"searchtype"};
515      foreach my $s (@$searchtype_t) {
516      &write_line('COLCFG', ["<searchType name=\"", $s, "\" />"]);
517    }
518      } else {
519      &write_line('COLCFG', ["<searchType name=\"plain\" />"]);
520      &write_line('COLCFG', ["<searchType name=\"form\" />"]);
521      }
522      &write_line('COLCFG', ["</searchTypeList>"]);
523    }
524
525    # do indexLanguageList [in collect.cfg: languages; in build.cfg: languagemap]
526    my $default_lang = $settings->{'default_lang'};
527    my $default_lang_short = $settings->{'default_lang_short'};
528    if (defined $buildcfg->{"languagemap"}) {
529      &write_line('COLCFG', ["<indexLanguageList>"]);
530
531      my $langmap_t = $buildcfg->{"languagemap"};
532      foreach my $l (@$langmap_t) {
533    my ($k, $v) = $l =~ /^(.*)\-\>(.*)$/;
534
535    &write_line('COLCFG', ["<indexLanguage name=\"", $k, "\" shortname=\"", $v, "\" />"]);
536      }
537
538      &write_line('COLCFG', ["</indexLanguageList>"]);
539
540      &write_line('COLCFG', ["<defaultIndexLanguage name=\"", $default_lang, "\" shortname=\"", $default_lang_short, "\" />"]);
541    }
542
543    # do indexSubcollectionList
544    my $default_subcol = $settings->{'default_subcol'};
545
546    if (defined $buildcfg->{'subcollectionmap'}) {
547      &write_line('COLCFG', ["<indexSubcollectionList>"]);
548      my $subcolmap = {};
549      my @subcollist = ();
550
551      my $subcolmap_t = $buildcfg->{'subcollectionmap'};
552      foreach my $l (@$subcolmap_t) {
553    my ($k, $v) = $l =~ /^(.*)\-\>(.*)$/;
554    $subcolmap->{$k} = $v;
555    push @subcollist, $k;
556      }
557
558      foreach my $sl (@subcollist) {
559    my $subcol = $subcolmap->{$sl};
560    &write_line('COLCFG', ["<indexSubcollection name=\"", $sl, "\" shortname=\"", $subcol, "\" />"]);
561      }
562
563      &write_line('COLCFG', ["</indexSubcollectionList>"]);
564      &write_line('COLCFG', ["<defaultIndexSubcollection shortname=\"", $default_subcol, "\" />"]);
565    }
566     
567    # close off search service
568    &write_line('COLCFG', ["</serviceRack>"]);
569
570}
571
572
573sub write_orthogonalsearch_serviceracks
574{
575    my ($buildcfg,$settings) = @_;
576
577    #return if($settings->{'num_indexes'} <= 0);    # no search if no indexes
578   
579    my $infodbtype   = $settings->{'infodbtype'};
580
581    my $orthogonalbuildtypes = $settings->{'orthogonalbuildtypes'};
582
583    foreach my $obt (@$orthogonalbuildtypes) {
584    $obt =~ s/^(.)/\u$1/; # capitialize initial letter
585    $obt =~ s/-(.)/\u$1/g; # change any hyphenated words to cap next letter
586
587    &write_line('COLCFG', ["<serviceRack name=\"GS2", $obt, "Search\">"]);
588
589    &write_line('COLCFG',["<databaseType name=\"",$infodbtype,"\" />"]); 
590    &write_line('COLCFG', ["</serviceRack>"]);
591    }
592}
593
594
595
596sub write_retrieve_servicerack
597{
598    my ($buildcfg,$settings) = @_;
599
600    my $buildtype      = $settings->{'buildtype'};
601    my $infodbtype     = $settings->{'infodbtype'};
602   
603    my $service_type   = $settings->{'service_type'};
604
605    # do the retrieve service
606    &write_line('COLCFG', ["<serviceRack name=\"GS2", $service_type, "Retrieve\">"]);
607
608    # do default index
609    if (defined $buildcfg->{"languagemap"}) {
610    my $default_lang   = $settings->{'default_lang'};
611    &write_line('COLCFG', ["<defaultIndexLanguage shortname=\"", $default_lang, "\" />"]);
612    }
613    if (defined $buildcfg->{'subcollectionmap'}) {
614    my $default_subcol = $settings->{'default_subcol'};
615    &write_line('COLCFG', ["<defaultIndexSubcollection shortname=\"", $default_subcol, "\" />"]);
616    }
617    if ($buildtype eq "mg") {
618    my $defaultindex   = $settings->{'defaultindex'};
619      &write_line('COLCFG', ["<defaultIndex shortname=\"", $defaultindex, "\" />"]);
620    }
621
622    if (defined $buildcfg->{'indexstem'}) {
623      my $indexstem = $buildcfg->{'indexstem'};
624      &write_line('COLCFG', ["<indexStem name=\"", $indexstem, "\" />"]);     
625    }
626    if ($buildtype eq "mgpp" || $buildtype eq "lucene" || $buildtype eq "solr") {
627    my $default_retrieve_level = $settings->{'default_retrieve_level'};
628      &write_line('COLCFG', ["<defaultLevel shortname=\"", $default_retrieve_level, "\" />"]);
629    }
630    if (defined $buildcfg->{'infodbtype'}) {
631        &write_line('COLCFG', ["<databaseType name=\"", $infodbtype, "\" />"]);     
632    }
633
634    &write_line('COLCFG', ["</serviceRack>"]);
635
636}
637
638
639# Create the buildConfig.xml file for a specific collection
640sub write_cfg_file {
641    # this sub is called in make_auxiliary_files() in basebuilder.pm
642    # the received args: $buildoutfile - destination file: buildConfig.xml
643    #                    $buildcfg - all build options,
644    #                    $collectcfg - contents of collectionConfig.xml read in by read_cfg_file sub in buildConfigxml.pm.
645    my ($buildoutfile, $buildcfg, $collectcfg) = @_;
646    my $line = [];
647
648    if (!open (COLCFG, ">$buildoutfile")) {
649    print STDERR "buildConfigxml::write_cfg_file couldn't write the build config file $buildoutfile\n";
650    die;
651    }
652
653    my $settings = search_and_retrieve_settings($buildcfg,$collectcfg);
654
655    my $buildtype = $settings->{'buildtype'};
656    my $orthogonalbuildtypes = $settings->{'orthogonalbuildtypes'};
657    my $numdocs = $settings->{'numdocs'};
658
659    &write_line('COLCFG', ["<buildConfig xmlns:gsf=\"http://www.greenstone.org/greenstone3/schema/ConfigFormat\">"]); 
660
661    # output building metadata to build config file
662    &write_line('COLCFG', ["<metadataList>"]);
663    &write_line('COLCFG', ["<metadata name=\"numDocs\">", $numdocs, "</metadata>"]);
664    &write_line('COLCFG', ["<metadata name=\"buildType\">", $buildtype, "</metadata>"]);
665    foreach my $obt (@$orthogonalbuildtypes) {
666    &write_line('COLCFG', ["<metadata name=\"orthogonalBuildTypes\">", $obt, "</metadata>"]);
667    }
668
669    if (defined $buildcfg->{'indexstem'}) {
670    &write_line('COLCFG', ["<metadata name=\"indexStem\">", $buildcfg->{"indexstem"}, "</metadata>"]);
671    }
672    if (defined $buildcfg->{'infodbtype'}) {
673    &write_line('COLCFG', ["<metadata name=\"infodbType\">", $buildcfg->{"infodbtype"}, "</metadata>"]);
674    }
675    if (defined $buildcfg->{'earliestdatestamp'}) {
676    &write_line('COLCFG', ["<metadata name=\"earliestdatestamp\">", $buildcfg->{"earliestdatestamp"}, "</metadata>"]);
677    }
678
679    &write_line('COLCFG', ["</metadataList>"]);
680
681    # output serviceRackList
682    &write_line('COLCFG', ["<serviceRackList>"]);
683
684    write_search_servicerack($buildcfg,$settings);
685
686    # add in orthogonalbuildtypes
687    write_orthogonalsearch_serviceracks($buildcfg,$settings);
688
689    write_retrieve_servicerack($buildcfg,$settings);
690
691    # do the browse service
692    my $count = 1;
693    my $phind = 0;
694    my $started_classifiers = 0;
695
696    my $classifiers = $collectcfg->{"classify"};
697    foreach my $cl (@$classifiers) {
698      my $name = "CL$count";
699      $count++;
700      my ($classname) = @$cl[0];
701      if ($classname =~ /^phind$/i) {
702    $phind=1;
703    #should add it into coll config classifiers
704    next;
705      }
706     
707      if (not $started_classifiers) {
708    &write_line('COLCFG', ["<serviceRack name=\"GS2Browse\">"]);
709    if (defined $buildcfg->{'indexstem'}) {
710      my $indexstem = $buildcfg->{'indexstem'};
711      &write_line('COLCFG', ["<indexStem name=\"", $indexstem, "\" />"]);     
712    }
713    if (defined $buildcfg->{'infodbtype'}) {
714        my $infodbtype = $buildcfg->{'infodbtype'};
715        &write_line('COLCFG', ["<databaseType name=\"", $infodbtype, "\" />"]);     
716    }
717    &write_line('COLCFG', ["<classifierList>"]);       
718    $started_classifiers = 1;
719      }
720      my $content = ''; #use buttonname first, then metadata
721      if ($classname eq "DateList") {
722    $content = "Date";
723      } else {
724    for (my $j=0; $j<scalar(@$cl); $j++) {
725      my $arg = @$cl[$j];
726      if ($arg eq "-buttonname"){
727        $content = @$cl[$j+1];
728        last;
729      } elsif ($arg eq "-metadata") {
730        $content = @$cl[$j+1];
731      }
732     
733    }
734      }
735      &write_line('COLCFG', ["<classifier name=\"", $name, "\" content=\"", $content, "\" />"]);
736    }     
737    if ($started_classifiers) {
738      # end the classifiers
739      &write_line('COLCFG', ["</classifierList>"]);
740      # close off the Browse service
741      &write_line('COLCFG', ["</serviceRack>"]);
742    }
743   
744    # the phind classifier is a separate service
745    if ($phind) {
746    # if phind classifier
747    &write_line('COLCFG', ["<serviceRack name=\"PhindPhraseBrowse\" />"]);
748    }
749
750   
751    &write_line('COLCFG', ["</serviceRackList>"]);
752    &write_line('COLCFG', ["</buildConfig>"]);
753
754    close (COLCFG);
755  }
756
757
758#########################################################
759
7601;
Note: See TracBrowser for help on using the browser.