1 | ###########################################################################
|
---|
2 | #
|
---|
3 | # BasPlug.pm -- base class for all the import plugins
|
---|
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 | package BasPlug;
|
---|
27 |
|
---|
28 |
|
---|
29 | sub new {
|
---|
30 | my ($class) = @_;
|
---|
31 |
|
---|
32 | return bless {}, $class;
|
---|
33 | }
|
---|
34 |
|
---|
35 | # return 1 if this class might recurse using $pluginfo
|
---|
36 | sub is_recursive {
|
---|
37 | my $self = shift (@_);
|
---|
38 |
|
---|
39 | die "BasPlug::is_recursive function must be implemented in sub classes\n";
|
---|
40 | }
|
---|
41 |
|
---|
42 | # return number of files processed, undef if can't process
|
---|
43 | # Note that $base_dir might be "" and that $file might
|
---|
44 | # include directories
|
---|
45 | sub read {
|
---|
46 | my $self = shift (@_);
|
---|
47 | my ($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs) = @_;
|
---|
48 |
|
---|
49 | die "BasPlug::read function must be implemented in sub classes\n";
|
---|
50 |
|
---|
51 | return undef; # will never get here
|
---|
52 | }
|
---|
53 |
|
---|
54 |
|
---|
55 | 1;
|
---|