Changeset 32595 for main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm

Timestamp:

2018-11-09T22:33:51+13:00 (5 years ago)

Author:

ak19

Message:

Major tidying up: last remaining debug statements, lots of comments, removed TODO lists.

File:

• main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm (modified) (14 diffs)

main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm

@@ -39 +39 @@
 
 
-# + TODO: SIGTERM rollback and disconnect?
-# + TODO Q: what about verbosity for debugging, instead of current situation of printing out upon debug set at the expense of writing to db
-#+ TODO Q: introduced site param to plugins and plugouts. Did I do it right? And should they have hiddengli = "yes". No longer a param
-# !!!! Did I do the pass by ref in docprint's escape and unescape textref functions correctly, and how they're called here?
-#   Any more optimisation I can do around this?
-
-# this plugout does not output the metadata and/or fulltxt xml to a file,
-# but outputs rows into a mysql table for metadata and/or a table for fulltxt
+# This plugout does not output the metadata and/or fulltxt xml to a file,
+# but outputs rows into a MySQL db table for metadata and/or a db table for fulltxt
+
 sub BEGIN {
     @GreenstoneSQLPlugout::ISA = ('GreenstoneXMLPlugout');
 }
 
-# + NOTTODO: die() statements need to be replaced with premature_termination
-# which should ensure the GreenstoneXMLPlugin (group)'s stuff is closed and cleaned up SOMEHOW
-# It's fine: the die() stmts all take place before setting up the super class' begin
-
-# + TODO Q: about build_mode: how to detect removeold. Now handled by 
-#   GreenstoneSQLPlugout::remove_all(), which is inherited from a base plugin.
-# + TODO: deal with -removeold and everything? Or type out instructions for user
-
-# + TODO Q: what is "group" in GreenstoneXMLPlugout?
 
 my $process_mode_list =
@@ -141 +127 @@
         return bless $self, $class;
     }
-    #print STDERR "***** GreenstoneSQLPlugout process mode = \"", $self->{'process_mode'}, "\"\n";
     
     return bless $self, $class;
@@ -151 +136 @@
     my $self= shift (@_);
     
-    # The saveas.options
-    #print STDERR "@@@@ PLUGOUT db_pwd: " . $self->{'db_client_pwd'} . "\n";
-    #print STDERR "@@@@ user: " . $self->{'db_client_user'} . "\n";
-    #print STDERR "@@@@ db_host: " . $self->{'db_host'} . "\n";
-    #print STDERR "@@@@ db_driver: " . $self->{'db_driver'} . "\n";
-    #print STDERR "@@@@ proc_mode: " . $self->{'process_mode'} . "\n";
-
-    ############ LOAD NECESSARY OPTIONS ###########
-    #print "@@@ plugout SITE NAME: ". $self->{'site'} . "\n" if defined $self->{'site'};
-    #print STDERR "########## COLLECTION: ". $ENV{'GSDLCOLLECTION'}."\n";
-
-    print STDERR "***** GreenstoneSQLPlugout process mode = \"", $self->{'process_mode'}, "\"\n";
-
     my $db_params = {
     'collection_name' => $ENV{'GSDLCOLLECTION'},
@@ -192 +164 @@
     }
 
-    #die("@@@@ TEST. Connected successfully. Testing gsmysql::destructor.\n"); # WORKS
-    
     my $db_name = $self->{'site'} || "greenstone2"; # one database per GS3 site, for GS2 the db is called greenstone2
     my $proc_mode = $self->{'process_mode'};
@@ -201 +171 @@
     
     if($success && $proc_mode ne "text_only") {
-    ##print STDERR "@@@@ Ensuring meta table exists\n";
     $success = $gs_sql->ensure_meta_table_exists();
     }    
     if($success && $proc_mode ne "meta_only") {
-    ##print STDERR "@@@@ Ensuring fulltxt table exists\n";
     $success = $gs_sql->ensure_fulltxt_table_exists();
     }
@@ -213 +181 @@
     # PrintError would already have displayed the warning message on load fail
     # And on die() perl will call gsmysql destroy which will ensure a disconnect() from db
-    #$gs_sql->force_disconnect_from_db(); # disconnect_from_db() will issue a warning on error
     die("Could not use db $db_name and/or prepare its tables. Can't proceed.\n");
     }
@@ -221 +188 @@
     
     
-    # if setting up to work with sql db failed, we'd have terminated and wouldn't come up to here:
-    # won't bother preparing GreenstoneXMLPlugout by calling superclass' begin()
-    # finally, can call begin on super - important as doc.xml is opened as a group etc
+    # If setting up connection to sql db failed, we'd have terminated and wouldn't come up to here
+    # and wouldn't have bothered preparing GreenstoneXMLPlugout by calling superclass' begin().
+    # Finally, can call begin on super - important as doc.xml is opened as a group etc
     
     $self->SUPER::begin(@_);
@@ -261 +228 @@
 }
  
-# + X TODO: check arc-inf.db for whether each entry is to be deleted/indexed/reindexed/been indexed?
-# That's only for indexing, not for this step which only generates the content in archives dir
+# saveas() only generates the content in archives dir and in the SQL database
 sub saveas {
     my $self = shift (@_);
@@ -276 +242 @@
     $self->{'debug_outhandle'} = $docxml_outhandler if ($self->{'debug'}); # STDOUT if debug
 
-    # TODO: also set debugging in begin()? Then stmts creating db and tables also sent to debug out and not executed
-   
-    
     # 2. overriding saving behaviour to do what the superclass does (writing out doc.xml files,
     # under new name of docsql.xml, with breadcrumbs pointing to sql db) PLUS saving to sql db    
@@ -308 +271 @@
     
     
-    # database connection is closed in end() method
-    # so we don't open and close over and over for each doc during a single build
+    # database connection is closed once, in end() method
+    # We're not opening and closing over and over for each doc during a single build
 }
 
@@ -324 +287 @@
 }
 
-# Perl: Reading or Writing to Another Program
-# https://nnc3.com/mags/Perl3/cookbook/ch16_05.htm
 sub recursive_write_meta_and_text {
     my $self = shift (@_);
@@ -345 +306 @@
     foreach my $data (@{$section_ptr->{'metadata'}}) {
         my $meta_name = $data->[0];
-        # TODO: does it need to be stored escaped, as it requires unescaping when read back in
-        # from db (unlike for reading back in from doc.xml)
 
         # Treat db like a text file instead of an html/xml file: don't need to escape text
-        # going into it
-        #my $escaped_meta_value = &docprint::escape_text($data->[1]);
+        # going into it, unlike with doc(sql).xml
         my $meta_value = $data->[1];
         
@@ -359 +317 @@
         # filling in the values
         # OR if debugging, then it will print the SQL insert statement but not execute it
+        # (a behaviour following what the GS XML Plugout superclass does on debug)
         
         $gs_sql->insert_row_into_metadata_table($doc_oid, $section_name, $meta_name, $meta_value, $self->{'debug'});
@@ -368 +327 @@
 
     # See above, no need to html-escape for db
-    my $section_text = $section_ptr->{'text'}; #&docprint::escape_textref(\$section_ptr->{'text'});
+    my $section_text = $section_ptr->{'text'};
     
-    # fulltxt column can be SQL NULL. undef value gets written out as NULL:
+    # fulltxt column can be SQL NULL. undef value for $section_text gets written out as NULL:
     # https://stackoverflow.com/questions/12708633/which-one-represents-null-undef-or-empty-string
     # The following will do the SQL insertion