source: main/trunk/greenstone2/perllib/plugins/PBConvertBinaryFile.pm@ 22674

package PBConvertBinaryFile;

use ConvertBinaryFile;

# ****
# Look into making a shared base class that does the same, but is parameterized
# on the name of the actual extension.  
#
# i.e. this file is the same as OOConvertBinaryFile with the following substitutions
#
#OO -> PB
#OpenOffice -> PDFBox
#openoffice -> pdfbox
#Open Office Conversion-> PDFBox Conversion

use gsprintf 'gsprintf';
# @ISA dynamically configured to be either PDFBoxConverter or ConvertBinaryFile

# do not initialise these variables
my $pdfbox_ext_installed;
my $pdfbox_ext_working;
sub BEGIN {
    eval("require PDFBoxConverter");
    if ($@) {
    # Useful debugging statement if there is a syntax error in PDFBoxConverter:
    # print STDERR "$@\n";
    $pdfbox_ext_installed = 0;
    $pdfbox_ext_working = 0;
    }
    else {
    # Successfully found
    $pdfbox_ext_installed = 1;
    # now check whether it can run soffice
    if ($PDFBoxConverter::pdfbox_conversion_available) {
        $pdfbox_ext_working = 1;
        
    } else {
        $pdfbox_ext_working = 0;
    }
    }

    if ($pdfbox_ext_working) {
    @PBConvertBinaryFile::ISA = ('ConvertBinaryFile', 'PDFBoxConverter');
    } else {
    @PBConvertBinaryFile::ISA = ('ConvertBinaryFile');
    }
}

my $opt_pdfbox_args = 
    [ { 'name' => "pdfbox_scripting",
    'desc' => "{PDFBoxConverter.pdfbox_scripting}",
    'type' => "flag",
    'reqd' => "no" } ];

my $arguments = [];

my $options = { 'name'     => "PBConvertBinaryFile",
        'desc'     => "{PBConvertBinaryFile.desc}",
        'abstract' => "yes",
        'inherits' => "yes",
        'args'     => $arguments };

sub new {
    my ($class) = shift (@_);
    my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
    push(@$pluginlist, $class);

    if ($pdfbox_ext_installed) {
    print STDERR "$class: PDFBox Extension to Greenstone detected\n";
    if (! $pdfbox_ext_working) {
        print STDERR "... but it appears to be broken\n";
        &gsprintf(STDERR, "PDFBoxConverter: {PDFBoxConverter.noconversionavailable} ({PDFBoxConverter.$PDFBoxConverter::no_pdfbox_conversion_reason})\n");
    }
    }

    if ($pdfbox_ext_working) {
    push(@$arguments,@$opt_pdfbox_args);
    }

    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
    push(@{$hashArgOptLists->{"OptList"}},$options);

    if ($pdfbox_ext_working) {
    
    my $ooc_self = new PDFBoxConverter($pluginlist, $inputargs, $hashArgOptLists,1);
    my $cbf_self = new ConvertBinaryFile($pluginlist, $inputargs, $hashArgOptLists);
    $self = BasePlugin::merge_inheritance($ooc_self, $cbf_self);
    $self->{'pdfbox_available'} = 1;
    }
    else {
    $self = new ConvertBinaryFile($pluginlist, $inputargs, $hashArgOptLists);
    $self->{'pdfbox_available'} = 0;
   }

    return bless $self, $class;

}


sub init {
    my $self = shift (@_);
    my ($verbosity, $outhandle, $failhandle) = @_;
    
    $self->SUPER::init($verbosity,$outhandle,$failhandle);
    if ($pdfbox_ext_working) {
    $self->PDFBoxConverter::init();
    }
}

sub begin {
    my $self = shift (@_);

    if ($pdfbox_ext_working) {
    $self->PDFBoxConverter::begin(@_);
    }
    $self->SUPER::begin(@_);
}

sub deinit {
    # called only once, after all plugin passes have been done
    my ($self) = @_;
    
    if ($pdfbox_ext_working) {
    $self->PDFBoxConverter::deinit();
    }
    $self->SUPER::deinit();
}

# if we are using open office, we use PDFBoxConverter's convert method, otherwise fall back to ConvertBinaryFile method.
sub tmp_area_convert_file {
    my $self = shift (@_);
    my ($output_ext, $input_filename, $textref) = @_;

    if ($pdfbox_ext_working && $self->{'pdfbox_scripting'}) {
    my ($result, $result_str, $new_filename) = $self->PDFBoxConverter::convert($input_filename, $output_ext);
    if ($result != 0) {
        return $new_filename;
    }
    my $outhandle=$self->{'outhandle'};
    print $outhandle "PDFBox Conversion error\n";
    print $outhandle $result_str;
    return "";
    }
    else {
    return $self->ConvertBinaryFile::tmp_area_convert_file(@_);
    }
}