root/gsdl/trunk/perllib/classify.pm @ 15703

Revision 15703, 15.1 KB (checked in by mdewsnip, 11 years ago)

Added "use strict", and fixed a whole bunch of warnings as a consequence.

  • Property svn:keywords set to Author Date Id Revision
Line 
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
26# functions to handle classifiers
27
28package classify;
29
30require util;
31require AllList;
32
33use gsprintf;
34use strict; no strict 'subs';
35use unbuildutil;
36
37
38sub gsprintf
39{
40    return &gsprintf::gsprintf(@_);
41}
42
43
44my $oid_to_clids = {};
45
46sub load_classifier_for_info {
47    my ($classifier) = shift @_;
48
49    # find the classifier
50    my $customclassname;
51    if (defined($ENV{'GSDLCOLLECTION'}))
52    {
53    $customclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "custom", $ENV{'GSDLCOLLECTION'},
54                                              "perllib", "classify", "${classifier}.pm");
55    }
56    my $colclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "perllib", "classify", "${classifier}.pm");
57    my $mainclassname = &util::filename_cat($ENV{'GSDLHOME'}, "perllib", "classify", "${classifier}.pm");
58
59    if (defined($customclassname) && -e $customclassname) { require $customclassname; }
60    elsif (-e $colclassname) { require $colclassname; }
61    elsif (-e $mainclassname) { require $mainclassname; }
62    else {
63    &gsprintf(STDERR, "{classify.could_not_find_classifier}\n", $classifier) && die "\n";
64    }
65    my ($classobj);
66    my $options = "-gsdlinfo";
67    eval ("\$classobj = new \$classifier([],[$options])");
68    die "$@" if $@;
69
70    return $classobj;
71}
72
73sub load_classifiers {
74    my ($classify_list, $build_dir, $outhandle) = @_;
75    my @classify_objects = ();
76    my $classify_number  = 1;
77
78     my $colclassdir = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"perllib/classify");
79     unshift (@INC, $colclassdir);
80   
81    foreach my $classifyoption (@$classify_list) {
82
83    # get the classifier name
84    my $classname = shift @$classifyoption;
85    next unless defined $classname;
86
87    # find the classifier
88        my $customclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "custom", $ENV{'GSDLCOLLECTION'},
89                                                  "perllib", "classify", "${classname}.pm");
90        my $colclassname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "perllib", "classify", "${classname}.pm");
91        my $mainclassname = &util::filename_cat($ENV{'GSDLHOME'}, "perllib", "classify", "${classname}.pm");
92
93    if (-e $customclassname) { require $customclassname; }
94    elsif (-e $colclassname) { require $colclassname; }
95    elsif (-e $mainclassname) { require $mainclassname; }
96    else { &gsprintf(STDERR, "{classify.could_not_find_classifier}\n", $classname) && die "\n";
97           # die "ERROR - couldn't find classifier \"$classname\"\n";
98        }
99
100    # create the classify object
101    my ($classobj);
102
103    my @newoptions;
104
105    # do these first so they can be overriden by user supplied options
106    push @newoptions, "-builddir", "$build_dir" if ($build_dir);
107    push @newoptions, "-outhandle", "$outhandle" if ($outhandle);
108    push @newoptions, "-verbosity", "2";
109
110    # backwards compatability hack: if the classifier options are
111    # in "x=y" format, convert them to parsearg ("-x y") format.
112    my ($opt, $key, $value);
113    foreach $opt (@$classifyoption) {
114        # if ($opt =~ /^(\w+)=(.*)$/) {
115        #   push @newoptions, "-$1", $2;
116        # } else {
117        push @newoptions, $opt;
118        #}
119    }
120
121    map { $_ = "\"$_\""; } @newoptions;
122    my $options .= join (",", @newoptions);
123
124
125    eval ("\$classobj = new \$classname([],[$options])");
126    die "$@" if $@;
127
128    $classobj->set_number($classify_number);
129    $classify_number ++;
130
131        # add this object to the list
132    push (@classify_objects, $classobj);
133    }
134
135    my ($classobj);
136    eval ("\$classobj = new AllList()");
137    die "$@" if $@;
138    push (@classify_objects, $classobj);
139
140    return \@classify_objects;
141}
142
143# init_classifiers resets all the classifiers and readys them to process
144# the documents.
145sub init_classifiers {
146    my ($classifiers) = @_;
147   
148    foreach my $classobj (@$classifiers) {
149    $classobj->init();
150    }
151}
152
153
154
155# takes a hashref containing the metadata for a gdbmfile entry, and extracts
156# the childrens numbers (from the 'contains' entry).   
157# assumes format is ".1;".2;".3
158sub get_children { 
159    my ($doc_db_hash) = @_;
160
161    my $children = undef;
162
163    my $contains = $doc_db_hash->{'contains'};
164    if (defined ($contains)) {
165    $contains =~ s/\@$//;  #remove trailing @
166    $contains =~ s/^\"\.//; #remove initial ".
167    @$children = split /\;\"\./, $contains;
168    }
169
170    return $children;
171}
172
173   
174sub recurse_sections {
175    my ($doc_obj, $children, $parentoid, $parentsection, $gdbm_recs) = @_;
176
177    return if (!defined $children);
178
179    foreach my $child (sort { $a <=> $b} @$children) {
180    $doc_obj->create_named_section("$parentsection.$child");
181    my $doc_db_rec = $gdbm_recs->{"$parentoid.$child"};
182    my $doc_db_hash = db_rec_to_hash($doc_db_rec);
183
184    # get child's children
185    my $newchildren = &get_children($doc_db_hash);
186
187    # add content for current section
188    add_section_content($doc_obj, "$parentsection.$child", $doc_db_hash);
189
190    # process all the children if there are any
191    if (defined ($newchildren))
192    {
193        recurse_sections($doc_obj, $newchildren, "$parentoid.$child",
194                 "$parentsection.$child", $gdbm_recs);
195    }
196    }
197}                       
198
199
200sub add_section_content {
201    my ($doc_obj, $cursection, $doc_db_hash) = @_;
202 
203    foreach my $key (keys %$doc_db_hash) {
204    #don't need to store these metadata
205    next if $key =~ /(thistype|childtype|contains|docnum|doctype|classifytype)/i;
206    # but do want things like hastxt and archivedir
207    my @items = split /@/, $doc_db_hash->{$key};
208    map {$doc_obj->add_metadata ($cursection, $key, $_); } @items;
209
210    }
211}
212
213
214# gets all the metadata from a gdbm file entry, and puts it into a hashref
215sub db_rec_to_hash {
216   
217    my ($gdb_str_ref) = @_;
218
219    my $hashref = {};
220
221    my @entries = split(/\n/, $gdb_str_ref);
222    foreach my $entry (@entries) {
223    my($key, $value) = ($entry =~ /^<([^>]*)>(.*?)$/ );
224    $hashref->{$key} .= '@' if defined $hashref->{$key};
225    $hashref->{$key} .= $value;
226   
227    }
228   
229    return $hashref;
230}                     
231
232
233sub reconstruct_doc_objs_metadata
234{
235    my ($fulldbname) = @_;
236
237#   tie %gdbm_recs, 'GDBM_File', $fulldbname, &GDBM_WRCREAT, 0640;
238
239    my %gdbm_recs;
240    &unbuildutil::read_gdbm($fulldbname,\%gdbm_recs);
241
242
243    # dig out top level doc sections
244    my %top_sections = ();
245    my %top_docnums = ();
246    foreach my $key ( keys %gdbm_recs )
247    {
248    my $md_rec = $gdbm_recs{$key};
249    my $md_hash = db_rec_to_hash($md_rec);
250
251    if ((defined $md_hash->{'doctype'}) && ($md_hash->{'doctype'} eq "doc")) {
252        next if ($key =~ m/\./);
253        $top_sections{$key} = $md_hash;
254        $top_docnums{$key} = $md_hash->{'docnum'};
255    }
256    }
257
258    # for greenstone document objects based on metadata in gdbm file
259    my @all_docs = ();
260    # we need to make sure the documents were processed in the same order as
261    # before, so sort based on their docnums
262    foreach my $oid ( sort { $top_docnums{$a} <=> $top_docnums{$b} } keys %top_sections )
263    {
264    my $doc_db_hash = $top_sections{$oid};
265
266    my $doc_obj = new doc();
267    $doc_obj->set_OID($oid);
268    my $top = $doc_obj->get_top_section();
269        add_section_content ($doc_obj, $top, $doc_db_hash);
270        my $children = &get_children($doc_db_hash);
271        recurse_sections($doc_obj, $children, $oid, $top, \%gdbm_recs);
272
273    push(@all_docs,$doc_obj);
274    }   
275
276#    untie %gdbm_recs;
277
278    return \@all_docs;   
279}
280
281
282
283
284
285# classify_doc lets each of the classifiers classify a document
286sub classify_doc {
287    my ($classifiers, $doc_obj) = @_;
288   
289    foreach my $classobj (@$classifiers) {
290    my $title = $classobj->{'title'};
291    $classobj->classify($doc_obj);
292    }
293}
294
295
296# output_classify_info outputs all the info needed for the classification
297# to the database
298sub output_classify_info
299{
300    my ($classifiers, $infodb_handle, $remove_empty_classifications, $gli) = @_;
301
302    $gli = 0 unless defined $gli;
303
304    # create a classification containing all the info
305    my $classifyinfo = { 'classifyOID'=> 'browse',
306             'contains' => [] };
307
308    # get each of the classifications
309    my $next_classify_num = 1;
310    foreach my $classifier (@$classifiers)
311    {
312    my $classifier_info = $classifier->get_classify_info($gli);
313    $classifier_info->{'classifyOID'} = "CL$next_classify_num" unless defined($classifier_info->{'classifyOID'});
314        print STDERR "*** outputting information for classifier: $classifier_info->{'classifyOID'}\n";
315
316    push(@{$classifyinfo->{'contains'}}, $classifier_info);
317    $next_classify_num++;
318    }
319
320    &print_classify_info ($infodb_handle, $classifyinfo, "", $remove_empty_classifications);
321}
322
323
324sub print_classify_info
325{
326    my ($infodb_handle, $classifyinfo, $OID, $remove_empty_classifications) = @_;
327
328    $OID =~ s/^\.+//; # just for good luck
329
330    # book information is printed elsewhere
331    return if (defined ($classifyinfo->{'OID'}));
332 
333    # don't want empty classifications
334    return if (&check_contents ($classifyinfo, $remove_empty_classifications) == 0 && $remove_empty_classifications);
335   
336    $OID = $classifyinfo->{'classifyOID'} if defined ($classifyinfo->{'classifyOID'});
337
338    my %classify_infodb = ();
339    $classify_infodb{"doctype"} = [ "classify" ];
340    $classify_infodb{"hastxt"} = [ "0" ];
341    $classify_infodb{"childtype"} = [ $classifyinfo->{'childtype'} ]
342    if defined $classifyinfo->{'childtype'};
343    $classify_infodb{"Title"} = [ $classifyinfo->{'Title'} ]
344    if defined $classifyinfo->{'Title'};
345    $classify_infodb{"numleafdocs"} = [ $classifyinfo->{'numleafdocs'} ]
346    if defined $classifyinfo->{'numleafdocs'};
347    $classify_infodb{"thistype"} = [ $classifyinfo->{'thistype'} ]
348    if defined $classifyinfo->{'thistype'};
349    $classify_infodb{"parameters"} = [ $classifyinfo->{'parameters'} ]
350    if defined $classifyinfo->{'parameters'};
351    $classify_infodb{"supportsmemberof"} = [ $classifyinfo->{'supportsmemberof'} ]
352    if defined $classifyinfo->{'supportsmemberof'};
353   
354    my $contains_text = "";
355    my $mdoffset_text = "";
356   
357    my $next_subOID = 1;
358    my $first = 1;
359    foreach my $tempinfo (@{$classifyinfo->{'contains'}}) {
360    # empty contents were made undefined by clean_contents()
361    next unless defined $tempinfo;
362   
363    if (!defined ($tempinfo->{'classifyOID'}) ||
364        $tempinfo->{'classifyOID'} ne "oai") {
365        $contains_text .= ";" unless $first;
366    }
367    $mdoffset_text .= ";" unless $first;
368    $first = 0;
369   
370    if (defined ($tempinfo->{'classifyOID'})) {
371        if ($tempinfo->{'classifyOID'} ne "oai") {
372        $contains_text .= $tempinfo->{'classifyOID'};
373        }
374
375            # Extra code for incremental building.
376            # We need to store a listing of the classifiers each DOI is in
377            my $clids = [];
378            #rint STDERR "==1. Recording reverse lookup for " . $tempinfo->{'classifyOID'} . "==\n";
379            if(defined($oid_to_clids->{$tempinfo->{'classifyOID'}})) {
380              #rint STDERR "Found existing array!\n";
381              $clids = $oid_to_clids->{$tempinfo->{'classifyOID'}};
382            }
383            #rint STDERR "Appended $OID to \"" . join(";", @{$clids}) . "\"\n";
384            push(@{$clids}, $OID);
385            $oid_to_clids->{$tempinfo->{'classifyOID'}} = $clids;
386            #rint STDERR "Result: \"" . join(";", @{$clids}) . "\"\n";
387           
388        &print_classify_info ($infodb_handle, $tempinfo, $tempinfo->{'classifyOID'},
389                  $remove_empty_classifications);
390    } elsif (defined ($tempinfo->{'OID'})) {
391        $contains_text .= $tempinfo->{'OID'};
392        $mdoffset_text .= $tempinfo->{'offset'} if (defined ($tempinfo->{'offset'}));
393
394           
395              # note: we don't want to print the contents of the books
396              # Extra code for incremental building.
397              # We need to store a listing of the classifiers each DOI is in
398              my $clids = [];
399              #rint STDERR "==2. Recording reverse lookup for " . $tempinfo->{'OID'} . "==\n";
400              if(defined($oid_to_clids->{$tempinfo->{'OID'}})) {
401                #rint STDERR "Found existing array!\n";
402                $clids = $oid_to_clids->{$tempinfo->{'OID'}};
403              }
404              #rint STDERR "Appended $OID to \"" . join(";", @{$clids}) . "\"\n";
405              push(@{$clids}, $OID);
406              $oid_to_clids->{$tempinfo->{'OID'}} = $clids;
407              #rint STDERR "Result: \"" . join(";", @{$clids}) . "\"\n";
408
409
410        } else {
411       
412        # Supress having top-level node in Collage classifier
413        # so no bookshelf icon appears, top-level, along with the
414        # applet
415       
416        if (!defined ($tempinfo->{'Title'}) || $tempinfo->{'Title'} ne "Collage") {
417            $contains_text .= "\".$next_subOID";
418        }
419
420                # Extra code for incremental building.
421                # We need to store a listing of the classifiers each DOI is in
422                my $clids = [];
423                #rint STDERR "==3. Recording reverse lookup for $OID.$next_subOID==\n";
424                if(defined($oid_to_clids->{$OID . "." . $next_subOID})) {
425                  #rint STDERR "Found existing array!\n";
426                  $clids = $oid_to_clids->{$OID . "." . $next_subOID};
427                }
428                #rint STDERR "Appended $OID to \"" . join(";", @{$clids}) . "\"\n";
429                push(@{$clids}, $OID);
430                $oid_to_clids->{$OID . "." . $next_subOID} = $clids;
431                #rint STDERR "Result: \"" . join(";", @{$clids}) . "\"\n";
432       
433        &print_classify_info ($infodb_handle, $tempinfo, "$OID.$next_subOID",
434                      $remove_empty_classifications);
435        $next_subOID++;
436        }
437    }
438   
439    $classify_infodb{"contains"} = [ $contains_text ];
440    $classify_infodb{"mdtype"} = [ $classifyinfo->{'mdtype'} ]
441    if defined $classifyinfo->{'mdtype'};
442    $classify_infodb{"mdoffset"} = [ $mdoffset_text ]
443    if ($mdoffset_text !~ m/^;+$/);
444   
445    &dbutil::write_infodb_entry($infodb_handle, $OID, \%classify_infodb);
446}
447
448
449sub check_contents {
450    my ($classifyinfo,$remove_empty_classifications) = @_;
451    $remove_empty_classifications = 0 unless ($remove_empty_classifications);
452    my $num_leaf_docs = 0;
453    my $sub_num_leaf_docs = 0;
454
455    return $classifyinfo->{'numleafdocs'} if (defined $classifyinfo->{'numleafdocs'});
456
457    foreach my $content (@{$classifyinfo->{'contains'}}) {
458    if (defined $content->{'OID'}) {
459        # found a book
460        $num_leaf_docs ++;
461    } elsif (($sub_num_leaf_docs = &check_contents ($content,$remove_empty_classifications)) > 0) {
462        # there's a book somewhere below
463        $num_leaf_docs += $sub_num_leaf_docs;
464    } else {
465        if ($remove_empty_classifications){
466        # section contains no books so we want to remove
467        # it from its parents contents
468        $content = undef;
469        }
470    }
471    }
472
473    $classifyinfo->{'numleafdocs'} = $num_leaf_docs;
474    return $num_leaf_docs;
475}
476
4771;
Note: See TracBrowser for help on using the browser.