root/main/trunk/greenstone2/perllib/plugouts/GreenstoneSQLPlugout.pm @ 32560

Revision 32560, 15.0 KB (checked in by ak19, 9 months ago)

gssql constructor accepts a verbosity parameter

Line 
1###########################################################################
2#
3# GreenstoneSQLPlugout.pm -- plugout module for writing all or some the
4# Greenstone document format (metadata and/or fulltext) into a (My)SQL db.
5# The rest is then still written out by GreenstoneXMLPlugout as usual.
6# A component of the Greenstone digital library software
7# from the New Zealand Digital Library Project at the
8# University of Waikato, New Zealand.
9#
10# Copyright (C) 2006 New Zealand Digital Library Project
11#
12# This program is free software; you can redistribute it and/or modify
13# it under the terms of the GNU General Public License as published by
14# the Free Software Foundation; either version 2 of the License, or
15# (at your option) any later version.
16#
17# This program is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20# GNU General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with this program; if not, write to the Free Software
24# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25#
26###########################################################################
27
28package GreenstoneSQLPlugout;
29
30use strict;
31no strict 'refs';
32no strict 'subs';
33
34use GreenstoneXMLPlugout;
35use docprint;
36use gssql;
37
38use DBI; # the central package for this plugout
39
40
41# TODO: SIGTERM rollback and disconnect?
42# TODO Q: what about verbosity for debugging, instead of current situation of printing out upon debug set at the expense of writing to db
43# TODO Q: introduced site_name param to plugins and plugouts. Did I do it right? And should they have hiddengli = "yes"
44
45# this plugout does not output the metadata and/or fulltxt xml to a file,
46# but outputs rows into a mysql table for metadata and/or a table for fulltxt
47sub BEGIN {
48    @GreenstoneSQLPlugout::ISA = ('GreenstoneXMLPlugout');
49}
50
51# NOTTODO: die() statements need to be replaced with premature_termination
52# which should ensure the GreenstoneXMLPlugin (group)'s stuff is closed and cleaned up SOMEHOW
53# It's fine: the die() stmts all take place before setting up the super class' begin
54
55# TODO Q: about build_mode: how to detect removeold
56# TODO: deal with -removeold and everything? Or type out instructions for user
57
58# TODO Q: what is "group" in GreenstoneXMLPlugout?
59
60my $process_mode_list =
61    [ { 'name' => "meta_only",
62        'desc' => "{GreenstoneSQLPlug.process_mode.meta_only}" },     
63      { 'name' => "text_only",
64        'desc' => "{GreenstoneSQLPlug.process_mode.text_only}" },
65      { 'name' => "all",
66        'desc' => "{GreenstoneSQLPlug.process_mode.all}" } ];
67
68# The following are the saveas.options:
69my $arguments = [
70    { 'name' => "process_mode",
71      'desc' => "{GreenstoneSQLPlug.process_mode}",
72      'type' => "enum",
73      'list' => $process_mode_list,
74      'deft' => "all",
75      'reqd' => "no",
76      'hiddengli' => "no"},
77    { 'name' => "db_driver",
78      'desc' => "{GreenstoneSQLPlug.db_driver}",
79      'type' => "string",   
80      'deft' => "mysql",
81      'reqd' => "yes"},
82    { 'name' => "db_client_user",
83      'desc' => "{GreenstoneSQLPlug.db_client_user}",
84      'type' => "string",   
85      'deft' => "root",
86      'reqd' => "yes"},
87    { 'name' => "db_client_pwd",
88      'desc' => "{GreenstoneSQLPlug.db_client_pwd}",
89      'type' => "string",
90      'deft' => "",
91      'reqd' => "yes"}, # pwd required?
92    { 'name' => "db_host",
93      'desc' => "{GreenstoneSQLPlug.db_host}",
94      'type' => "string",
95      'deft' => "127.0.0.1",
96      'reqd' => "yes"}
97    ];
98
99my $options = { 'name'     => "GreenstoneSQLPlugout",
100        'desc'     => "{GreenstoneSQLPlugout.desc}",
101        'abstract' => "no",
102        'inherits' => "yes",
103        'args'     => $arguments };
104
105sub new {
106    my ($class) = shift (@_);
107    my ($plugoutlist, $inputargs,$hashArgOptLists) = @_;
108    push(@$plugoutlist, $class);
109
110    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
111    push(@{$hashArgOptLists->{"OptList"}},$options);
112
113    my $self = new GreenstoneXMLPlugout($plugoutlist,$inputargs,$hashArgOptLists);
114   
115    if ($self->{'info_only'}) {
116        # don't worry about any options etc
117        return bless $self, $class;
118    }
119    print STDERR "***** GreenstoneSQLPlugout process mode = \"", $self->{'process_mode'}, "\"\n";
120   
121    return bless $self, $class;
122}
123
124# connect here and ensure all tables and databases exist
125sub begin {
126
127    my $self= shift (@_);
128
129    # The saveas.options
130    #print STDERR "@@@@ PLUGOUT db_pwd: " . $self->{'db_client_pwd'} . "\n";
131    #print STDERR "@@@@ user: " . $self->{'db_client_user'} . "\n";
132    #print STDERR "@@@@ db_host: " . $self->{'db_host'} . "\n";
133    #print STDERR "@@@@ db_driver: " . $self->{'db_driver'} . "\n";
134    #print STDERR "@@@@ proc_mode: " . $self->{'process_mode'} . "\n";
135
136    ############ LOAD NECESSARY OPTIONS ###########
137    #print "@@@ plugout SITE NAME: ". $self->{'site_name'} . "\n" if defined $self->{'site_name'};
138    #print STDERR "########## COLLECTION: ". $ENV{'GSDLCOLLECTION'}."\n";
139
140    print STDERR "***** GreenstoneSQLPlugout process mode = \"", $self->{'process_mode'}, "\"\n";
141
142    my $db_params = {
143    'collection_name' => $ENV{'GSDLCOLLECTION'},
144    'verbosity' => 1   
145    };
146
147    my $gs_sql = new gssql($db_params);
148   
149    # try connecting to the mysql db, if that fails it will die
150    # so don't bother preparing GreenstoneXMLPlugout by calling superclass' begin()
151    if(!$gs_sql->connect_to_db({
152    'db_driver' => $self->{'db_driver'},
153    'db_client_user' => $self->{'db_client_user'},
154    'db_client_pwd' => $self->{'db_client_pwd'},
155    'db_host' => $self->{'db_host'}
156                   })
157    )
158    {
159    # This is fatal for the plugout, let's terminate here
160    # PrintError would already have displayed the warning message on connection fail   
161    die("Could not connect to db. Can't proceed.\n");
162    }
163   
164    my $db_name = $self->{'site_name'} || "greenstone2"; # one database per GS3 site, for GS2 the db is called greenstone2
165    my $build_mode = ($self->{'removeold'}) ? "removeold" : "incremental";
166    print STDERR "@@@@@@@@@@@@ remove_old: $build_mode\n";
167   
168    if(!$gs_sql->load_db_and_tables($db_name, $build_mode)) {
169   
170    # This is fatal for the plugout, let's terminate here after disconnecting again
171    # PrintError would already have displayed the warning message on load fail
172    $gs_sql->disconnect_from_db()
173        || warn("Unable to disconnect from database.\n");
174    die("Could not use db $db_name and/or prepare its tables. Can't proceed.\n");
175    }
176
177    # prepare the shared/common HANDLES to SQL insert statements that contain placeholders
178    # and which we will reuse repeatedly when actually executing the insert statements
179    my $proc_mode = $self->{'process_mode'};
180    if($proc_mode eq "all" || $proc_mode eq "meta_only" ) {
181    $self->{'metadata_prepared_insert_statement_handle'} = $gs_sql->prepare_insert_metadata_row_stmthandle();
182    }
183    if($proc_mode eq "all" || $proc_mode eq "text_only" ) {
184    $self->{'fulltxt_prepared_insert_statement_handle'} = $gs_sql->prepare_insert_fulltxt_row_stmthandle();
185    }
186
187    # store the DBI wrapper instance
188    $self->{'gs_sql'} = $gs_sql;
189   
190    print STDERR "#### Meta stmt: " . $self->{'metadata_prepared_insert_statement_handle'}->{'Statement'} . "\n";
191    print STDERR "#### Full stmt: " . $self->{'fulltxt_prepared_insert_statement_handle'}->{'Statement'} . "\n";
192   
193    # if setting up to work with sql db failed, we'd have terminated and wouldn't come up to here:
194    # won't bother preparing GreenstoneXMLPlugout by calling superclass' begin()
195    # finally, can call begin on super - important as doc.xml is opened as a group etc
196   
197    $self->SUPER::begin(@_);
198}
199
200# disconnect from database here, see inexport.pm
201sub end
202{
203    my $self = shift(@_);
204
205    # do the superclass stuff first, as any sql db failures should not prevent superclass cleanup
206    $self->SUPER::end(@_);   
207   
208    $self->{'gs_sql'}->disconnect_from_db() || warn("Unable to disconnect from database " . $self->{'site_name'} . "\n"); # disconnect_from_db() will also issue a warning, but this may be clearer
209}
210
211# Produce files called docsql.xml instead of doc.xml
212sub get_doc_xml_filename {
213    my $self = shift (@_);
214    my ($doc_obj) = @_;
215   
216    return "docsql.xml";
217}
218
219# overriding to store doc OID as attribute of top level element: <Archive docoid="oid">
220sub output_xml_header {
221    my $self = shift (@_);
222    my ($outhandle, $doc_oid) = @_;
223
224    print $outhandle '<?xml version="1.0" encoding="utf-8" standalone="no"?>' . "\n";
225    print $outhandle "<!DOCTYPE Archive SYSTEM \"http://greenstone.org/dtd/Archive/1.0/Archive.dtd\">\n";
226    print $outhandle "<Archive docoid=\"$doc_oid\">\n";
227}
228 
229# TODO: check arc-inf.db for whether each entry is to be deleted/indexed/reindexed/been indexed?
230# That's only for indexing, not for this step which only generates the content in archives dir
231sub saveas {
232    my $self = shift (@_);
233    my ($doc_obj, $doc_dir) = @_;
234
235#    print STDERR "\n\n@@@ In saveas\n\n";
236   
237    my $proc_mode = $self->{'process_mode'};
238   
239    # 1. pre save out and saving debug handle
240
241    # must call superclass (pre/post) saveas methods, as they handle assoc_files too
242    my ($docxml_outhandler, $output_file) = $self->SUPER::pre_saveas(@_);
243
244    $self->{'debug_outhandle'} = $docxml_outhandler if ($self->{'debug'}); # STDOUT if debug
245
246    # TODO: also set debugging in begin()? Then stmts creating db and tables also sent to debug out and not executed
247   
248   
249    # 2. overriding saving behaviour to do what the superclass does (writing out doc.xml files,
250    # under new name of docsql.xml, with breadcrumbs pointing to sql db) PLUS saving to sql db   
251
252    # NOTE: if proc_mode == all, then "breadcrumbs" (statements pointing viewer to the sql db
253    # for contents) go into both meta and txt elements of doc.xml (docsql.xml specifically):
254   
255    # write the INVERSE into doc.xml as to what is written to the SQL db   
256    my $docxml_output_options = { 'output' => docprint::OUTPUT_NONE };
257    if($proc_mode eq "meta_only" ) { # since only meta to go into MySQL db, text will go into docxml
258    $docxml_output_options->{'output'} = docprint::OUTPUT_TEXT_ONLY;
259    } elsif($proc_mode eq "text_only" ) { # since only full text to go into MySQL db, meta will go into docxml
260    $docxml_output_options->{'output'} = docprint::OUTPUT_META_ONLY;
261    }
262   
263    # now we've prepared to write out whatever is meant to go into docxml
264    # and can do actual the steps superclass GreenstoneXMLPlugout carries out to write out docxml
265    # So: write out the doc xml file, "docsql.xml", for the current document
266    my $section_text = &docprint::get_section_xml($doc_obj, $docxml_output_options);
267    print $docxml_outhandler $section_text;   
268   
269   
270    # We also write out whatever needs to go into the MySQL database
271    $self->write_meta_and_text($doc_obj);
272
273   
274    # 3. post save out
275    #$self->SUPER::post_saveas(@_);
276    $self->SUPER::post_saveas($doc_obj, $doc_dir, $docxml_outhandler, $output_file);
277   
278   
279    # database connection is closed in end() method
280    # so we don't open and close over and over for each doc during a single build
281}
282
283
284# write meta and/or text PER DOC out to DB
285sub write_meta_and_text {
286    my $self = shift (@_);
287    my ($doc_obj) = @_;
288    my $doc_oid = $doc_obj->get_OID(); # this method processes a single doc at a time, so it uses the same OID throughout
289    my $root_section = $doc_obj->get_top_section();
290
291    # load the prepared INSERT statement handles for both tables (can be undef for any table depending on whether meta_only or txt_only are set)
292    my $metadata_table_sth = $self->{'metadata_prepared_insert_statement_handle'};
293    my $fulltxt_table_sth = $self->{'fulltxt_prepared_insert_statement_handle'};
294   
295    $self->recursive_write_meta_and_text($doc_obj, $doc_oid, $root_section, $metadata_table_sth, $fulltxt_table_sth);
296}
297
298# Perl: Reading or Writing to Another Program
299# https://nnc3.com/mags/Perl3/cookbook/ch16_05.htm
300sub recursive_write_meta_and_text {
301    my $self = shift (@_);
302    my ($doc_obj, $doc_oid, $section, $metadata_table_sth, $fulltxt_table_sth) = @_;   
303
304    # If section=ROOT, write "root" as section name into table
305    # doc->get_top_section() is the name of the doc root section, which is ""
306    my $section_name = ($section eq "") ? "root" : $section;
307   
308    my $section_ptr = $doc_obj->_lookup_section ($section);
309    return "" unless defined $section_ptr;
310
311    my $debug_out = $self->{'debug_outhandle'};
312#    print STDERR "#### Meta stmt: " . $metadata_table_sth->{'Statement'} . "\n";
313#    print STDERR "#### Full stmt: " . $fulltxt_table_sth->{'Statement'} . "\n";
314   
315    #my $proc_mode = $self->{'process_mode'};
316    #if($proc_mode eq "all" || $proc_mode eq "meta_only" ) {
317    if($metadata_table_sth) { # meta insert statement handle will be undef if not writing meta
318   
319    foreach my $data (@{$section_ptr->{'metadata'}}) {
320        my $meta_name = $data->[0];
321        # TODO: does it need to be stored escaped, as it requires unescaping when read back in
322        # from db (unlike for reading back in from doc.xml)
323        my $escaped_meta_value = &docprint::escape_text($data->[1]);
324
325        # Write out the current section's meta to collection db's METADATA table       
326       
327        # for each set of values to write to meta table, execute the prepared statement, filling in the values
328
329        if($self->{'debug'}) {
330        # just print the statement we were going to execute
331
332        print $debug_out $metadata_table_sth->{'Statement'} . "($doc_oid, $section_name, $meta_name, $escaped_meta_value)\n";
333        }
334        else {
335       
336        $metadata_table_sth->execute($doc_oid, $section_name, $meta_name, $escaped_meta_value)
337            || warn ("Unable to write metadata row to db:\n\tOID $doc_oid, section $section_name,\n\tmeta name: $meta_name, val: $escaped_meta_value");
338        # Execution failure will print out info anyway: since db connection sets PrintError
339        }
340    }
341    }
342   
343    #if($proc_mode eq "all" || $proc_mode eq "text_only" ) {
344    if($fulltxt_table_sth) { # fulltxt insert statement handle will be undef if not writing fulltxt
345
346    if($self->{'debug'}) {
347        # just print the statement we were going to execute, minus the fulltxt value
348        my $txt_repr = $section_ptr->{'text'} ? "<TXT>" : "NULL";
349        print $debug_out $fulltxt_table_sth->{'Statement'} . "($doc_oid, $section_name, $txt_repr)\n";
350    } else {
351        my $section_text = &docprint::escape_text($section_ptr->{'text'});
352       
353        # fulltxt column can be SQL NULL. undef value gets written out as NULL:
354        # https://stackoverflow.com/questions/12708633/which-one-represents-null-undef-or-empty-string
355       
356        # Write out the current section's text to collection db's FULLTeXT table
357        $fulltxt_table_sth->execute($doc_oid, $section_name, $section_text)
358        || warn ("Unable to write fulltxt row to db for row:\n\tOID $doc_oid, section $section_name");
359        # Execution failure will print out info anyway: since db connection sets PrintError
360    }
361    }
362   
363    # output all subsections: RECURSIVE CALL
364    foreach my $subsection (@{$section_ptr->{'subsection_order'}}) {
365    $self->recursive_write_meta_and_text($doc_obj, $doc_oid, "$section.$subsection", $metadata_table_sth, $fulltxt_table_sth);
366    }
367}
368
369
3701;
Note: See TracBrowser for help on using the browser.