source: trunk/gsdl/bin/script/buildcol.pl@ 4873

#!/usr/bin/perl -w

###########################################################################
#
# buildcol.pl -- This program will build a particular collection
# 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.
#
###########################################################################

# 11/04/03 Added usage datastructure - John Thompson

package buildcol;

BEGIN {
    die "GSDLHOME not set\n" unless defined $ENV{'GSDLHOME'};
    die "GSDLOS not set\n" unless defined $ENV{'GSDLOS'};
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib");
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib/plugins");
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib/classify");
}

use colcfg;
use parsargv;
use util;
use FileHandle;
use printusage;

my $mode_list =
    [ { 'name' => "all",
        'desc' => "{buildcol.mode.all}" },
      { 'name' => "compress_text",
        'desc' => "{buildcol.mode.compress_text}" },
      { 'name' => "build_index",
        'desc' => "{buildcol.mode.build_index}" },
      { 'name' => "infodb",
        'desc' => "{buildcol.mode.infodb}" } ];

my $arguments =
    [ { 'name' => "archivedir",
    'desc' => "{buildcol.archivedir}",
    'type' => "string",
    'reqd' => "no" },
      { 'name' => "verbosity",
    'desc' => "{buildcol.verbosity}",
    'type' => "int",
    'deft' => "2",
    'reqd' => "no" },
      { 'name' => "builddir",
    'desc' => "{buildcol.builddir}",
    'type' => "string",
    'reqd' => "no" },
#     { 'name' => "cachedir",
#   'desc' => "{buildcol.cachedir}",
#   'type' => "string",
#   'reqd' => "no" },
      { 'name' => "maxdocs",
    'desc' => "{buildcol.maxdocs}",
    'type' => "int",
    'reqd' => "no" },
      { 'name' => "debug",
    'desc' => "{buildcol.debug}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "mode",
    'desc' => "{buildcol.mode}",
    'type' => "enum",
    'list' => $mode_list,
    'deft' => "all",
    'reqd' => "no" },
      { 'name' => "index",
    'desc' => "{buildcol.index}",
    'type' => "string",
    'reqd' => "no" },
      { 'name' => "keepold",
    'desc' => "{buildcol.keepold}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "no_text",
    'desc' => "{buildcol.no_text}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "allclassifications",
    'desc' => "{buildcol.allclassifications}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "create_images",
    'desc' => "{buildcol.create_images}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "collectdir",
    'desc' => "{buildcol.collectdir}",
    'type' => "string",
    'deft' => &util::filename_cat ($ENV{'GSDLHOME'}, "collect"),
    'reqd' => "no" },
      { 'name' => "out",
    'desc' => "{buildcol.out}",
    'type' => "string",
    'deft' => "STDERR",
    'reqd' => "no" },
      { 'name' => "no_strip_html",
    'desc' => "{buildcol.no_strip_html}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "faillog",
    'desc' => "{buildcol.faillog}",
    'type' => "string",
    'deft' => &util::filename_cat("<collectdir>", "colname", "etc", "fail.log"),
    'reqd' => "no" },
      { 'name' => "language",
    'desc' => "{scripts.language}",
    'type' => "string",
    'reqd' => "no" } ];

my $options = { 'name' => "buildcol.pl",
        'desc' => "PERL script used to build a greenstone collection from GML documents.",
        'args' => $arguments };


sub print_xml_usage
{
    local $language = shift(@_);

    &PrintUsage::print_xml_header();

    print STDERR "<Info>\n";
    print STDERR "  <Name>$options->{'name'}</Name>\n";
    print STDERR "  <Desc>$options->{'desc'}</Desc>\n";
    print STDERR "  <Arguments>\n";
    if (defined($options->{'args'})) {
    &PrintUsage::print_options_xml($language, $options->{'args'});
    }
    print STDERR "  </Arguments>\n";
    print STDERR "</Info>\n";
}


sub print_txt_usage
{
    local $language = shift(@_);

    local $programname = $options->{'name'};
    local $programargs = $options->{'args'};

    # Find the length of the longest option string
    local $descoffset = 0;
    if (defined($programargs)) {
    $descoffset = &PrintUsage::find_longest_option_string($programargs);
    }

    # Produce the usage information using the data structure above
    print STDERR " usage: $programname [options] collection-name\n\n";

    # Display the program options, if there are some
    if (defined($programargs)) {
    # Calculate the column offset of the option descriptions
    local $optiondescoffset = $descoffset + 2;  # 2 spaces between options & descriptions

    print STDERR " options:\n";

    # Display the program options
    &PrintUsage::print_options_txt($language, $programargs, $optiondescoffset);
    }
}


#  sub print_usage {
#      print STDOUT "\n";
#      print STDOUT "buildcol.pl: Builds the indexes of a Greenstone collection.\n\n";
#      print STDOUT "  usage: $0 [options] collection-name\n\n";
#      print STDOUT "  options:\n";
#      print STDOUT "   -verbosity number     0=none, 3=lots\n";
#      print STDOUT "   -archivedir directory Where the archives live\n";
#      print STDOUT "   -builddir directory   Where to put the built indexes\n";
#      print STDOUT "   -maxdocs number       Maximum number of documents to build\n";
#      print STDOUT "   -debug                Print output to STDOUT\n";
#      print STDOUT "   -mode all|compress_text|build_index|infodb\n";
#      print STDOUT "   -index indexname      Index to build (will build all in\n"; 
#      print STDOUT "                         config file if not set)\n";
#      print STDOUT "   -keepold              will not destroy the current contents of the\n";
#      print STDOUT "                         building directory\n";
#      print STDOUT "   -no_text              Don't store compressed text. This option is\n";
#      print STDOUT "                         useful for minimizing the size of the built\n";
#      print STDOUT "                         indexes if you intend always to display the\n";
#      print STDOUT "                         original documents at run time (i.e. you won't\n";
#      print STDOUT "                         be able to retrieve the compressed text version)\n";
#      print STDOUT "   -allclassifications   Don't remove empty classifications\n";
#      print STDOUT "   -create_images        Attempt to create default images for new\n";
#      print STDOUT "                         collection. This relies on the Gimp being\n";
#      print STDOUT "                         installed along with relevant perl modules\n";
#      print STDOUT "                         to allow scripting from perl\n";
#      print STDOUT "   -collectdir directory Collection directory (defaults to " .
#   &util::filename_cat ($ENV{'GSDLHOME'}, "collect") . ")\n";
#      print STDOUT "   -out                  Filename or handle to print output status to.\n";
#      print STDOUT "                         The default is STDERR\n";
#      print STDOUT "   -no_strip_html        Do not strip the html tags from the indexed text\n";
#      print STDOUT "                         (only used for mgpp collections).\n\n";
#      print STDOUT "   -faillog name         Fail log filename. This log receives the filenames\n";
#      print STDOUT "                         of any files which fail to be processed (defaults.\n";
#      print STDOUT "                         to " . 
#   &util::filename_cat("<collectdir>", "colname", "etc", "fail.log") . ")\n";
#      print STDOUT "  [Type \"perl -S buildcol.pl | more\" if this help text scrolled off your screen]";
#      print STDOUT "\n" unless $ENV{'GSDLOS'} =~ /^windows$/i;
#  }


&main();


sub main
{
    my ($verbosity, $archivedir, $cachedir, $builddir, $maxdocs, 
    $debug, $mode, $indexname, $keepold, $allclassifications,
    $create_images, $collectdir, $out, $buildtype, $textindex,
    $no_strip_html, $no_text, $faillog, $language);

    # ***** 11-04-03 - John Thompson *****
    my $xml = 0;
    # ************************************

    # note that no defaults are passed for most options as they're set
    # later (after we check the collect.cfg file)
    if (!parsargv::parse(\@ARGV, 
             'language/.*/', \$language,
             'verbosity/\d+/', \$verbosity,
             'archivedir/.*/', \$archivedir,
             'cachedir/.*/', \$cachedir,  # UNDOCUMENTED
             'builddir/.*/', \$builddir,
             'maxdocs/^\-?\d+/', \$maxdocs,
             'debug', \$debug,
             'mode/^(all|compress_text|build_index|infodb)$/', \$mode,
             'index/.*/', \$indexname,
             'no_text', \$no_text,
             'keepold', \$keepold,
             'allclassifications', \$allclassifications,
             'create_images', \$create_images,
             'collectdir/.*/', \$collectdir,
             'out/.*/STDERR', \$out,
             'no_strip_html', \$no_strip_html,
             'faillog/.*/', \$faillog,
             q^xml^, \$xml)) {
    &print_txt_usage($language);
    die "\n";
    }

    if ($xml) {
        &print_xml_usage($language);
    die "\n";
    }

    $textindex = "";
    my $close_out = 0;
    if ($out !~ /^(STDERR|STDOUT)$/i) {
    open (OUT, ">$out") || die "Couldn't open output file $out\n";
    $out = "buildcol::OUT";
    $close_out = 1;
    }
    $out->autoflush(1);

    # get and check the collection
    if (($collection = &util::use_collection(@ARGV, $collectdir)) eq "") {
    &print_txt_usage($language);
    die "\n";
    }

    if ($faillog eq "") {
    $faillog = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "etc", "fail.log");
    }
    # note that we're appending to the faillog here (import.pl clears it each time)
    # this could potentially create a situation where the faillog keeps being added 
    # to over multiple builds (if the import process is being skipped)
    open (FAILLOG, ">>$faillog") || die "Couldn't open fail log $faillog\n";
    $faillog = 'buildcol::FAILLOG';
    $faillog->autoflush(1);

    # read the configuration file
    $configfilename = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "etc", "collect.cfg");
    if (-e $configfilename) {
    $collectcfg = &colcfg::read_collect_cfg ($configfilename);

    if ($verbosity !~ /\d+/) {
        if (defined $collectcfg->{'verbosity'} && $collectcfg->{'verbosity'} =~ /\d+/) {
        $verbosity = $collectcfg->{'verbosity'};
        } else {
        $verbosity = 2; # the default
        }
    }
    # we use searchtype for determining buildtype, but for old versions, use buildtype
    if (defined $collectcfg->{'searchtype'}) {
        $buildtype = "mgpp";
    }
    elsif (defined $collectcfg->{'buildtype'}) {
        $buildtype = $collectcfg->{'buildtype'};
    } else {
        $buildtype = "mg"; #mg is the default
    }
    if (defined $collectcfg->{'archivedir'} && $archivedir eq "") {
        $archivedir = $collectcfg->{'archivedir'};
    }
    if (defined $collectcfg->{'cachedir'} && $cachedir eq "") {
        $cachedir = $collectcfg->{'cachedir'};
    }
    if (defined $collectcfg->{'builddir'} && $builddir eq "") {
        $builddir = $collectcfg->{'builddir'};
    }
    if ($maxdocs !~ /\-?\d+/) {
        if (defined $collectcfg->{'maxdocs'} && $collectcfg->{'maxdocs'} =~ /\-?\d+/) {
        $maxdocs = $collectcfg->{'maxdocs'};
        } else {
        $maxdocs = -1; # the default
        }
    }
    if (defined $collectcfg->{'debug'} && $collectcfg->{'debug'} =~ /^true$/i) {
        $debug = 1;
    }
    if ($mode !~ /^(all|compress_text|build_index|infodb)$/) {
        if (defined $collectcfg->{'mode'} && $collectcfg->{'mode'} =~ /^(all|compress_text|build_index|infodb)$/) {
        $mode = $collectcfg->{'mode'};
        } else {
        $mode = "all"; # the default
        }
    }
    if (defined $collectcfg->{'index'} && $indexname eq "") {
        $indexname = $collectcfg->{'index'};
    }
    if (defined $collectcfg->{'no_text'} && $no_text == 0) {
        if ($collectcfg->{'no_text'} =~ /^true$/i) {
        $no_text = 1;
        }
    }
    if (defined $collectcfg->{'allclassifications'} && $allclassifications == 0) {
        if ($collectcfg->{'allclassifications'} =~ /^true$/i) {
        $allclassifications = 1;
        }
    }
    if (defined $collectcfg->{'keepold'} && $collectcfg->{'keepold'} =~ /^true$/i) {
        $keepold = 1;
    }
    if (defined $collectcfg->{'create_images'} && $collectcfg->{'create_images'} =~ /^true$/i) {
        $create_images = 1;
    }
    if ($buildtype eq "mgpp" && defined $collectcfg->{'textcompress'}) {
        $textindex = $collectcfg->{'textcompress'};
    }
    
    } else {
    die "Couldn't find the configuration file $configfilename\n";
    }
        
    #set the text index
    if ($buildtype eq "mgpp") {
    if ($textindex eq "") {
        $textindex = "text";
    }
    }
    else {
    $textindex = "section:text";
    }

    # create default images if required
    if ($create_images) {
    my $collection_name = $collection;
    $collection_name = $collectcfg->{'collectionmeta'}->{'collectionname'}->{'default'}
    if defined $collectcfg->{'collectionmeta'}->{'collectionname'}->{'default'};
    &create_images ($collection_name);
    }

    # fill in the default archives and building directories if none
    # were supplied, turn all \ into / and remove trailing /
    $archivedir = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "archives") if $archivedir eq "";
    $archivedir =~ s/[\\\/]+/\//g;
    $archivedir =~ s/\/$//;
    $builddir = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "building") if $builddir eq "";
    $builddir =~ s/[\\\/]+/\//g;
    $builddir =~ s/\/$//;

    # update the archive cache if needed
    if ($cachedir) {
    print $out "Updating archive cache\n" if ($verbosity >= 1);

    $cachedir =~ s/[\\\/]+$//;
    $cachedir .= "/collect/$collection" unless 
        $cachedir =~ /collect\/$collection/;

    $realarchivedir = "$cachedir/archives";
    $realbuilddir = "$cachedir/building";
    &util::mk_all_dir ($realarchivedir);
    &util::mk_all_dir ($realbuilddir);
    &util::cachedir ($archivedir, $realarchivedir, $verbosity);

    } else {
    $realarchivedir = $archivedir;
    $realbuilddir = $builddir;
    }

    # build it in realbuilddir
    &util::mk_all_dir ($realbuilddir);


    # if a builder class has been created for this collection, use it
    # otherwise, use the mg or mgpp builder
    if (-e "$ENV{'GSDLCOLLECTDIR'}/perllib/${collection}builder.pm") {
    $builderdir = "$ENV{'GSDLCOLLECTDIR'}/perllib";
    $buildertype = "${collection}builder";
    } else {
    $builderdir = "$ENV{'GSDLHOME'}/perllib";
    if ($buildtype eq "mgpp") {
        $buildertype = "mgppbuilder";
    }
    else {
        $buildertype = "mgbuilder";
    }
    }
    
    require "$builderdir/$buildertype.pm";

    eval("\$builder = new $buildertype(\$collection, " .
     "\$realarchivedir, \$realbuilddir, \$verbosity, " .
     "\$maxdocs, \$debug, \$keepold, \$allclassifications, " .
     "\$out, \$no_text, \$faillog)");
    die "$@" if $@;

    $builder->init();

    if ($buildertype eq "mgppbuilder" && $no_strip_html) {
    $builder->set_strip_html(0);
    }
    if ($mode =~ /^all$/i) {
    $builder->compress_text($textindex);
    $builder->build_indexes($indexname);
    $builder->make_infodatabase();
    $builder->collect_specific();
    } elsif ($mode =~ /^compress_text$/i) {
    $builder->compress_text($textindex);
    } elsif ($mode =~ /^build_index$/i) {
    $builder->build_indexes($indexname);    
    } elsif ($mode =~ /^infodb$/i) {
    $builder->make_infodatabase();
    } else {
    die "unknown mode: $mode\n";
    }

    $builder->make_auxiliary_files() if !$debug;
    $builder->deinit();
    
    if (($realbuilddir ne $builddir) && !$debug) {
    print $out "Copying back the cached build\n" if ($verbosity >= 1);
    &util::rm_r ($builddir);
    &util::cp_r ($realbuilddir, $builddir);
    }

    close OUT if $close_out;
    close FAILLOG;
}

sub create_images {
    my ($collection_name) = @_;

    my $image_script = &util::filename_cat ($ENV{'GSDLHOME'}, "bin", "script", "gimp", "title_icon-1.2.pl");
    if (!-e $image_script) {
    print $out "WARNING: Image making script ($image_script) could not be found\n";
    print $out "         Default images will not be generated\n\n";
    return;
    }

    my $imagedir = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "images");

    &util::mk_all_dir ($imagedir);

    # create the images
    system ("$image_script -size 1.5 -image_dir \"$imagedir\" -filename $collection.gif -text \"$collection_name\"");
    system ("$image_script -image_dir \"$imagedir\" -filename ${collection}sm.gif -text \"$collection_name\"");

    # update the collect.cfg configuration file (this will need
    # to be changed when the config file format changes)
    if (!open (CFGFILE, $configfilename)) {
    print $out "WARNING: Couldn't open config file ($configfilename)\n";
    print $out "         for updating so collection images may not be linked correctly\n";
    return;
    }

    my $line = ""; my $file = "";
    my $found = 0; my $foundsm = 0;
    while (defined ($line = <CFGFILE>)) {
    if ($line =~ /collectionmeta\s+iconcollection\s+/) {
        $line = "collectionmeta iconcollection _httpprefix_/collect/$collection/images/$collection.gif\n";
        $found = 1;
    } elsif ($line =~ /collectionmeta\s+iconcollectionsmall\s+/) {
        $line = "collectionmeta iconcollectionsmall _httpprefix_/collect/$collection/images/${collection}sm.gif\n";
        $foundsm = 1;
    }
    $file .= $line;
    }
    close CFGFILE;

    $file .= "collectionmeta iconcollection _httpprefix_/collect/$collection/images/$collection.gif\n" if !$found;
    $file .= "collectionmeta iconcollectionsmall _httpprefix_/collect/$collection/images/${collection}sm.gif\n" if !$foundsm;

    if (!open (CFGFILE, ">$configfilename")) {
    print $out "WARNING: Couldn't open config file ($configfilename)\n";
    print $out "         for updating so collection images may not be linked correctly\n";
    return;
    }
    print CFGFILE $file;
    close CFGFILE;
}