Changeset 15872 for gsdl/trunk/perllib/plugins/DBPlugin.pm

Timestamp:

2008-06-05T09:29:32+12:00 (16 years ago)

Author:

kjdon

Message:

plugin overhaul: plugins renamed to xxPlugin, and in some cases the names are made more sensible. They now use the new base plugins. Hopefully we have better code reuse. Some of the plugins still need work done as I didn't want to spend another month doing this before committing it. Alos, I haven't really tested anything yet...

File:

• gsdl/trunk/perllib/plugins/DBPlugin.pm (modified) (19 diffs)

gsdl/trunk/perllib/plugins/DBPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# DBPlug.pm -- plugin to import records from a database
+# DBPlugin.pm -- plugin to import records from a database
 # 
 # A component of the Greenstone digital library software
@@ -34 +34 @@
 # Mar, Apr 2003
 
-package DBPlug;
+package DBPlugin;
 
 use strict;
 no strict 'refs'; # allow variable as a filehandle
 
-use BasPlug;
+use AutoExtractMetadata;
 use unicode;
 
-#use DBI; # database independent stuff
-
 sub BEGIN {
-    @DBPlug::ISA = ('BasPlug');
+    @DBPlugin::ISA = ('AutoExtractMetadata');
 }
 
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{AutoExtractMetadata.process_exp}",
     'type' => "regexp",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" }];
 
-my $options = { 'name'     => "DBPlug",
-        'desc'     => "{DBPlug.desc}",
+my $options = { 'name'     => "DBPlugin",
+        'desc'     => "{DBPlugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -66 +64 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
-
-    my $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
+
+    my $self = new AutoExtractMetadata($pluginlist, $inputargs, $hashArgOptLists);
 
     return bless $self, $class;
@@ -78 +76 @@
 
     return q^(?i)\.dbi$^;
-}
-# we don't have a per-greenstone document process() function!
-sub process {
-
 }
 
@@ -95 +89 @@
     my $verbosity = $self->{'verbosity'};
 
-    print $outhandle "DBPlug: processing $file\n" 
+    print $outhandle "DBPlugin: processing $file\n" 
     if $self->{'verbosity'} > 1;
    
@@ -114 +108 @@
     my $db=undef;
 
-# get id of pages from "nonempty", get latest version number from "recent", and
-# then get pagename from "page" and content from "version" !
+    # get id of pages from "nonempty", get latest version number from 
+    # "recent", and then get pagename from "page" and content from "version" !
 
     my $sql_query_prime = undef ;
@@ -126 +120 @@
     # read in config file.
     if (!open (CONF, $filename)) {
-        print $outhandle "DBPlug: can't read $filename: $!\n";
+        print $outhandle "DBPlugin: can't read $filename: $!\n";
         return 0;
     } 
@@ -145 +139 @@
         $callback =~ /[\`]|\|\-/) {
         # no backticks or functions that start new processes allowed
-        print $outhandle "DBPlug: bad function in callback\n";
+        print $outhandle "DBPlugin: bad function in callback\n";
         return 0;
         }
@@ -152 +146 @@
         my $ret = eval "\$callbacks{'$fieldname'} = $callback ; 1";
         if (!defined($ret)) {
-        print $outhandle "DBPlug: error eval'ing callback: $@\n";
+        print $outhandle "DBPlugin: error eval'ing callback: $@\n";
         exit(1);
         }
         $callback="";
-        print $outhandle "DBPlug: callback registered for '$fieldname'\n"
+        print $outhandle "DBPlugin: callback registered for '$fieldname'\n"
             if $dbplug_debug;
     } elsif ($callback) {
@@ -176 +170 @@
             chomp $err;
             $err =~ s/\.$//; # remove a trailing .
-            print $outhandle "DBPlug: error evaluating `$statement'\n";
+            print $outhandle "DBPlugin: error evaluating `$statement'\n";
             print $outhandle " $err (in $filename)\n";
             return 0; # there was an error reading the config file
@@ -185 +179 @@
         $statement = "";
         } else {
-        print $outhandle "DBPlug: skipping statement `$statement'\n";
+        print $outhandle "DBPlugin: skipping statement `$statement'\n";
         }
         $statement = "";
@@ -194 +188 @@
     
     if (!defined($db)) {
-    print $outhandle "DBPlug: error: $filename does not specify a db!\n";
+    print $outhandle "DBPlugin: error: $filename does not specify a db!\n";
     return 0;
     }
     if (!defined($sql_query)) {
-        print $outhandle "DBPlug: error: no SQL query specified!\n";
+        print $outhandle "DBPlugin: error: no SQL query specified!\n";
     return 0;
     }
@@ -205 +199 @@
 
     if (!defined($dbhandle)) {
-    die "DBPlug: could not connect to database, exiting.\n";
+    die "DBPlugin: could not connect to database, exiting.\n";
     }
     if (defined($dbplug_debug) && $dbplug_debug==1) {
-    print $outhandle "DBPlug (debug): connected ok\n";
+    print $outhandle "DBPlugin (debug): connected ok\n";
     }
 
@@ -238 +232 @@
     if (defined($db_to_greenstone_fields{$fieldname})) {
         if (defined($dbplug_debug) && $dbplug_debug==1) {
-        print $outhandle "DBPlug (debug): mapping db field "
+        print $outhandle "DBPlugin (debug): mapping db field "
             . "'$fieldname' to "
             . $db_to_greenstone_fields{$fieldname} . "\n";
@@ -255 +249 @@
     while (scalar(@row_array)) {
     if (defined($dbplug_debug) && $dbplug_debug==1) {
-        print $outhandle "DBPlug (debug): retrieved a row from query\n";
+        print $outhandle "DBPlugin (debug): retrieved a row from query\n";
     }
 
@@ -263 +257 @@
     my $cursection = $doc_obj->get_top_section();
 
-    # if $language not set in config file, will use BasPlug's default
+    # if $language not set in config file, will use BasePlugin's default
     if (defined($language)) {
         $doc_obj->add_utf8_metadata($cursection, "Language", $language);
     }
-    # if $encoding not set in config file, will use BasPlug's default
+    # if $encoding not set in config file, will use BasePlugin's default
     if (defined($encoding)) {
         # allow some common aliases
@@ -274 +268 @@
         $doc_obj->add_utf8_metadata($cursection, "Encoding", $encoding);
     }
-    $doc_obj->add_utf8_metadata($cursection,
-                    "Source", &ghtml::dmsafe($db));
+    $self->set_Source_metadata($doc_obj, $db, $encoding);
+
     if ($self->{'cover_image'}) {
         $self->associate_cover_image($doc_obj, $filename);
@@ -358 +352 @@
     # check "$sth->err" if empty array for error
     if ($statement_hand->err) {
-    print $outhandle "DBPlug: received error: \"" .
+    print $outhandle "DBPlugin: received error: \"" .
         $statement_hand->errstr . "\"\n";
     }
@@ -370 +364 @@
 
     if (defined($dbplug_debug) && $dbplug_debug==1) {
-        print $outhandle "DBPlug: imported $count DB records as documents.\n";
+        print $outhandle "DBPlugin: imported $count DB records as documents.\n";
     }
     $count;