[537] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
| 3 | # classify.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 |
|
---|
[214] | 26 | # functions to handle classifiers
|
---|
| 27 |
|
---|
| 28 | package classify;
|
---|
| 29 |
|
---|
| 30 | require util;
|
---|
[8220] | 31 | require AllList;
|
---|
[5682] | 32 | use gsprintf;
|
---|
[214] | 33 |
|
---|
| 34 |
|
---|
[5682] | 35 | sub gsprintf
|
---|
| 36 | {
|
---|
| 37 | return &gsprintf::gsprintf(@_);
|
---|
| 38 | }
|
---|
| 39 |
|
---|
| 40 |
|
---|
[315] | 41 | $next_classify_num = 1;
|
---|
[6967] | 42 | sub load_classifier_for_info {
|
---|
| 43 | my ($classifier) = shift @_;
|
---|
[214] | 44 |
|
---|
[6967] | 45 | # find the classifier
|
---|
| 46 | my $colclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},
|
---|
| 47 | "perllib/classify",
|
---|
| 48 | "${classifier}.pm");
|
---|
| 49 | my $mainclassname = &util::filename_cat($ENV{'GSDLHOME'},
|
---|
| 50 | "perllib/classify",
|
---|
| 51 | "${classifier}.pm");
|
---|
| 52 |
|
---|
| 53 | if (-e $colclassname) { require $colclassname; }
|
---|
| 54 | elsif (-e $mainclassname) { require $mainclassname; }
|
---|
| 55 | else {
|
---|
| 56 | &gsprintf(STDERR, "{classify.could_not_find_classifier}\n", $classifier) && die "\n";
|
---|
| 57 | }
|
---|
| 58 | my ($classobj);
|
---|
| 59 | my $options = "-gsdlinfo";
|
---|
[10218] | 60 | eval ("\$classobj = new \$classifier([],[$options])");
|
---|
[6967] | 61 | die "$@" if $@;
|
---|
| 62 |
|
---|
| 63 | return $classobj;
|
---|
| 64 | }
|
---|
| 65 |
|
---|
[811] | 66 | sub load_classifiers {
|
---|
[1839] | 67 | my ($classify_list, $build_dir, $outhandle) = @_;
|
---|
[811] | 68 | my @classify_objects = ();
|
---|
[8220] | 69 | my $classify_number = 1;
|
---|
[811] | 70 |
|
---|
| 71 | foreach $classifyoption (@$classify_list) {
|
---|
[214] | 72 |
|
---|
[811] | 73 | # get the classifier name
|
---|
| 74 | my $classname = shift @$classifyoption;
|
---|
| 75 | next unless defined $classname;
|
---|
[1839] | 76 |
|
---|
[811] | 77 | # find the classifier
|
---|
| 78 | my $colclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"perllib/classify",
|
---|
| 79 | "${classname}.pm");
|
---|
| 80 | my $mainclassname = &util::filename_cat($ENV{'GSDLHOME'},"perllib/classify",
|
---|
| 81 | "${classname}.pm");
|
---|
[214] | 82 |
|
---|
[811] | 83 | if (-e $colclassname) { require $colclassname; }
|
---|
| 84 | elsif (-e $mainclassname) { require $mainclassname; }
|
---|
[5682] | 85 | else { &gsprintf(STDERR, "{classify.could_not_find_classifier}\n", $classname) && die "\n";
|
---|
| 86 | # die "ERROR - couldn't find classifier \"$classname\"\n";
|
---|
| 87 | }
|
---|
[214] | 88 |
|
---|
[811] | 89 | # create the classify object
|
---|
| 90 | my ($classobj);
|
---|
[1839] | 91 |
|
---|
| 92 | my @newoptions;
|
---|
[6964] | 93 |
|
---|
| 94 | # do these first so they can be overriden by user supplied options
|
---|
| 95 | push @newoptions, "-builddir", "$build_dir" if ($build_dir);
|
---|
| 96 | push @newoptions, "-outhandle", "$outhandle" if ($outhandle);
|
---|
| 97 | push @newoptions, "-verbosity", "2";
|
---|
| 98 |
|
---|
[6967] | 99 | # backwards compatability hack: if the classifier options are
|
---|
| 100 | # in "x=y" format, convert them to parsearg ("-x y") format.
|
---|
| 101 | my ($opt, $key, $value);
|
---|
[1839] | 102 | foreach $opt (@$classifyoption) {
|
---|
| 103 | if ($opt =~ /^(\w+)=(.*)$/) {
|
---|
| 104 | push @newoptions, "-$1", $2;
|
---|
| 105 | } else {
|
---|
| 106 | push @newoptions, $opt;
|
---|
| 107 | }
|
---|
| 108 | }
|
---|
| 109 |
|
---|
| 110 | map { $_ = "\"$_\""; } @newoptions;
|
---|
| 111 | my $options .= join (",", @newoptions);
|
---|
| 112 |
|
---|
[10218] | 113 |
|
---|
| 114 | eval ("\$classobj = new \$classname([],[$options])");
|
---|
[811] | 115 | die "$@" if $@;
|
---|
[1839] | 116 |
|
---|
[8220] | 117 | $classobj->set_number($classify_number);
|
---|
| 118 | $classify_number ++;
|
---|
| 119 |
|
---|
[1839] | 120 | # add this object to the list
|
---|
[811] | 121 | push (@classify_objects, $classobj);
|
---|
| 122 | }
|
---|
| 123 |
|
---|
[8220] | 124 | my ($classobj);
|
---|
| 125 | eval ("\$classobj = new AllList()");
|
---|
| 126 | die "$@" if $@;
|
---|
| 127 | push (@classify_objects, $classobj);
|
---|
| 128 |
|
---|
[811] | 129 | return \@classify_objects;
|
---|
[214] | 130 | }
|
---|
| 131 |
|
---|
| 132 | # init_classifiers resets all the classifiers and readys them to process
|
---|
[315] | 133 | # the documents.
|
---|
[214] | 134 | sub init_classifiers {
|
---|
| 135 | my ($classifiers) = @_;
|
---|
| 136 |
|
---|
| 137 | foreach $classobj (@$classifiers) {
|
---|
| 138 | $classobj->init();
|
---|
| 139 | }
|
---|
| 140 | }
|
---|
| 141 |
|
---|
| 142 | # classify_doc lets each of the classifiers classify a document
|
---|
| 143 | sub classify_doc {
|
---|
| 144 | my ($classifiers, $doc_obj) = @_;
|
---|
| 145 |
|
---|
| 146 | foreach $classobj (@$classifiers) {
|
---|
[8220] | 147 | my $title = $classobj->{'title'};
|
---|
[214] | 148 | $classobj->classify($doc_obj);
|
---|
| 149 | }
|
---|
| 150 | }
|
---|
| 151 |
|
---|
| 152 | # output_classify_info outputs all the info needed for the classification
|
---|
| 153 | # to the gdbm
|
---|
| 154 | sub output_classify_info {
|
---|
[8361] | 155 | my ($classifiers, $handle, $remove_empty_classifications, $gli) = @_;
|
---|
[214] | 156 | # $handle = "main::STDOUT";
|
---|
| 157 |
|
---|
[6332] | 158 | $gli = 0 unless defined $gli;
|
---|
| 159 |
|
---|
[315] | 160 | # create a classification containing all the info
|
---|
| 161 | my $classifyinfo = {'classifyOID'=>'browse',
|
---|
| 162 | 'contains'=>[]};
|
---|
| 163 |
|
---|
| 164 | # get each of the classifications
|
---|
[8275] | 165 | foreach $classobj (@$classifiers) {
|
---|
[6332] | 166 | my $tempinfo = $classobj->get_classify_info($gli);
|
---|
[8220] | 167 | my $classID = $tempinfo->{'classifyOID'};
|
---|
| 168 |
|
---|
| 169 | $tempinfo->{'classifyOID'} = "CL$next_classify_num" unless defined($tempinfo->{'classifyOID'});
|
---|
[315] | 170 | $next_classify_num++;
|
---|
| 171 | push (@{$classifyinfo->{'contains'}}, $tempinfo);
|
---|
[214] | 172 | }
|
---|
| 173 |
|
---|
[8361] | 174 | &print_classify_info ($handle, $classifyinfo, "", $remove_empty_classifications);
|
---|
[214] | 175 | }
|
---|
| 176 |
|
---|
[315] | 177 | sub print_classify_info {
|
---|
[8361] | 178 | my ($handle, $classifyinfo, $OID, $remove_empty_classifications) = @_;
|
---|
[831] | 179 |
|
---|
[315] | 180 | $OID =~ s/^\.+//; # just for good luck
|
---|
[214] | 181 |
|
---|
[315] | 182 | # book information is printed elsewhere
|
---|
| 183 | return if (defined ($classifyinfo->{'OID'}));
|
---|
| 184 |
|
---|
| 185 | # don't want empty classifications
|
---|
[8445] | 186 | return if (&check_contents ($classifyinfo, $remove_empty_classifications) == 0 && $remove_empty_classifications);
|
---|
[315] | 187 |
|
---|
[8361] | 188 | $OID = $classifyinfo->{'classifyOID'} if defined ($classifyinfo->{'classifyOID'});
|
---|
[315] | 189 |
|
---|
[8361] | 190 | my $outputtext = "[$OID]\n";
|
---|
| 191 | $outputtext .= "<doctype>classify\n";
|
---|
| 192 | $outputtext .= "<hastxt>0\n";
|
---|
| 193 | $outputtext .= "<childtype>$classifyinfo->{'childtype'}\n"
|
---|
| 194 | if defined $classifyinfo->{'childtype'};
|
---|
| 195 | $outputtext .= "<Title>$classifyinfo->{'Title'}\n"
|
---|
| 196 | if defined $classifyinfo->{'Title'};
|
---|
| 197 | $outputtext .= "<numleafdocs>$classifyinfo->{'numleafdocs'}\n"
|
---|
| 198 | if defined $classifyinfo->{'numleafdocs'};
|
---|
| 199 | $outputtext .= "<thistype>$classifyinfo->{'thistype'}\n"
|
---|
| 200 | if defined $classifyinfo->{'thistype'};
|
---|
| 201 | $outputtext .= "<parameters>$classifyinfo->{'parameters'}\n"
|
---|
| 202 | if defined $classifyinfo->{'parameters'};
|
---|
| 203 | $outputtext .= "<supportsmemberof>$classifyinfo->{'supportsmemberof'}\n"
|
---|
| 204 | if defined $classifyinfo->{'supportsmemberof'};
|
---|
| 205 |
|
---|
| 206 | my $contains_text = "<contains>";
|
---|
| 207 | my $mdoffset_text = "<mdoffset>";
|
---|
| 208 |
|
---|
| 209 | my $next_subOID = 1;
|
---|
| 210 | my $first = 1;
|
---|
| 211 | foreach $tempinfo (@{$classifyinfo->{'contains'}}) {
|
---|
| 212 | # empty contents were made undefined by clean_contents()
|
---|
| 213 | next unless defined $tempinfo;
|
---|
[315] | 214 |
|
---|
[8361] | 215 | if (!defined ($tempinfo->{'classifyOID'}) ||
|
---|
| 216 | $tempinfo->{'classifyOID'} ne "oai") {
|
---|
| 217 | $contains_text .= ";" unless $first;
|
---|
| 218 | }
|
---|
| 219 | $mdoffset_text .= ";" unless $first;
|
---|
| 220 | $first = 0;
|
---|
[315] | 221 |
|
---|
[8361] | 222 | if (defined ($tempinfo->{'classifyOID'})) {
|
---|
| 223 | if ($tempinfo->{'classifyOID'} ne "oai") {
|
---|
| 224 | $contains_text .= $tempinfo->{'classifyOID'};
|
---|
[8275] | 225 | }
|
---|
[8361] | 226 | &print_classify_info ($handle, $tempinfo, $tempinfo->{'classifyOID'},
|
---|
| 227 | $remove_empty_classifications);
|
---|
| 228 | } elsif (defined ($tempinfo->{'OID'})) {
|
---|
| 229 | $contains_text .= $tempinfo->{'OID'};
|
---|
| 230 | $mdoffset_text .= $tempinfo->{'offset'}
|
---|
| 231 | if (defined ($tempinfo->{'offset'}))
|
---|
[315] | 232 | # note: we don't want to print the contents of the books
|
---|
| 233 | } else {
|
---|
[7346] | 234 |
|
---|
| 235 | # Supress having top-level node in Collage classifier
|
---|
| 236 | # so no bookshelf icon appears, top-level, along with the
|
---|
| 237 | # applet
|
---|
[8361] | 238 |
|
---|
[7346] | 239 | if (!defined ($tempinfo->{'Title'}) || $tempinfo->{'Title'} ne "Collage") {
|
---|
| 240 | $contains_text .= "\".$next_subOID";
|
---|
| 241 | }
|
---|
[8361] | 242 |
|
---|
[315] | 243 | &print_classify_info ($handle, $tempinfo, "$OID.$next_subOID",
|
---|
[8361] | 244 | $remove_empty_classifications);
|
---|
[315] | 245 | $next_subOID++;
|
---|
| 246 | }
|
---|
| 247 | }
|
---|
[8361] | 248 |
|
---|
| 249 | $outputtext .= "$contains_text\n";
|
---|
| 250 | $outputtext .= "<mdtype>$classifyinfo->{'mdtype'}\n"
|
---|
| 251 | if defined $classifyinfo->{'mdtype'};
|
---|
| 252 | $outputtext .= "$mdoffset_text\n"
|
---|
| 253 | if ($mdoffset_text !~ m/^<mdoffset>;+$/);
|
---|
| 254 |
|
---|
| 255 | $outputtext .= '-' x 70 . "\n";
|
---|
| 256 |
|
---|
| 257 | print $handle $outputtext;
|
---|
| 258 |
|
---|
[315] | 259 | }
|
---|
| 260 |
|
---|
[637] | 261 | sub check_contents {
|
---|
[8445] | 262 | my ($classifyinfo,$remove_empty_classifications) = @_;
|
---|
| 263 | $remove_empty_classifications = 0 unless ($remove_empty_classifications);
|
---|
[637] | 264 | my $num_leaf_docs = 0;
|
---|
| 265 | my $sub_num_leaf_docs = 0;
|
---|
[315] | 266 |
|
---|
[637] | 267 | return $classifyinfo->{'numleafdocs'} if (defined $classifyinfo->{'numleafdocs'});
|
---|
| 268 |
|
---|
[315] | 269 | foreach $content (@{$classifyinfo->{'contains'}}) {
|
---|
| 270 | if (defined $content->{'OID'}) {
|
---|
| 271 | # found a book
|
---|
[637] | 272 | $num_leaf_docs ++;
|
---|
[9790] | 273 | } elsif (($sub_num_leaf_docs = &check_contents ($content,$remove_empty_classifications)) > 0) {
|
---|
[315] | 274 | # there's a book somewhere below
|
---|
[637] | 275 | $num_leaf_docs += $sub_num_leaf_docs;
|
---|
[315] | 276 | } else {
|
---|
[8445] | 277 | if ($remove_empty_classifications){
|
---|
| 278 | # section contains no books so we want to remove
|
---|
| 279 | # it from its parents contents
|
---|
| 280 | $content = undef;
|
---|
| 281 | }
|
---|
[315] | 282 | }
|
---|
| 283 | }
|
---|
[637] | 284 |
|
---|
| 285 | $classifyinfo->{'numleafdocs'} = $num_leaf_docs;
|
---|
| 286 | return $num_leaf_docs;
|
---|
[315] | 287 | }
|
---|
| 288 |
|
---|
[214] | 289 | 1;
|
---|