[537] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
| 3 | # List.pm --
|
---|
| 4 | # A component of the Greenstone digital library software
|
---|
| 5 | # from the New Zealand Digital Library Project at the
|
---|
| 6 | # University of Waikato, New Zealand.
|
---|
| 7 | #
|
---|
| 8 | # Copyright (C) 1999 New Zealand Digital Library Project
|
---|
| 9 | #
|
---|
| 10 | # This program is free software; you can redistribute it and/or modify
|
---|
| 11 | # it under the terms of the GNU General Public License as published by
|
---|
| 12 | # the Free Software Foundation; either version 2 of the License, or
|
---|
| 13 | # (at your option) any later version.
|
---|
| 14 | #
|
---|
| 15 | # This program is distributed in the hope that it will be useful,
|
---|
| 16 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 17 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
---|
| 18 | # GNU General Public License for more details.
|
---|
| 19 | #
|
---|
| 20 | # You should have received a copy of the GNU General Public License
|
---|
| 21 | # along with this program; if not, write to the Free Software
|
---|
| 22 | # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
---|
| 23 | #
|
---|
| 24 | ###########################################################################
|
---|
| 25 |
|
---|
[287] | 26 | # simple list classifier plugin
|
---|
[426] | 27 | # options are:
|
---|
| 28 | # metadata=Metaname -- (optional) all documents with Metaname metadata
|
---|
[545] | 29 | # will be included in list. if not included all documents
|
---|
| 30 | # will be included in list.
|
---|
| 31 | # sort=Meta -- (optional) sort documents in list alphabetically by
|
---|
| 32 | # Meta. by default it will sort by Metaname, if neither
|
---|
| 33 | # are set documents will be in build (random) order.
|
---|
| 34 | # Meta may be Filename to sort by original filename or
|
---|
| 35 | # nosort to force not to sort
|
---|
[426] | 36 | # title=Title -- (optional) the title field for this classification.
|
---|
| 37 | # if not included title field will be Metaname.
|
---|
| 38 | # if metadata is also not included title will be 'List'
|
---|
[287] | 39 |
|
---|
| 40 | package List;
|
---|
| 41 |
|
---|
[385] | 42 | use sorttools;
|
---|
| 43 |
|
---|
[287] | 44 | sub new {
|
---|
| 45 | my ($class, @options) = @_;
|
---|
| 46 |
|
---|
| 47 | my $list = [];
|
---|
[545] | 48 | my ($metaname, $title, $sortname);
|
---|
[426] | 49 |
|
---|
| 50 | foreach $option (@options) {
|
---|
| 51 | if ($option =~ /^metadata=(.*)$/i) {
|
---|
| 52 | $metaname = $1;
|
---|
| 53 | $list = {};
|
---|
| 54 | } elsif ($option =~ /^title=(.*)$/i) {
|
---|
| 55 | $title = $1;
|
---|
[545] | 56 | } elsif ($option =~ /^sort=(.*)$/i) {
|
---|
| 57 | $sortname = $1;
|
---|
[426] | 58 | }
|
---|
[287] | 59 | }
|
---|
| 60 |
|
---|
[426] | 61 | if (!defined $title) {
|
---|
| 62 | if (defined $metaname) {
|
---|
| 63 | $title = $metaname;
|
---|
| 64 | } else {
|
---|
| 65 | $title = 'List';
|
---|
| 66 | }
|
---|
| 67 | }
|
---|
| 68 |
|
---|
[545] | 69 | if (defined $sortname && $sortname =~ /^nosort$/i) {
|
---|
| 70 | $sortname = undef;
|
---|
| 71 | } elsif (!defined $sortname && defined $metaname) {
|
---|
| 72 | $sortname = $metaname;
|
---|
| 73 | }
|
---|
| 74 |
|
---|
[287] | 75 | return bless {
|
---|
| 76 | 'list'=>$list,
|
---|
[426] | 77 | 'metaname' => $metaname,
|
---|
[545] | 78 | 'title' => $title,
|
---|
| 79 | 'sortname' => $sortname
|
---|
[287] | 80 | }, $class;
|
---|
| 81 | }
|
---|
| 82 |
|
---|
| 83 | sub init {
|
---|
| 84 | my $self = shift (@_);
|
---|
| 85 |
|
---|
[545] | 86 | if (defined $self->{'sortname'}) {
|
---|
[287] | 87 | $self->{'list'} = {};
|
---|
| 88 | } else {
|
---|
| 89 | $self->{'list'} = [];
|
---|
| 90 | }
|
---|
| 91 | }
|
---|
| 92 |
|
---|
| 93 | sub classify {
|
---|
| 94 | my $self = shift (@_);
|
---|
| 95 | my ($doc_obj) = @_;
|
---|
| 96 |
|
---|
| 97 | my $doc_OID = $doc_obj->get_OID();
|
---|
| 98 |
|
---|
[545] | 99 | my $sortmeta = "";
|
---|
| 100 | if (defined $self->{'sortname'}) {
|
---|
| 101 | if ($self->{'sortname'} =~ /^filename$/i) {
|
---|
| 102 | $sortmeta = $doc_obj->get_source_filename();
|
---|
| 103 | } else {
|
---|
| 104 | $sortmeta = $doc_obj->get_metadata_element($doc_obj->get_top_section(),
|
---|
| 105 | $self->{'sortname'});
|
---|
[641] | 106 | if (defined $sortmeta) {
|
---|
| 107 | if ($self->{'sortname'} eq "Creator") {
|
---|
| 108 | &sorttools::format_string_name_english (\$sortmeta);
|
---|
| 109 | } else {
|
---|
| 110 | &sorttools::format_string_english (\$sortmeta);
|
---|
| 111 | }
|
---|
[287] | 112 | }
|
---|
[545] | 113 | }
|
---|
| 114 | $sortmeta = "" unless defined $sortmeta;
|
---|
| 115 |
|
---|
| 116 | if (defined $self->{'metaname'}) {
|
---|
| 117 | my $metavalue = $doc_obj->get_metadata_element ($doc_obj->get_top_section(),
|
---|
| 118 | $self->{'metaname'});
|
---|
| 119 | if (defined $metavalue) {
|
---|
| 120 | if (defined $self->{'list'}->{$doc_OID}) {
|
---|
| 121 | print STDERR "WARNING: List::classify called multiple times for $doc_OID\n";
|
---|
| 122 | }
|
---|
| 123 | $self->{'list'}->{$doc_OID} = $sortmeta;
|
---|
| 124 | }
|
---|
| 125 | } else {
|
---|
[287] | 126 | if (defined $self->{'list'}->{$doc_OID}) {
|
---|
| 127 | print STDERR "WARNING: List::classify called multiple times for $doc_OID\n";
|
---|
| 128 | }
|
---|
[545] | 129 | $self->{'list'}->{$doc_OID} = $sortmeta;
|
---|
[287] | 130 | }
|
---|
| 131 | } else {
|
---|
[545] | 132 | if (defined $self->{'metaname'}) {
|
---|
| 133 | my $metavalue = $doc_obj->get_metadata_element ($doc_obj->get_top_section(),
|
---|
| 134 | $self->{'metaname'});
|
---|
| 135 | if (defined $metavalue) {
|
---|
| 136 | push (@{$self->{'list'}}, $doc_OID);
|
---|
| 137 | }
|
---|
| 138 | } else {
|
---|
| 139 | push (@{$self->{'list'}}, $doc_OID);
|
---|
| 140 | }
|
---|
[287] | 141 | }
|
---|
| 142 | }
|
---|
| 143 |
|
---|
[316] | 144 | sub get_classify_info {
|
---|
[287] | 145 | my $self = shift (@_);
|
---|
| 146 |
|
---|
[316] | 147 | my @list = ();
|
---|
[545] | 148 | if (defined $self->{'sortname'}) {
|
---|
[287] | 149 | if (keys %{$self->{'list'}}) {
|
---|
[316] | 150 | @list = sort {$self->{'list'}->{$a}
|
---|
| 151 | cmp $self->{'list'}->{$b};} keys %{$self->{'list'}};
|
---|
[287] | 152 | }
|
---|
| 153 | } else {
|
---|
[316] | 154 | @list = @{$self->{'list'}};
|
---|
[287] | 155 | }
|
---|
| 156 |
|
---|
[316] | 157 | # organise into classification structure
|
---|
[677] | 158 | my %classifyinfo = ('thistype'=>'Invisible',
|
---|
| 159 | 'childtype'=>'VList',
|
---|
[426] | 160 | 'Title'=>$self->{'title'},
|
---|
[316] | 161 | 'contains'=>[]);
|
---|
| 162 | foreach $OID (@list) {
|
---|
| 163 | push (@{$classifyinfo{'contains'}}, {'OID'=>$OID});
|
---|
| 164 | }
|
---|
| 165 |
|
---|
| 166 | return \%classifyinfo;
|
---|
[287] | 167 | }
|
---|
| 168 |
|
---|
| 169 |
|
---|
| 170 | 1;
|
---|