Changeset 32592 for main/trunk/greenstone2/perllib/plugins/GreenstoneSQLPlugin.pm

Timestamp:

2018-11-09T19:13:32+13:00 (5 years ago)

Author:

ak19

Message:

Renamed gssql.pm to gsmysql.pm. Not subclassing the old gssql into gsmysql yet, as there's the complex issue of sighandlers, the static singleton method _get_connection_instance(), the singleton variable _db_instance and its use in the sighandlers and DESTROY, and how all of this can be impacted when making them part of an inheritance chain. Not sure of the best way to structure inheritance around these things. Even if rollback_on_cancel ends up unnecessary, the singleton method _get_connection_instance and singleton object _db_instance still impact decisions around inheritance.

File:

• main/trunk/greenstone2/perllib/plugins/GreenstoneSQLPlugin.pm (modified) (8 diffs)

main/trunk/greenstone2/perllib/plugins/GreenstoneSQLPlugin.pm

@@ -35 +35 @@
 use docprint; # for new unescape_text() subroutine
 use GreenstoneXMLPlugin;
-use gssql;
+use gsmysql;
 
 
 # TODO:
-# - Run TODOs here, in Plugout and in gssql.pm by Dr Bainbridge.
+# - Run TODOs here, in Plugout and in gsmysql.pm by Dr Bainbridge.
 # - Have not yet tested writing out just meta or just fulltxt to sql db and reading just that 
 # back in from the sql db while the remainder is to be read back in from the docsql .xml files.
@@ -71 +71 @@
 # Test doc with meta and text like macron in Maori text.
 # + TODO Q: During import, the GS SQL Plugin is called before the GS SQL Plugout with undesirable side
-# effect that if the db doesn't exist, gssql::use_db() fails, as it won't create db.
+# effect that if the db doesn't exist, gsmysql::use_db() fails, as it won't create db.
 #   This got fixed when GSSQLPlugin stopped connecting on init().
 #
@@ -89 +89 @@
 # Overriding plugins' remove_one() method is all I needed to do for reindex and deletion
 # (incremental and non-incremental) to work.
-# but doing all this needed an overhaul of gssql.pm and its use by the GS SQL plugin and plugout.
+# but doing all this needed an overhaul of gsmysql.pm and its use by the GS SQL plugin and plugout.
 # - needed to correct plugin.pm::remove_some() to process all files
 # - and needed to correct GreenstoneSQLPlugin::close_document() to setOID() after all
@@ -145 +145 @@
         'desc' => "{GreenstoneSQLPlug.rollbacl_on_cancel}" } ];
 
-# TODO: If subclassing gssql for other supporting databases and if they have different required
+# TODO: If subclassing gsmysql for other supporting databases and if they have different required
 # connection parameters, we can check how WordPlugin, upon detecting Word is installed,
 # dynamically loads Word specific configuration options.
@@ -229 +229 @@
 # as removeold, which should drop the collection tables, happens during the import phase,
 # calling GreenstoneSQLPlugin::and therefore also requires a db connection.
-# + TODO: Eventually can try moving get_gssql_instance into gssql.pm? That way both GS SQL Plugin
+# + TODO: Eventually can try moving get_gssql_instance into gsmysql.pm? That way both GS SQL Plugin
 # and Plugout would be using one connection during import.pl phase when both plugs exist.
 
@@ -252 +252 @@
     ####################
 
-    # create gssql object.
+    # create gsmysql object.
     # collection name will be used for naming tables (site name will be used for naming database)
-    my $gs_sql = new gssql({
+    my $gs_sql = new gsmysql({
     'collection_name' => $ENV{'GSDLCOLLECTION'},
     'verbosity' => $self->{'verbosity'} || 0
@@ -286 +286 @@
     # This is fatal for the plugout, let's terminate here after disconnecting again
     # PrintError would already have displayed the warning message on load fail
-    # And on die() perl will call gssql destroy which will ensure a disconnect() from db
+    # And on die() perl will call gsmysql destroy which will ensure a disconnect() from db
     #$gs_sql->force_disconnect_from_db();
     die("Could not use db $db_name. Can't proceed.\n");
@@ -310 +310 @@
 
     # Important to call finished():
-    # it will disconnect from db if this is the last gssql instance,
+    # it will disconnect from db if this is the last gsmysql instance,
     # and it will commit to db before disconnecting if rollbback_on_cancel turned on
     $self->{'gs_sql'}->finished();