source: trunk/gsdl/perllib/classify/HFileHierarchy.pm@ 9206

###########################################################################
#
# HFileHierarchy.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.
#
###########################################################################

# classifier plugin for generating hierarchical classifications


package HFileHierarchy;

use BasClas;
use util;
use cfgread;
use sorttools;

sub BEGIN {
    @HFileHierarchy::ISA = ('BasClas');
}

my $arguments =
    [ { 'name' => "metadata",
    'desc' => "{AZCompactList.metadata}",
    'type' => "metadata",
    'reqd' => "yes" },
      { 'name' => "firstvalueonly",
    'desc' => "{AZCompactList.firstvalueonly}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "allvalues",
    'desc' => "{AZCompactList.allvalues}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "sort",
    'desc' => "{Hierarchy.sort}",
    'type' => "string",
    'deft' => "{BasClas.metadata.deft}",
    'reqd' => "no" },
      { 'name' => "hfile",
    'desc' => "{Hierarchy.hfile}",
    'type' => "string",
    'deft' => "",
    'reqd' => "no" },
      { 'name' => "buttonname",
    'desc' => "{BasClas.buttonname}",
    'type' => "string",
    'deft' => "{BasClas.metadata.deft}",
    'reqd' => "no" },
      { 'name' => "sort",
    'desc' => "{Hierarchy.sort}",
    'type' => "string",
    'deft' => "{BasClas.metadata.deft}", 
    'reqd' => "no" },
      { 'name' => "reverse_sort",
    'desc' => "{Hierarchy.reverse_sort}",
    'type' => "flag",
    'reqd' => "no" },
      { 'name' => "hlist_at_top",
    'desc' => "{Hierarchy.hlist_at_top}",
    'type' => "flag",
    'reqd' => "no" } ];

my $options = 
{   'name'     => "HFileHierarchy",
    'desc'     => "{Hierarchy.desc}",
    'abstract' => "yes",
    'inherits' => "yes", 
    'args'     => $arguments };


sub new {
    my $class = shift (@_);
    my $self = new BasClas($class, @_);
 
    my $option_list = $self->{'option_list'};
    push( @{$option_list}, $options );
 
    if ($self->{'info_only'}) {
    # created from classinfo.pl - don't need to parse the arguments
    return bless $self, $class;
    }
 
    my ($hfile, $metadata, $buttonname, $sortname, $reverse_sort, $title, 
    $hlist_at_top);
    my $firstvalueonly = 0;
    my $allvalues = 0;
    
    if (!parsargv::parse(\@_, 
             q^metadata/.*/^, \$metadata,
             q^buttonname/.*/^, \$buttonname,
             q^firstvalueonly^, \$firstvalueonly,
             q^allvalues^, \$allvalues,
             q^sort/.*/^, \$sortname,
             q^reverse_sort^, \$reverse_sort,
             q^hfile/.*/^, \$hfile,
             q^hlist_at_top^, \$hlist_at_top,
             "allow_extra_options")) {
    
    print STDERR "\nIncorrect options passed to $class, check your collect.cfg file\n";
    $self->print_txt_usage("");  # Use default resource bundle
    die "\n";

    }

    if (!$metadata) {
    print STDERR "$class Error: required option -metadata not supplied\n";
    $self->print_txt_usage("");  # Use default resource bundle
    
    die "$class Error: required option -metadata not supplied\n";
    }
    
    $buttonname = $self->generate_title_from_metadata($metadata) unless ($buttonname);
    $title = $buttonname;
    $self->{'title'} = $title;

    $self->{'metaname'} = $metadata;
    my @meta_list = split(/,/, $metadata);
    $self->{'meta_list'} = \@meta_list;

    # sortname is handled a bit differently - kjdon
    # undef means to sort, but use the metadata value from -metadata
    # because there is no one metadata value to get for sorting when 
    # we have a list of possible metadata.
    # To get no sorting, set sortname = 'nosort'
    if (!$sortname) {
    if (defined ($metadata)) {
        $sortname = undef;
    } else {
        $sortname = "nosort";
    }
    }
    $self->{'sortname'} = $sortname;

    if (defined $sortname && $reverse_sort) {
    $self->{'reverse_sort'} = 1;
    }
    
    if ($hfile) {
    my $subjectfile;
    $subjectfile = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"etc", $hfile);
    if (!-e $subjectfile) {
        my $collfile = $subjectfile;
        $subjectfile = &util::filename_cat($ENV{'GSDLHOME'},"etc", $hfile);
        if (!-e $subjectfile) {
        my $outhandle = $self->{'outhandle'};
        print STDERR "\nHFileHierarchy Error: Can't locate subject file $hfile\n";
        print STDERR "This file should be in $collfile or $subjectfile\n";
        $self->print_txt_usage("");  # Use default resource bundle
        print STDERR "\nHFileHierarchy Error: Can't locate subject file $hfile\n";
        print STDERR "This file should be in $collfile or $subjectfile\n";
        die "\n";
        }
    }
    $self->{'descriptorlist'} = {}; # first field in subject file
    $self->{'locatorlist'} = {}; # second field in subject file
    $self->{'subjectfile'} = $subjectfile;
    }
    

    $self->{'firstvalueonly'} = $firstvalueonly;
    $self->{'allvalues'} = $allvalues;

    $self->{'hlist_at_top'} = $hlist_at_top;

    
    return bless $self, $class;
}

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

    my $subjectfile = $self->{'subjectfile'};
    if (defined $subjectfile) {
    # read in the subject file
    my $list = &cfgread::read_cfg_file ($self->{'subjectfile'}, undef, '^[^#]?\S');
    # $list is a hash that is indexed by the descriptor. The contents of this
    # hash is a list of two items. The first item is the OID and the second item
    # is the title
    foreach $descriptor (keys (%$list)) {
        $self->{'descriptorlist'}->{$descriptor} = $list->{$descriptor}->[0];
        unless (defined $self->{'locatorlist'}->{$list->{$descriptor}->[0]}) {
        $self->{'locatorlist'}->{$list->{$descriptor}->[0]}->{'title'} = $list->{$descriptor}->[1];
        $self->{'locatorlist'}->{$list->{$descriptor}->[0]}->{'contents'} = [];
        }
    }
    }
}

sub hfile_classify
{
    my $self = shift (@_);
    my ($doc_obj,$sortmeta,$metavalues) = @_;

    my $doc_OID = $doc_obj->get_OID();

    foreach my $metaelement (@$metavalues) {
    if ((defined $self->{'descriptorlist'}->{$metaelement}) &&
        (defined $self->{'locatorlist'}->{$self->{'descriptorlist'}->{$metaelement}})) {
        push (@{$self->{'locatorlist'}->{$self->{'descriptorlist'}->{$metaelement}}->{'contents'}}, 
          [$doc_OID, $sortmeta]);
        my $localid = $self->{'descriptorlist'}->{$metaelement};
        my $classid = $self->get_number();

        $doc_obj->add_metadata($doc_obj->get_top_section(), "memberof", "CL$classid.$localid");
    }
    }
}




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

    my $list = $self->{'locatorlist'};

    # sorted the keys - otherwise funny things happen - kjdon 03/01/03
    foreach $OID (sort keys (%$list)) {
    my $tempinfo = $self->get_OID_entry ($OID, $classifyinfo, $list->{$OID}->{'title'}, "VList");
    
    if (defined $self->{'sortname'}) {
        if ($self->{'reverse_sort'}) {
        foreach $subOID (sort {$b->[1] cmp $a->[1];} @{$list->{$OID}->{'contents'}}) {
            push (@{$tempinfo->{'contains'}}, {'OID'=>$subOID->[0]});
        }
        }
        else {
        foreach $subOID (sort {$a->[1] cmp $b->[1];} @{$list->{$OID}->{'contents'}}) {
            push (@{$tempinfo->{'contains'}}, {'OID'=>$subOID->[0]});
        }
        }
    }
    else {
        foreach $subOID (@{$list->{$OID}->{'contents'}}) {
        push (@{$tempinfo->{'contains'}}, {'OID'=>$subOID->[0]});
        }
    }
    }
    
    return $classifyinfo;
}


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

    return "true";
}

sub get_OID_entry {
    my $self = shift (@_);
    my ($OID, $classifyinfo, $title, $classifytype) = @_;

    $OID = "" unless defined $OID;
    $OID =~ s/^\.+//;

    my ($headOID, $tailOID) = $OID =~ /^(\d+)(.*)$/;
    $tailOID = "" unless defined $tailOID;

    if (!defined $headOID) {
    $classifyinfo->{'Title'} = $title;
    $classifyinfo->{'classifytype'} = $classifytype;
    return $classifyinfo;
    }

    $classifyinfo->{'contains'} = [] unless defined $classifyinfo->{'contains'};
    my $offset = 0;
    foreach my $thing (@{$classifyinfo->{'contains'}}) {
    $offset ++ if defined $thing->{'OID'};
    }

    while (scalar(@{$classifyinfo->{'contains'}}) < ($headOID+$offset)) { 
    push (@{$classifyinfo->{'contains'}}, $self->get_entry("", $classifytype));
    }

    return $self->get_OID_entry ($tailOID, $classifyinfo->{'contains'}->[($headOID+$offset-1)], $title, $classifytype);
}

sub get_entry {
    my $self = shift (@_);
    my ($title, $childtype, $thistype) = @_;
    my $memberof = &supports_memberof();
    
    # organise into classification structure
    my %classifyinfo = ('childtype'=>$childtype,
            'Title'=>$title,
            'supportsmemberof'=>$memberof,
            'contains'=>[]);
    $classifyinfo{'thistype'} = $thistype 
    if defined $thistype && $thistype =~ /\w/;

    return \%classifyinfo;
}


1;