source: main/tags/2.52/gsdl/perllib/colcfg.pm@ 25422

###########################################################################
#
# colcfg.pm --
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the 
# University of Waikato, New Zealand.
#
# Copyright (C) 1999 New Zealand Digital Library Project
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
###########################################################################

# reads in a collection configuration file

package colcfg;

use cfgread;


# the collection configuration file data is stored in the form
#
# {'creator'}->string
# {'public'}->string
# {'defaultindex'}->string
# {'importdir'}->string
# {'archivedir'}->string
# {'cachedir'}->string
# {'builddir'}->string
# {'removeold'}->string
# {'textcompress'}->string
# {'buildtype'}->string
# {'maxnumeric'}->string
# {'separate_cjk'}->string

# {'maintainer'}->array of strings
# {'languages'}->array of strings
# {'indexsubcollections'}->array of strings
# {'indexes'}->array of strings
# {'dontbuild'}->array of strings
# {'dontgdbm'}->array of strings
# {'mirror'}->array of strings
# {'phind'}->array of strings
# {'levels'}->array of strings (for mgpp eg Section, Paragraph)
# {'searchtype'}->array of strings (for mgpp, form or plain)

# {'subcollection'}->hash of key-value pairs

# {'acquire'}->array of arrays of strings
# {'plugin'}->array of arrays of strings
# {'classify'}->array of arrays of strings

# {'collectionmeta'}->hash of key->hash of param-value -used 
# for language specification
#    for example, collectionmeta->collectionname->default->demo
#                                               ->mi->maori demo

sub read_collect_cfg {
    my ($filename) = @_;

    return &cfgread::read_cfg_file ($filename, 
                    q/^(creator|public|defaultindex|importdir|/ .
                    q/archivedir|cachedir|builddir|removeold|/ .
                    q/textcompress|buildtype|no_text|keepold|gzip/ .
                    q/verbosity|remove_empty_classifications|OIDtype|maxdocs|/ .
                    q/groupsize|sortmeta|debug|mode|create_images|/ .
                    q/maxnumeric|separate_cjk)$/,
                    q/(maintainer|languages|indexsubcollections|/ .
                       q/indexes|dontbuild|dontgdbm|mirror|phind|levels|searchtype)$/,
                    q/^(subcollection|format)$/,
                    q/^(acquire|plugin|classify)$/,
                    q/^(collectionmeta)$/);
}

sub write_collect_cfg {
    my ($filename, $data) = @_;
    
    &cfgread::write_cfg_file($filename, $data,
                 q/^(creator|public|defaultindex|importdir|/ .
                 q/archivedir|cachedir|builddir|removeold|/ .
                 q/textcompress|buildtype|collectdir|no_text|/ .
                 q/remove_empty_classifications|maxnumeric|separate_cjk)$/,
                 q/^(maintainer|languages|indexsubcollections|/ .
                 q/indexes|dontbuild|dontgdbm|levels|searchtype)$/,
                 q/^(subcollection)$/,
                 q/^(acquire|plugin|classify)$/,
                 q/^(collectionmeta)$/);
}


# the build configuration file data is stored in the form
#
# {'builddate'}->string
# {'buildtype'}->string
# {'metadata'}->array of strings
# {'languages'}->array of strings
# {'numdocs'}->string
# {'numwords'}->string
# {'numbytes'}->string
# {'maxnumeric'}->string
# {'indexfields'}->array of strings
# {'indexfieldmap'}->array of strings in the form "field->FI"
# {'indexmap'} -> array of strings
# {'indexlevels'} -> array of strings
# {'textlevel'}->string
sub read_build_cfg {
    my ($filename) = @_;

    return &cfgread::read_cfg_file ($filename, 
                    q/^(builddate|buildtype|numdocs|numwords|numbytes|maxnumeric|textlevel)$/, 
                    q/^(metadata|languages|indexfields|indexfieldmap|indexmap|indexlevels)$/);
}

sub write_build_cfg {
    my ($filename, $data) = @_;

    &cfgread::write_cfg_file($filename, $data,
           q/^(builddate|buildtype|numdocs|numwords|numbytes|maxnumeric|textlevel)$/, 
           q/^(metadata|languages|indexfieldsindexfieldmap|indexmap|indexlevels)$/);
}


1;