Changeset 32273 for main/trunk/greenstone2/perllib

Timestamp:

2018-07-13T20:40:24+12:00 (6 years ago)

Author:

ak19

Message:

First of the commits to do with restructuring and refactoring the PDFPlugin. 1. Introducing PDFv1Plugin.pm, which only runs the old pdftohtml. pdfbox_conversion are moved into PDFv2Plugin. 2. In the meantime we still have PDFPlugin, the current state of the plugin, for backward compatibility: it uses both the old pdftohtml tool and still has the pdfbox_conversion option. Yet to introduced the PDFv2Plugin. 3. gsConvert.pl has the new flag pdf_tool, set/passed in by PDFPlugin.pm and all PDFPlugin classes hereafter. The pdf_tool flag can be set to pdftohtml, xpdftools or pdfbox. PDFv1Plugin will always set it to pdftohtml, to denote the old pdftohtml tool is to be used, whereas PDFv2Plugin will set it to xpdftools and PDFBoxConverter sets it for symmetry's sake to pdfbox, even though being an AutoLoadConverter at present, the PDFBoxConverter class bypasses gsConvert.pl. gsConvert.pl uses the pdf_tool flag to determine which tool is to be used to do the conversion to produce the selected output_type. 4. Added some strings. One for migrating users to indicate that PDFPlugin was being deprecated in favour of the PDFv1 and PDFv2 plugins. Another was referenced by CommonUntil, and more recently by PDFPlugin, but was not defined in strings.properties. Once PDFv2Plugin has been added, need to remove references to paged_html from PDFPlugin.

Location:

main/trunk/greenstone2/perllib

Files:

• plugins/PDFPlugin.pm (modified) (3 diffs)
• plugins/PDFv1Plugin.pm (added)
• strings.properties (modified) (2 diffs)

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

@@ -140 +140 @@
     $self->{'file_type'} = "PDF";
 
+    # PDFPlugin is deprecated and migrating users should hereafter choose between
+    # PDFv1Plugin, if they want to use the old pdftohtml tool's capabilities,
+    # and PDFv2Plugin, if they want to use pdfbox or the new xpdftools capabilities.
+    &gsprintf::gsprintf(STDERR, "{PDFPlugin.deprecated_plugin}");
+    
     # these are passed through to gsConvert.pl by ConvertBinaryFile.pm
     my $zoom = $self->{"zoom"};
-    $self->{'convert_options'} = "-pdf_zoom $zoom";
+    # By default, PDFPlugin assumes gsConvert.pl will run the old pdftohtml conversion tool,
+    # But if pdfbox conversion is turned on, the tool used is pdfbox (which is presently an
+    # AutoLoadConverter and therefore bypasses gsConvert.pl)
+    $self->{'convert_options'} = "-pdf_tool pdftohtml"; 
+    $self->{'convert_options'} .= " -pdf_zoom $zoom";
     $self->{'convert_options'} .= " -pdf_complex" if $self->{"complex"};
     $self->{'convert_options'} .= " -pdf_nohidden" if $self->{"nohidden"};
@@ -151 +160 @@
     # TODO: Start supporting PDF to txt on Windows if we're going to be using XPDF Tools (incl pdftotext) on Windows/Linux/Mac
     if ($self->{'convert_to'} eq "text" && $ENV{'GSDLOS'} =~ /^windows$/i) {
-        print STDERR "On Windows, Greenstone now uses Xpdf tools to support pdf to text conversion.\n";
-    #print STDERR "Windows does not support pdf to text. PDFs will be converted to HTML instead\n";
-    #$self->{'convert_to'} = "html";
+    #print STDERR "On Windows, Greenstone now uses Xpdf tools to support pdf to text conversion.\n";
+    print STDERR "Windows does not support pdf to text. PDFs will be converted to HTML instead\n";
+    $self->{'convert_to'} = "html";
     }
     elsif ($self->{'convert_to'} eq "auto") {
@@ -407 +416 @@
     # Copying file open/close code from CommonUtil::utf8_write_file()
     if (!open (OUTFILE, ">:utf8", $output_filename)) {
-    gsprintf(STDERR, "PDFPlugin::xpdftohtml_convert_post_process {ConvertToPlug.could_not_open_for_writing} ($!)\n", $output_filename);
+    gsprintf(STDERR, "PDFPlugin::xpdftohtml_convert_post_process {CommonUtil.could_not_open_for_writing} ($!)\n", $output_filename);
     die "\n";
     }

main/trunk/greenstone2/perllib/strings.properties

@@ -809 +809 @@
 CommonUtil.block_exp:Files matching this regular expression will be blocked from being passed to any later plugins in the list.
 
+CommonUtil.could_not_open_for_writing:could not open %s for writing
+
 CommonUtil.desc:Base Utility plugin class that handles filename encoding and file blocking.
 
@@ -1165 +1167 @@
 PDFPlugin.convert_to.paged_html:A series of HTML pages, one for each page. Each HTML page contains selectable text positionally overlaid on top of a screenshot of the PDF page background comprising any images, tables and drawings.
 
-PDFPlugin.desc:Plugin that processes PDF documents.
+PDFPlugin.deprecated_plugin:*************IMPORTANT******************\nPDFPlugin is being deprecated.\nConsider upgrading to the recommended PDFv2Plugin, which supports newer versions of PDFs.\nAlternatively, if you wish to retain the old style of conversion and are NOT relying on PDFBox,\nchange to PDFv1Plugin.\nIf you are using PDFBox then upgrade to PDFv2Plugin.\n*****************************************\n
+
+PDFPlugin.desc:Plugin that processes PDF documents using the older pdftohtml tool. Does not support newer PDF versions.
 
 PDFPlugin.nohidden:Prevent pdftohtml from attempting to extract hidden text. This is only useful if the -complex option is also set.