source: trunk/gsdl/perllib/plugins/MARCPlug.pm@ 7243

###########################################################################
#
# MARCPlug.pm -- basic MARC plugin
#
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the 
# University of Waikato, New Zealand.
#
# Copyright (C) 2002 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.
#
###########################################################################

package MARCPlug;

use SplitPlug;

use unicode;
use util;
use parsargv;

sub BEGIN {
    @ISA = ('SplitPlug');
    unshift (@INC, "$ENV{'GSDLHOME'}/perllib/cpan");
}

my $arguments = 
    [ { 'name' => "metadata_mapping",
    'desc' => "{MARCPlug.metadata_mapping}",
    'type' => "string",
    'deft' => "marctodc.txt",
    'reqd' => "no" },
      { 'name' => "process_exp",
    'desc' => "{BasPlug.process_exp}",
    'type' => "regexp",
    'reqd' => "no",
    'deft' => &get_default_process_exp() },
      { 'name' => "split_exp",
    'desc' => "{SplitPlug.split_exp}",
    'type' => "regexp",
    'reqd' => "no",
    'deft' => &get_default_split_exp() } 
      ];

my $options = { 'name'     => "MARCPlug",
        'desc'     => "{MARCPlug.desc}",
        'abstract' => "no",
        'inherits' => "Yes",
        'args'     => $arguments };

require MARC::Record;  
require MARC::Batch;  
#use MARC::Record;  
#use MARC::Batch;

#  sub print_usage {
#      print STDERR "\n  usage: plugin MARCPlug [options]\n\n";
#      print STDERR "  options:\n";
#      print STDERR 
#  "   -metadata_mapping  Name of file that includes mapping details from MARC
#                        values to Greenstone metadata names. Defaults to
#                        'marctodc.txt' found in the site's etc directory.\n\n";
#  }

sub new {
    my $class = shift (@_);
    my $self = new SplitPlug ($class, @_);
    $self->{'plugin_type'} = "MARCPlug";
    my $metadata_mapping;

    if (!parsargv::parse(\@_, 
             q^metadata_mapping/.*/marctodc.txt^, \$metadata_mapping,
             "allow_extra_options")) {

    print STDERR "\nIncorrect options passed to MARCPlug, check your collect.cfg configuration file\n";
    $self->print_txt_usage("");  # Use default resource bundle
    die "\n";
    }


    $self->{'mm_file'} = $metadata_mapping; # relative to etc dir

    # 14-05-02 To allow for proper inheritance of arguments - John Thompson
    my $option_list = $self->{'option_list'};
    push( @{$option_list}, $options );

    return bless $self, $class;
}

sub init {
    my $self = shift (@_);
    my ($verbosity, $outhandle, $failhandle) = @_;

    my @metadata_mapping = ();

    # read in the metadata mapping file
    my $mm_file =
    &util::filename_cat( $ENV{'GSDLHOME'}, "etc", $self->{'mm_file'} );

    if (!-e $mm_file)
    {

    my $msg = "MARCPlug ERROR: Can't locate mapping file \"" .
        $self->{'mm_file'} . "\".\n    This file should be at $mm_file\n" .
        "    No marc files can be processed.\n";

    print $outhandle $msg;
    print $failhandle $msg;
    $self->{'mm_file'} = undef;
    # We pick up the error in process() if there is no $mm_file
    # If we exit here, then pluginfo.pl will exit too!
    }
    elsif (open(MMIN, "<$mm_file"))
    {
    my $l=1;
    my $line;
    while (defined($line=<MMIN>))
    {
        chomp $line;
        if ($line =~ m/^(\d+)\s*->\s*(\w+)$/)
        {
        my $marc_info = $1;
        my $gsdl_info = $2;
        my $mapping = { 'marc' => $marc_info, 'gsdl' => $gsdl_info };
        push(@metadata_mapping,$mapping);
        }
        elsif ($line !~ m/^\#/       # allow comments (# in first column)
           && $line !~ m/^\s*$/) # allow blank lines
        {
        print $outhandle "Parse error on line $l of $mm_file:\n";
        print $outhandle "  \"$line\"\n";
        }
        $l++
    }
    close(MMIN);
    }
    else
    {
    print STDERR "Unable to open $mm_file: $!\n";
    }

    $self->{'metadata_mapping'} = \@metadata_mapping;

    $self->SUPER::init(@_);
}
    

sub get_default_process_exp {
    my $self = shift (@_);

    return q^(?i)(\.marc)$^;
}


sub get_default_split_exp {
    # \r\n for msdos eol, \n for unix
    return q^\r?\n\s*\r?\n^;
}



# The bulk of this function is based on read_line in multiread.pm
# Unable to use read_line original because it expects to get its input
# from a file.  Here the line to be converted is passed in as a string

sub to_utf8
{
    my $self = shift (@_);
    my ($encoding, $line) = @_;

    if ($encoding eq "iso_8859_1") {
    # we'll use ascii2utf8() for this as it's faster than going
    # through convert2unicode()
    return &unicode::ascii2utf8 (\$line);
    }

    # everything else uses unicode::convert2unicode
    return &unicode::unicode2utf8 (&unicode::convert2unicode ($encoding, \$line));
}


sub read_file {
    my $self = shift (@_);
    my ($filename, $encoding, $language, $textref) = @_;

    $self->{'readfile_encoding'} = $encoding;

    @marc_entries = ();

    if (!-r $filename)
    {
    my $outhandle = $self->{'outhandle'};
    print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
    return;
    }

    my $batch = new MARC::Batch( 'USMARC', $filename );
    while ( my $marc = $batch->next ) 
    {
    push(@marc_entries,$marc);
    $$textref .= $marc->as_formatted();
    $$textref .= "\n\n"; # for SplitPlug - see default_split_exp above...
    }

    $self->{'marc_entries'} = \@marc_entries;
}



# do plugin specific processing of doc_obj
# This gets done for each record found by SplitPlug in marc files.
sub process {
    my $self = shift (@_);
    my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
    my $outhandle = $self->{'outhandle'};

    if (! defined($self->{'mm_file'}))
    {
    print $outhandle "MARCPlug: no metadata file! Can't process $file\n";
    return undef;
    }

    print STDERR "<Processing n='$file' p='MARCPlug'>\n" if ($gli);
    print $outhandle "MARCPlug: processing $file\n"
    if $self->{'verbosity'} > 1;

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

    my $marc_entries = $self->{'marc_entries'};
    my $marc = shift(@$marc_entries);

    $self->extract_metadata ($marc, $metadata, $doc_obj, $cursection);

    # add spaces after the sub-field markers, for word boundaries
    $$textref =~ s/^(.{6} _\w)/$1 /gm;

    # add text to document object
    $$textref =~ s/</&lt;/g;
    $$textref =~ s/>/&gt;/g;

    my $encoding = $self->{'readfile_encoding'};
    $$textref = $self->to_utf8($encoding,$$textref);

    print $outhandle "  Adding Marc Record:\n",substr($$textref,0,40), " ...\n"
    if $self->{'verbosity'} > 2;

    $$textref = "<pre>\n" . $$textref . "</pre>\n"; # HTML formatting...

    $doc_obj->add_utf8_text($cursection, $$textref);

    return 1;
}



sub extract_metadata 
{
    my $self = shift (@_);
    my ($marc, $metadata, $doc_obj, $section) = @_;
    my $outhandle = $self->{'outhandle'};

    my $encoding = $self->{'readfile_encoding'};

    my $metadata_mapping = $self->{'metadata_mapping'};
    my $mm;
    foreach $mm ( @$metadata_mapping )
    {
    my $marc_field = $mm->{'marc'};
    my @metavalues = $marc->field($marc_field);

    if (scalar(@metavalues)>0)
    {
        my $metaname = $mm->{'gsdl'};
        my $metavalue;
        foreach $metavalue ( @metavalues )
        {
        $metavalue_str = $self->to_utf8($encoding,$metavalue->as_string());
        $doc_obj->add_utf8_metadata ($thissection, $metaname, $metavalue_str);
        }
    }
    }
}
1;