source: main/trunk/greenstone2/perllib/plugins/CSVPlugin.pm@ 21742

###########################################################################
#
# CSVPlugin.pm -- A plugin for files in comma-separated value format
#
# A component of the Greenstone digital library software
# from the New Zealand Digital Library Project at the 
# University of Waikato, New Zealand.
#
# Copyright 2006 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 CSVPlugin;


use SplitTextFile;
use strict;
no strict 'refs'; # allow filehandles to be variables and viceversa


# CSVPlugin is a sub-class of SplitTextFile.
sub BEGIN {
    @CSVPlugin::ISA = ('SplitTextFile');
}


my $arguments = 
    [ { 'name' => "process_exp",
    'desc' => "{BasePlugin.process_exp}",
    'type' => "regexp",
    'reqd' => "no",
    'deft' => &get_default_process_exp() },
      { 'name' => "split_exp",
    'desc' => "{SplitTextFile.split_exp}",
    'type' => "regexp",
    'reqd' => "no",
    'deft' => &get_default_split_exp(),
        'hiddengli' => "yes" }
      ];


my $options = { 'name'     => "CSVPlugin",
        'desc'     => "{CSVPlugin.desc}",
        'abstract' => "no",
        'inherits' => "yes",
        'explodes' => "yes",
        'args'     => $arguments };


# This plugin processes files with the suffix ".csv"
sub get_default_process_exp {
    return q^(?i)(\.csv)$^;
}

    
# This plugin splits the input text by line
sub get_default_split_exp {
    return q^\r?\n^;
}


sub new
{
    my ($class) = shift (@_);
    my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
    push(@$pluginlist, $class);

    push(@{$hashArgOptLists->{"ArgList"}}, @{$arguments});
    push(@{$hashArgOptLists->{"OptList"}}, $options);

    my $self = new SplitTextFile($pluginlist, $inputargs, $hashArgOptLists);

    return bless $self, $class;
}


sub read_file
{
    my $self = shift (@_);
    my ($filename, $encoding, $language, $textref) = @_;
    my $outhandle = $self->{'outhandle'};

    # Read the CSV file content
    open(FILE, $filename);
    my $reader = new multiread();
    $reader->set_handle('CSVPlugin::FILE');
    $reader->set_encoding($encoding);
    $reader->read_file($textref);
    close(FILE);

    # Remove any blank lines so the data is split and processed properly
    $$textref =~ s/\n(\s*)\n/\n/g;

    # The first line contains the metadata element names
    $$textref =~ s/^(.*?)\r?\n//;
    my @csv_file_fields = ();
    my $csv_file_field_line = $1 . ",";  # To make the regular expressions simpler
    while ($csv_file_field_line ne "") {
    # Handle quoted values
    if ($csv_file_field_line =~ s/^\"(.*?)\"\,//) {
        my $csv_file_field = $1;
        $csv_file_field =~ s/ //g;  # Remove any spaces from the field names
        push(@csv_file_fields, $csv_file_field);
    }
    # Normal comma-separated case
    elsif ($csv_file_field_line =~ s/^(.*?)\,//) {
        my $csv_file_field = $1;
        $csv_file_field =~ s/ //g;  # Remove any spaces from the field names
        push(@csv_file_fields, $csv_file_field);
    }
    # The line must be formatted incorrectly
    else {
        print STDERR "Error: Badly formatted CSV field line: $csv_file_field_line.\n";
        last;
    }
    }
    $self->{'csv_file_fields'} = \@csv_file_fields;
}


sub process
{
    my $self = shift (@_);
    my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
    my $outhandle = $self->{'outhandle'};

    my $section = $doc_obj->get_top_section();
    my $csv_line = $$textref;
    my @csv_file_fields = @{$self->{'csv_file_fields'}};

    # Add the raw line as the document text
    $doc_obj->add_utf8_text($section, $csv_line);

    # Build a hash of metadata name to metadata value for this line
    my $i = 0;
    $csv_line .= ",";  # To make the regular expressions simpler
    while ($csv_line ne "") {
    # Metadata values containing commas are quoted
    if ($csv_line =~ s/^\"(.*?)\"\,//) {
        # Only bother with non-empty values
        if ($1 ne "" && defined($csv_file_fields[$i])) {
        $doc_obj->add_utf8_metadata($section, $csv_file_fields[$i], $1);
        }
    }
    # Normal comma-separated case
    elsif ($csv_line =~ s/^(.*?)\,//) {
        # Only bother with non-empty values
        if ($1 ne "" && defined($csv_file_fields[$i])) {
        $doc_obj->add_utf8_metadata($section, $csv_file_fields[$i], $1);
        }
    }
    # The line must be formatted incorrectly
    else {
        print STDERR "Error: Badly formatted CSV line: $csv_line.\n";
        last;
    }

    $i++;
    }

    # Record was processed successfully
    return 1;
}


1;