source: gsdl/trunk/bin/script/export.pl@ 19625

#!/usr/bin/perl -w

###########################################################################
#
# export.pl --
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the 
# University of Waikato, New Zealand.
#
# Copyright (C) 2004 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.
#
###########################################################################


# This program will export a particular collection into a specific Format (e.g. METS or DSpace)

package export;

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/cpan");
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib/plugins");
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib/plugouts");

    if (defined $ENV{'GSDLEXTS'}) {
    my @extensions = split(/:/,$ENV{'GSDLEXTS'});
    foreach my $e (@extensions) {
        my $ext_prefix = "$ENV{'GSDLHOME'}/ext/$e";

        unshift (@INC, "$ext_prefix/perllib");
        unshift (@INC, "$ext_prefix/perllib/cpan");
        unshift (@INC, "$ext_prefix/perllib/plugins");
        unshift (@INC, "$ext_prefix/perllib/plugouts");
    }
    }
}

use strict;
no strict 'refs'; # allow filehandles to be variables and vice versa
no strict 'subs'; # allow barewords (eg STDERR) as function arguments

use arcinfo;
use colcfg;
use plugin;
use plugout;
use manifest;
use util;
use scriptutil;
use FileHandle;
use gsprintf 'gsprintf';
use printusage;
use parse2;


my $oidtype_list = 
    [ { 'name' => "hash",
        'desc' => "{import.OIDtype.hash}" },
      { 'name' => "assigned",
        'desc' => "{import.OIDtype.assigned}" },
      { 'name' => "incremental",
        'desc' => "{import.OIDtype.incremental}" },
      { 'name' => "dirname",
        'desc' => "{import.OIDtype.dirname}" } ];

# what format to export as
my $saveas_list = 
    [ { 'name' => "GreenstoneMETS",
        'desc' => "{export.saveas.GreenstoneMETS}"},
      { 'name' => "FedoraMETS",
        'desc' => "{export.saveas.FedoraMETS}"},
      { 'name' => "MARCXML",
        'desc' => "{export.saveas.MARCXML}"},
      { 'name' => "DSpace",
        'desc' => "{export.saveas.DSpace}" }
     ];


# Possible attributes for each argument
# name: The name of the argument
# desc: A description (or more likely a reference to a description) for this argument
# type: The type of control used to represent the argument. Options include: string, int, flag, regexp, metadata, language, enum etc
# reqd: Is this argument required?
# hiddengli: Is this argument hidden in GLI?
# modegli: The lowest detail mode this argument is visible at in GLI

my $saveas_argument =
      { 'name' => "saveas",
    'desc' => "{export.saveas}",
    'type' => "enum",
    'list' => $saveas_list,
    'deft' => "GreenstoneMETS",
    'reqd' => "no",
    'modegli' => "3" };


my $arguments = 
    [ 
      $saveas_argument,
      { 'name' => "exportdir",
    'desc' => "{export.exportdir}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "importdir",
    'desc' => "{import.importdir}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "collectdir",
    'desc' => "{export.collectdir}",
    'type' => "string",
    # parsearg left "" as default
    #'deft' => &util::filename_cat ($ENV{'GSDLHOME'}, "collect"),
    'deft' => "",
    'reqd' => "no",
    'hiddengli' => "yes" },
      { 'name' => "site",
    'desc' => "{import.site}",
    'type' => "string",
    'deft' => "",
    'reqd' => "no",
        'hiddengli' => "yes" },
     { 'name' => "manifest",
    'desc' => "{import.manifest}",
    'type' => "string",
    'deft' => "",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "listall",
    'desc' => "{export.listall}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "debug",
    'desc' => "{export.debug}",
    'type' => "flag",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "faillog",
    'desc' => "{export.faillog}",
    'type' => "string",
    'deft' => "",
    'reqd' => "no",
        'modegli' => "3" },
      # does this make sense?
#      { 'name' => "incremental",
#   'desc' => "{import.incremental}",
#   'type' => "flag",
#   'hiddengli' => "yes" },
      { 'name' => "keepold",
    'desc' => "{export.keepold}",
    'type' => "flag",
    'reqd' => "no",
    'hiddengli' => "yes" },
      { 'name' => "removeold",
    'desc' => "{export.removeold}",
    'type' => "flag",
    'reqd' => "no",
    'modegli' => "3" },
      { 'name' => "language",
    'desc' => "{scripts.language}",
    'type' => "string",
    'reqd' => "no",
    'modegli' => "3" },
      { 'name' => "maxdocs",
    'desc' => "{export.maxdocs}",
    'type' => "int",
    'reqd' => "no",
    'range' => "1,",
    'modegli' => "1" },
      { 'name' => "OIDtype",
    'desc' => "{import.OIDtype}",
    'type' => "enum",
    'list' => $oidtype_list,
    # parsearg left "" as default
    #'deft' => "hash",
    'reqd' => "no",
    'modegli' => "2" },
      { 'name' => "OIDmetadata",
    'desc' => "{import.OIDmetadata}",
    'type' => "string",
    #'type' => "metadata", #doesn't work properly in GLI
    'deft' => "dc.Identifier",
    'reqd' => "no",
    'modegli' => "2" },
      { 'name' => "out",
    'desc' => "{export.out}",
    'type' => "string",
    'deft' => "STDERR",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "statsfile",
    'desc' => "{export.statsfile}",
    'type' => "string",
    'deft' => "STDERR",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "xsltfile",
    'desc' => "{BasPlugout.xslt_file}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "yes" },
      { 'name' => "xslt_txt",
    'desc' => "{METSPlugout.xslt_txt}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "no" },
      { 'name' => "xslt_mets",
    'desc' => "{METSPlugout.xslt_mets}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "no" },
      { 'name' => "fedora_namespace",
    'desc' => "{FedoraMETSPlugout.fedora_namespace}",
    'type' => "string",
    'deft' => "greenstone",
    'reqd' => "no",
        'hiddengli' => "no" },
      { 'name' => "mapping_file",
    'desc' => "{MARCXMLPlugout.mapping_file}",
    'type' => "string",
    'reqd' => "no",
        'hiddengli' => "no" },
      { 'name' => "group_marc",
    'desc' => "{MARCXMLPlugout.group}",
    'type' => "flag",
    'reqd' => "no",
        'hiddengli' => "no" },
      { 'name' => "verbosity",
    'desc' => "{export.verbosity}",
    'type' => "int",
    'range' => "0,3",
    'deft' => "2",
    'reqd' => "no",
    'modegli' => "3" },
      { 'name' => "gli",
    'desc' => "{scripts.gli}",
    'type' => "flag",
    'reqd' => "no",
    'hiddengli' => "yes" },
      { 'name' => "xml",
    'desc' => "{scripts.xml}",
    'type' => "flag",
    'reqd' => "no",
    'hiddengli' => "yes" }
      ];

my $options = { 'name' => "export.pl",
        'desc' => "{export.desc}",
        'args' => $arguments };

my $listall_options = { 'name' => "export.pl",
                'desc' => "{export.desc}",
                'args' => [ $saveas_argument ] };


&main();

sub main {
    # params
    my ($language, $verbosity, $debug,
    $collectdir, $importdir, $exportdir, $site, $manifest, 
    $incremental, $keepold, $removeold,
    $saveas,
    $OIDtype, $OIDmetadata,
    $maxdocs, $statsfile, 
    $out, $faillog, $gli, $listall, 
    # plugout specific ones
    $mapping_file, $xsltfile, 
    $xslt_mets, $xslt_txt, $fedora_namespace, $group_marc);

    my $xml = 0;
    
    # other vars
    my ($configfilename, $collection, $collectcfg,
    $expinfo_doc_filename, $export_info, 
    $gs_mode, 
    $processor, $pluginfo);

    my $service = "export";

    my $hashParsingResult = {};
    # general options available to all plugins
    my $intArgLeftinAfterParsing = parse2::parse(\@ARGV,$arguments,$hashParsingResult,"allow_extra_options");
    
    # If parse returns -1 then something has gone wrong
    if ($intArgLeftinAfterParsing == -1)
    {
    &PrintUsage::print_txt_usage($options, "{export.params}");
    die "\n";
    }

    foreach my $strVariable (keys %$hashParsingResult)
    {
    eval "\$$strVariable = \$hashParsingResult->{\"\$strVariable\"}";
    }

    
    # these are options used by other things - we just set default values
    # undef means will be set from config file if there
    my $gzip = undef; 

    # If $language has been specified, load the appropriate resource bundle
    # (Otherwise, the default resource bundle will be loaded automatically)
    if ($language && $language =~ /\S/) {
    &gsprintf::load_language_specific_resource_bundle($language);
    }

    if ($listall) {
    if ($xml) {
        &PrintUsage::print_xml_usage($listall_options);
    }
    else
    {
        &PrintUsage::print_txt_usage($listall_options,"{export.params}");
    }
    die "\n";
    }
    
    if ($xml) {
        &PrintUsage::print_xml_usage($options);
    die "\n";
    }

    if ($gli) { # the gli wants strings to be in UTF-8
    &gsprintf::output_strings_in_UTF8; 
    }

    # now check that we had exactly one leftover arg, which should be 
    # the collection name. We don't want to do this earlier, cos 
    # -xml arg doesn't need a collection name
    # Or if the user specified -h, then we output the usage also
    if ($intArgLeftinAfterParsing != 1 || (@ARGV && $ARGV[0] =~ /^\-+h/))
    {
    &PrintUsage::print_txt_usage($options, "{export.params}");
    die "\n";
    }

    my $close_out = 0;
    if ($out !~ /^(STDERR|STDOUT)$/i) {
    open (OUT, ">$out") ||
        (&gsprintf(STDERR, "{common.cannot_open_output_file}\n", $out) && die);
    $out = 'export::OUT';
    $close_out = 1;
    }
    $out->autoflush(1);

    # get and check the collection name
    if (($collection = &colcfg::use_collection($site, @ARGV, $collectdir)) eq "") {
    &PrintUsage::print_txt_usage($options, "{export.params}");
    die "\n";
    }
    # add collection's perllib dir  into include path in 
    # case we have collection specific modules
    unshift (@INC, "$ENV{'GSDLCOLLECTDIR'}/perllib");
    
    # check that we can open the faillog
    if ($faillog eq "") {
    $faillog = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "etc", "fail.log");
    }
    open (FAILLOG, ">$faillog") ||
    (&gsprintf(STDERR, "{export.cannot_open_fail_log}\n", $faillog) && die);
    my $faillogname = $faillog;
    $faillog = 'export::FAILLOG';
    $faillog->autoflush(1);
        
    # Read in the collection configuration file.
    ($configfilename, $gs_mode) = &colcfg::get_collect_cfg_name($out);
        
    
    # Read in the collection configuration file.
    ($configfilename, $gs_mode) = &colcfg::get_collect_cfg_name($out);
    
    if ($gs_mode eq "gs2") {
    $collectcfg = &colcfg::read_collect_cfg ($configfilename);
    } elsif ($gs_mode eq "gs3") {
    $collectcfg = &colcfg::read_collection_cfg_xml ($configfilename);
    }

    if (defined $collectcfg->{'importdir'} && $importdir eq "") {
    $importdir = $collectcfg->{'importdir'};
    }
    if (defined $collectcfg->{'exportdir'} && $exportdir eq "") {
    $exportdir = $collectcfg->{'exportdir'};
    }

    # fill in the default import and export directories if none
    # were supplied, turn all \ into / and remove trailing /
    $importdir = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "import") if $importdir eq "";
    $importdir =~ s/[\\\/]+/\//g;
    $importdir =~ s/\/$//;
    if (!-e $importdir) {
    &gsprintf($out, "{import.no_import_dir}\n\n", $importdir);
    die "\n";
    }

    $exportdir = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, "export") if $exportdir eq "";
    $exportdir =~ s/[\\\/]+/\//g;
    $exportdir =~ s/\/$//;
    
    my $plugins = [];
    if (defined $collectcfg->{'plugin'}) {
    $plugins = $collectcfg->{'plugin'};
    }
    # some global options for the plugins           
    my @global_opts = ();

    if ($verbosity !~ /\d+/) {
    if (defined $collectcfg->{'verbosity'} && $collectcfg->{'verbosity'} =~ /\d+/) {
        $verbosity = $collectcfg->{'verbosity'};
    } else {
        $verbosity = 2; # the default
    }
    }
    
    if (defined $collectcfg->{'gzip'} && !$gzip) {
    if ($collectcfg->{'gzip'} =~ /^true$/i) {
        $gzip = 1;
    }
    }
    if ($maxdocs !~ /\-?\d+/) {
    if (defined $collectcfg->{'maxdocs'} && $collectcfg->{'maxdocs'} =~ /\-?\d+/) {
        $maxdocs = $collectcfg->{'maxdocs'};
    } else {
        $maxdocs = -1; # the default
    }
    }
    
    if (!defined $OIDtype || ($OIDtype !~ /^(hash|incremental|assigned|dirname)$/)) {
    if (defined $collectcfg->{'OIDtype'} && $collectcfg->{'OIDtype'} =~ /^(hash|incremental|assigned|dirname)$/) {
        $OIDtype = $collectcfg->{'OIDtype'};
    } else {
        $OIDtype = "hash"; # the default
    }
    }

    if (defined $collectcfg->{'debug'} && $collectcfg->{'debug'} =~ /^true$/i) {
    $debug = 1;
    }
    if (defined $collectcfg->{'gli'} && $collectcfg->{'gli'} =~ /^true$/i) {
    $gli = 1;
    }
    $gli = 0 unless defined $gli;

    # check keepold and removeold
    ($removeold, $keepold, $incremental) = &scriptutil::check_removeold_and_keepold($removeold, $keepold, $incremental, "export", $collectcfg);

    print STDERR "<export>\n" if $gli;
    
    my $manifest_lookup = new manifest();
    if ($manifest ne "") {  
    my $manifest_filename = $manifest;

    if ($manifest_filename !~ m/^[\\\/]/) {
        $manifest_filename = &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, $manifest_filename);
    }

    $manifest =~ s/[\\\/]+/\//g;
    $manifest =~ s/\/$//;

    $manifest_lookup->parse($manifest_filename);
    }
    
    # load all the plugins
    $pluginfo = &plugin::load_plugins ($plugins, $verbosity, $out, $faillog, \@global_opts);
        
    if (scalar(@$pluginfo) == 0) {
    &gsprintf($out, "{import.no_plugins_loaded}\n");
    die "\n";
    }
    
    # remove the old contents of the export directory if needed
    if ($removeold && -e $exportdir) {
    &gsprintf($out, "{export.removing_export}\n");
    &util::rm_r ($exportdir);
    }
    
    # create the export dir if needed
    &util::mk_all_dir($exportdir);
    
    # read the export information file
    # If saveas=DSpace, a "contents" file will be created, otherwise "export.inf"
    
    # the plugouts should be doing this!!
    if ($saveas eq "DSpace"){
    $expinfo_doc_filename = &util::filename_cat ($exportdir, "contents");
    } elsif ($saveas =~ m/^.*METS$/ || $saveas eq "MARC" ) {
##  $expinfo_doc_filename = &util::filename_cat ($exportdir, "export.inf");
    my $doc_db = "archiveinf-doc";
    $expinfo_doc_filename = &util::filename_cat ($exportdir, $doc_db);
    &util::rename_gdbm_file($expinfo_doc_filename); # ensures gdb in case we have an existing legacy ldb one - can this happen?
    $expinfo_doc_filename .= ".gdb";

    }
        
    $export_info = new arcinfo();
    $export_info -> load_info ($expinfo_doc_filename);  
        
    my ($plugout); 
    if (defined $collectcfg->{'plugout'} && $collectcfg->{'plugout'} =~ /^(.*METS|DSpace|MARCXML)Plugout/) {
    $plugout = $collectcfg->{'plugout'};
    }
    else{
    if ($saveas !~ /^(.*METS|DSpace|MARCXML)$/) {
        push @$plugout,"GreenstoneMETSPlugout";
    }
    else{
        push @$plugout,$saveas."Plugout";
    }
    }
    
    my $plugout_name = $plugout->[0];
        
    push @$plugout,("-output_info",$export_info) if (defined $export_info); 
    push @$plugout,("-verbosity",$verbosity) if (defined $verbosity);
    push @$plugout,("-debug") if ($debug);
    push @$plugout,("-gzip_output",$gzip) if (defined $gzip);
    push @$plugout,("-output_handle",$out) if (defined $out);
    push @$plugout,("-xslt_file",$xsltfile) if (defined $xsltfile);
    push @$plugout,("-group") if ($group_marc && $plugout_name =~ m/^MARCXMLPlugout$/);
    push @$plugout,("-mapping_file",$mapping_file) if (defined $mapping_file && $plugout_name =~ m/^MARCXMLPlugout$/);
    push @$plugout,("-xslt_mets",$xslt_mets) if (defined $xslt_mets && $plugout_name =~ m/^.*METSPlugout$/);
    push @$plugout,("-xslt_txt",$xslt_txt) if (defined $xslt_txt && $plugout_name =~ m/^.*METSPlugout$/);
    push @$plugout,("-fedora_namespace",$fedora_namespace) if (defined $fedora_namespace && $plugout_name eq "FedoraMETSPlugout");
    
    $processor = &plugout::load_plugout($plugout);    
    $processor->setoutputdir ($exportdir);
        
    $processor->set_OIDtype ($OIDtype, $OIDmetadata);
        
    &plugin::begin($pluginfo, $importdir, $processor, $maxdocs, $gli);
        
    if ($manifest eq "") {
    # process the import directory
    my $block_hash = {};
    my $metadata = {};
    # gobal blocking pass may set up some metadata
    &plugin::file_block_read($pluginfo, $importdir, "", $block_hash, $metadata, $gli);
    &plugin::read ($pluginfo, $importdir, "", $block_hash, $metadata, $processor, $maxdocs, 0, $gli);
    } 
    else {
    # process any files marked for exporting
    foreach my $file (keys %{$manifest_lookup->{'index'}}) {
        &plugin::read ($pluginfo, $importdir, $file, {}, {}, $processor, $maxdocs, 0, $gli);
    }
    }

    if ($saveas eq "FedoraMETS") {
    # create collection "doc obj" for Fedora that contains
    # collection-level metadata
    
    my $doc_obj = new doc($configfilename,"nonindexed_doc");
    $doc_obj->set_OID("collection");
    
    my $col_name = undef;
    my $col_meta = $collectcfg->{'collectionmeta'};
    
    if (defined $col_meta) {
        
        store_collectionmeta($col_meta,"collectionname",$doc_obj); # in GS3 this is a collection's name
        store_collectionmeta($col_meta,"collectionextra",$doc_obj); # in GS3 this is a collection's description
        
    }
    $processor->process($doc_obj);
    }
        
    &plugin::end($pluginfo, $processor);

    &plugin::deinit($pluginfo, $processor);
        
    # write out the export information file
    #$processor->close_file_output() if $groupsize > 1;
    $processor->close_group_output() if $processor->is_group();

    if (($saveas =~ m/^.*METS$/) || ($saveas eq "MARC")) {
    # Not all export types need this (e.g. DSpace)
    $export_info->save_info($expinfo_doc_filename);
    }
        
    # write out export stats
    my $close_stats = 0;
    if ($statsfile !~ /^(STDERR|STDOUT)$/i) {
    if (open (STATS, ">$statsfile")) {
        $statsfile = 'import::STATS';
        $close_stats = 1;
    } else {
        &gsprintf($out, "{import.cannot_open_stats_file}", $statsfile);
        &gsprintf($out, "{import.stats_backup}\n");
        $statsfile = 'STDERR';
    }
    }

    &gsprintf($out, "\n");
    &gsprintf($out, "*********************************************\n");
    &gsprintf($out, "{export.complete}\n");
    &gsprintf($out, "*********************************************\n");
   
    &plugin::write_stats($pluginfo, $statsfile, $faillogname, $gli);
    if ($close_stats) {
    close STATS;
    }
    
    close OUT if $close_out;
    close FAILLOG;
}


sub store_collectionmeta
{
    my ($collectionmeta,$field,$doc_obj) = @_;

    my $section = $doc_obj->get_top_section();

    my $field_hash = $collectionmeta->{$field};

    foreach my $k (keys %$field_hash) 
    {
    my $val = $field_hash->{$k};

    ### print STDERR "*** $k = $field_hash->{$k}\n";

    my $md_label = "ex.$field";


    if ($k =~ m/^\[l=(.*?)\]$/)
    {

        my $md_suffix = $1;
        $md_label .= "^$md_suffix";
    }


    $doc_obj->add_utf8_metadata($section,$md_label, $val);
    
    # see cfgread4gs3.pm: GS2's "collectionextra" is called "description" in GS3,
    # while "collectionname" in GS2 is called "name" in GS3.
    # Variable $nameMap variable in cfgread4gs3.pm maps between GS2 and GS3
    if (($md_label eq "ex.collectionname^en") || ($md_label eq "ex.collectionname"))
    {
        $doc_obj->add_utf8_metadata($section,"dc.Title", $val);
    }

    }
}