Changeset 24600

Timestamp:

2011-09-15T16:31:11+12:00 (13 years ago)

Author:

ak19

Message:

Added gs-magick.pl script which will set the environment for ImageMagick (including LD_LIBRARY_PATH) before launching the requested ImageMagick command and arguments. By setting the Imagemagick environment from this script we ensure that the modified env variables don't create conflicts with libraries needed for normal linux execution. All the Greenstone files in the *binary* that made direct calls to imagemagick now go through this script. The affected files are perl files in bin/script and perllib and Gatherer.java of GLI. (wvware has files that test for imagemagick during compilation stage, which is independent of our changs which are only for users running imagemagick from a GS binary.) The final problems were related to how different perl files made use of the return values and the output of running their imagemagick command: they would query the 127 and/or and/or run the command with backtick operators to get the output printed to STDOUT. By inserting an intermediate gs-magick.pl file, needed to ensure that the exit code stored in 127 would at least be passed on correctly, as is necessary when testing the exit code against non-zero values or greater/less than zero (instead of comparing them with equals/not equal to 0). To get the correct exit code as emitted by imagemagick, calling code needs to shift bits in 127 and converting it to a signed value.

Location:

main/trunk

Files:

• gli/src/org/greenstone/gatherer/Gatherer.java (modified) (4 diffs)
• greenstone2/bin/script/gs-magick.pl (added)
• greenstone2/bin/script/gsConvert.pl (modified) (1 diff)
• greenstone2/bin/script/pdfpstoimg.pl (modified) (2 diffs)
• greenstone2/bin/script/pdftohtml.pl (modified) (1 diff)
• greenstone2/perllib/cgiactions/imageaction.pm (modified) (2 diffs)
• greenstone2/perllib/convertutil.pm (modified) (1 diff)
• greenstone2/perllib/giget.pm (modified) (2 diffs)
• greenstone2/perllib/plugins/HTMLImagePlugin.pm (modified) (4 diffs)
• greenstone2/perllib/plugins/ImageConverter.pm (modified) (4 diffs)
• greenstone2/perllib/plugins/StructuredHTMLPlugin.pm (modified) (2 diffs)

main/trunk/gli/src/org/greenstone/gatherer/Gatherer.java

@@ -439 +439 @@
             }
 
-            // Check for ImageMagick
-            if (Gatherer.isGsdlRemote) {
-                DebugStream.println("Not checking for ImageMagick.");
-            }
-            else if (!(new ImageMagickTest()).found()) {
-                // Time for a warning message
-                missingImageMagick();
-            }
-            
-            // Check for PDFBox
-            if (Gatherer.isGsdlRemote) {
-                DebugStream.println("Not checking for PDFBox.");
-            }
-            else {
-                String gs_dir = GS3 ? gsdl3_src_path : gsdl_path;
-                File pdfboxExtensionFolder = new File(gs_dir+File.separator+"ext"+File.separator+"pdf-box");
-                if (!(pdfboxExtensionFolder.exists() && pdfboxExtensionFolder.isDirectory())) {
-                // The user doesn't have PDFBox, inform them of it
-                String zipExtension = Utility.isWindows() ? "zip" : "tar.gz";
-                missingPDFBox(zipExtension, pdfboxExtensionFolder.getParent());
-                }
-            }
-
 
             if (Gatherer.isGsdlRemote) {
@@ -490 +467 @@
                     missingPERL();
                 }
+            }
+
+
+            // Check for ImageMagick - dependent on perl_path
+            if (Gatherer.isGsdlRemote) {
+                DebugStream.println("Not checking for ImageMagick.");
+            }
+            else if (!(new ImageMagickTest()).found()) {
+                // Time for a warning message
+                missingImageMagick();
+            }
+            
+            // Check for PDFBox
+            if (Gatherer.isGsdlRemote) {
+                DebugStream.println("Not checking for PDFBox.");
+            }
+            else {
+                String gs_dir = GS3 ? gsdl3_src_path : gsdl_path;
+                File pdfboxExtensionFolder = new File(gs_dir+File.separator+"ext"+File.separator+"pdf-box");
+                if (!(pdfboxExtensionFolder.exists() && pdfboxExtensionFolder.isDirectory())) {
+                // The user doesn't have PDFBox, inform them of it
+                String zipExtension = Utility.isWindows() ? "zip" : "tar.gz";
+                missingPDFBox(zipExtension, pdfboxExtensionFolder.getParent());
+                }
             }
 
@@ -1563 +1564 @@
         public boolean found()
         {
+            // at this stage, GLI has already sourced setup.bash, and the necessary
+            // env variables will be available to the perl process we're about to launch
+            boolean found = false;
+
             try {
-                String[] command = new String[2];
-                command[0] = (Utility.isWindows() ? "identify.exe" : "identify");
-                command[1] = "-version";
-                Process image_magick_process = Runtime.getRuntime().exec(command);
+                // run the command `/path/to/perl -S gs-magick.pl identify -version`
+                ArrayList cmd_list = new ArrayList();
+                if (!Gatherer.isGsdlRemote) {
+                if(Configuration.perl_path != null) {
+                    cmd_list.add(Configuration.perl_path);
+                } else {
+                    System.err.println("***** ImageMagickTest Warning: Perl_path not set, calling 'perl' instead.");
+                    cmd_list.add("perl");
+                }
+                cmd_list.add("-S");
+                }
+                cmd_list.add("gs-magick.pl");
+                if(Utility.isWindows()) {
+                cmd_list.add("identify.exe");
+                } else {
+                cmd_list.add("identify");
+                }
+                cmd_list.add("-version");
+
+                String[] command_parts = (String[]) cmd_list.toArray(new String[0]);
+
+                String cmd_str = "";
+                for(int i = 0; i < command_parts.length; i++) {
+                    cmd_str += command_parts[i] + " ";
+                }
+                DebugStream.println("***** Running ImageMagickTest command: " + cmd_str);
+
+                Process image_magick_process = Runtime.getRuntime().exec(command_parts);
                 image_magick_process.waitFor();
 
@@ -1574 +1603 @@
 
                 BufferedReader br = new BufferedReader(isr);
-                // Capture the standard output stream and seach for two particular occurances: Version and ImageMagick.
+                // Capture the standard output stream and seach for two particular occurrences: Version and ImageMagick.
 
                 String line = br.readLine();
-                if (line == null) {
-                    return false;
-                }
-                String lc_line = line.toLowerCase();
-                if (lc_line.indexOf("version") != -1 || lc_line.indexOf("imagemagick") != -1) {
-                    return true;
-                } else {
-                    return false;
-                }
-
+                if (line != null) {
+                    String lc_line = line.toLowerCase();
+                    if (lc_line.indexOf("version") != -1 || lc_line.indexOf("imagemagick") != -1) {
+                    //System.err.println("*** ImageMagickTest Line: " + line);
+                    found = true;
+                    } // else found var remains false
+                }
+
+                // Maybe put the close in a finally (but note that it can throw and IOex too)? See
+                // http://download.oracle.com/javase/tutorial/essential/exceptions/tryResourceClose.html
+                br.close();
+                return found;
                 //return (image_magick_process.exitValue() == 0);
             }
-            catch (IOException exception) {
-                return false;
-            }
-            catch (InterruptedException exception) {
-                return false;
+            catch (Exception exception) {   
+                exception.printStackTrace();
+                return found;
             }
         }

main/trunk/greenstone2/bin/script/gsConvert.pl

@@ -824 +824 @@
     # Check that ImageMagick is installed and available on the path (except for Windows 95/98)
     if (!($ENV{'GSDLOS'} eq "windows" && !Win32::IsWinNT())) {
-    my $result = `identify 2>&1`;
-    if ($? == -1 || $? == 256) {  # Linux and Windows return different values for "program not found"
+    my $imagick_cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl";
+    my $result = `$imagick_cmd identify 2>&1`;
+
+    # Linux and Windows return different values for "program not found".
+    # Linux returns -1 and Windows 256 for "program not found". But once they're
+    # converted to signed values, it will be -1 for Linux and 1 for Windows.
+    # Whenever we test for return values other than 0, shift by 8 and perform 
+    # unsigned to signed status conversion on $? to get expected range of return vals
+    # Although gs-magick.pl already shifts its $? by 8, converts it to a signed value
+    # and then exits on that, by the time we get here, we need to do it again
+    my $status = $?;
+    $status >>= 8;
+    $status = (($status & 0x80) ? -(0x100 - ($status & 0xFF)) : $status);   
+    if ($status == -1 || $status == 1) { #if ($status == -1 || $status == 256) {
         #ImageMagick is not installed, thus the convert utility is not available. 
         print STDERR "*** ImageMagick is not installed, the convert utility is not available. Unable to convert PDF/PS to images\n";

main/trunk/greenstone2/bin/script/pdfpstoimg.pl

@@ -88 +88 @@
     # with quoting when GSDLHOME might contain spaces) but assume
     # that the PATH is set up correctly.
-    $cmd = "convert";
+    $cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl convert";
 
     my $output_filename = &util::filename_cat($output_filestem, $input_basename);
@@ -100 +100 @@
     # note we return 0 if the file is "encrypted"
     $!=0;
-    if (system($cmd)!=0) {
+    my $status = system($cmd);
+    if ($status != 0) {
     print STDERR "Convert error for $input_filename $!\n";
     # leave these for gsConvert.pl...

main/trunk/greenstone2/bin/script/pdftohtml.pl

@@ -249 +249 @@
         $cmd = "pnmtopng \"${directory}$image\" > \"${directory}$image_base.png\" 2>/dev/null";
         if (system($cmd)!=0) {
-        $cmd = "convert \"${directory}$image\" \"${directory}$image_base.png\" 2>/dev/null";
+        $cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl convert \"${directory}$image\" \"${directory}$image_base.png\" 2>/dev/null";
         if (system($cmd)!=0) {
             print STDERR "Cannot convert $image into PNG format (tried `pnmtopng' and `convert')...\n";

main/trunk/greenstone2/perllib/cgiactions/imageaction.pm

@@ -29 +29 @@
 
 use cgiactions::baseaction;
+use util;
 
 @imageaction::ISA = ('baseaction');
@@ -158 +159 @@
 
 
-    my $cmd = "convert \"$src_full_assoc_filename\" ";
+    my $cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl convert \"$src_full_assoc_filename\" ";
     $cmd .= "-rotate 90 " if ($orientation eq "landscape");
 

main/trunk/greenstone2/perllib/convertutil.pm

@@ -175 +175 @@
     if ($command_status != 0) {
         $had_error = 1;
-
-        print $outhandle "Error: processing command failed.  Exit status $?\n";
+        
+        # for imagemagick commands that go via gs-magick.pl, need to shift exit code by 8 and then 
+        # convert to its signed value to get the actual exit code that imagemagick had emitted.
+        my $signed_cmd_status = $command_status;
+        $signed_cmd_status >>= 8;
+        $signed_cmd_status = (($signed_cmd_status & 0x80) ? -(0x100 - ($signed_cmd_status & 0xFF)) : $signed_cmd_status);   
+
+        print $outhandle "Error: processing command failed.  Exit status $command_status (signed value: $signed_cmd_status)\n";
 
         if ($verbosity >= 3) {

main/trunk/greenstone2/perllib/giget.pm

@@ -1 +1 @@
 use strict;
+use util;
 
 
@@ -150 +151 @@
         unlink $output_fname;
         }
-        elsif (system("identify \"$output_fname\"") > 0 ) {
-        print STDERR "**** NOT JPEG: output_fname \n";
-        unlink $output_fname;
-        }
         else {
-
-        my $command = "identify \"$output_fname\" 2>&1";
-        my $result = `$command`;
-
-        my $type =   'unknown';
-        my $width =  'unknown';
-        my $height = 'unknown';
-        
-        my $image_safe = quotemeta $output_fname;
-        if ($result =~ /^$image_safe (\w+) (\d+)x(\d+)/) {
-            $type = $1;
-            $width = $2;
-            $height = $3;
+        # need to shift the $? exit code returned by system() by 8 bits and
+        # then convert it to a signed value to work out whether it is indeed > 0
+        my $status = system("\"".&util::get_perl_exec()."\" -S gs-magick.pl identify \"$output_fname\"");
+        $status >>= 8;
+        $status = (($status & 0x80) ? -(0x100 - ($status & 0xFF)) : $status);
+
+        if($status > 0 ) {
+            print STDERR "**** NOT JPEG: output_fname \n";
+            unlink $output_fname;
+        } 
+        else {
+            my $command = "\"".&util::get_perl_exec()."\" -S gs-magick.pl identify \"$output_fname\" 2>&1";
+            my $result = `$command`;
+            
+            my $type =   'unknown';
+            my $width =  'unknown';
+            my $height = 'unknown';
+            
+            my $image_safe = quotemeta $output_fname;
+            if ($result =~ /^$image_safe (\w+) (\d+)x(\d+)/) {
+            $type = $1;
+            $width = $2;
+            $height = $3;
+            }
+            
+            my $imagick_cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl";
+            
+            if (($width ne "unknown") && ($height ne "unknown")) {
+            if (($width>200) || ($height>200)) {
+                `$imagick_cmd convert \"$output_fname\" -resize 200x200 /tmp/x.jpg`;
+                `/bin/mv /tmp/x.jpg \"$output_fname\"`;
+            }
+            }
+            $c++;
         }
-
-        if (($width ne "unknown") && ($height ne "unknown")) {
-            if (($width>200) || ($height>200)) {
-            `convert \"$output_fname\" -resize 200x200 /tmp/x.jpg`;
-            `/bin/mv /tmp/x.jpg \"$output_fname\"`;
-            }
-        }
-        $c++;
         }
 

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

@@ -451 +451 @@
     my ($filename, $orig_fp, $fn, $ext, $reltext, $relreltext, $crcid, $imgs,
     $thumbfp, $pagetitle, $alttext, $filepath, $aggr);
+
+    my $imagick_cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl";
+
     $aggr = $self->{'aggressiveness'};
     $imgs = \%{$self->{'imglist'}};
@@ -463 +466 @@
     ($fn, $ext) = $onlyfn =~ /(.*)\.(.*)/;
     $fn = lc $fn; $ext = lc $ext;
-    ($reltext) = "<tr><td>GifComment</td><td>" . `identify $filepath -ping -format "%c"` . "</td></tr>\n"
+    ($reltext) = "<tr><td>GifComment</td><td>" . `$imagick_cmd identify $filepath -ping -format "%c"` . "</td></tr>\n"
         if ($ext eq "gif");
     $reltext .= "<tr><td>FilePath</td><td>$orig_fp</td></tr>\n";
@@ -469 +472 @@
     if ($ENV{'GSDLOS'} =~ /^windows$/i) {
     $crcid = "$fn.$ext." . $self->{'next_crcid'}++;
-    } else { ($crcid) = `cksum $filepath` =~ /^(\d+)/; }
+    } else { 
+    ($crcid) = `cksum $filepath` =~ /^(\d+)/; 
+    }
+    
     $thumbfp = "$tndir/tn_$crcid.jpg";
-    `convert -flatten -filter Hanning $self->{'convert_params'} -geometry "$self->{'thumb_size'}x$self->{'thumb_size'}>" $filepath $thumbfp` unless -e $thumbfp;
+    `$imagick_cmd convert -flatten -filter Hanning $self->{'convert_params'} -geometry "$self->{'thumb_size'}x$self->{'thumb_size'}>" $filepath $thumbfp` unless -e $thumbfp;
     if ( ! (-e $thumbfp) ) {
     print STDERR "HTMLImagePlugin: 'convert' failed. Check ImageMagicK binaries are installed and working correctly\n"; return 0; 
@@ -983 +989 @@
     # can't modify real filepath var because it
     # then can't be located in the page for tag recognition later
+    my $imagick_cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl";
     ($width, $height) = 
-        `identify $abspath -ping -format "%wx%h"` =~ /^(\d*)x(\d*)$/m;
+        `$imagick_cmd identify $abspath -ping -format "%wx%h"` =~ /^(\d*)x(\d*)$/m;
     if (! ($width && $height)) { 
         print STDERR "HTMLImagePlugin: ($abspath) 'identify' failed. Check ImageMagicK binaries are installed and working correctly\n"; next;

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

@@ -32 +32 @@
 no strict 'refs'; # allow filehandles to be variables and viceversa
 
+use util;
 use gsprintf 'gsprintf';
 
@@ -131 +132 @@
     $no_image_conversion_reason = "win95notsupported";
     } else {
-    my $result = `identify -help 2>&1`;
+    my $imagick_cmd = "\"".&util::get_perl_exec()."\" -S gs-magick.pl";
+    my $result = `$imagick_cmd identify -help 2>&1`;
     my $return_value = $?;
- 
-    if ( ($ENV{'GSDLOS'} eq "windows" && $return_value == 256) || $return_value == -1) {  # Linux and Windows return different values for "program not found"
+
+    # When testing against non-zero return_value ($?), need to shift by 8 
+    # and convert it to its signed value. Linux returns -1 and Windows returns 
+    # 256 for "program not found". The signed equivalents are -1 and 1 respectively.
+    $return_value >>= 8;
+    $return_value = (($return_value & 0x80) ? -(0x100 - ($return_value & 0xFF)) : $return_value);
+
+    if ( ($ENV{'GSDLOS'} eq "windows" && $return_value == 1) || $return_value == -1) {  # Linux and Windows return different values for "program not found"
         $image_conversion_available = 0;
         $no_image_conversion_reason = "imagemagicknotinstalled";
@@ -407 +415 @@
 
     # Generate and run the convert command
-    my $convert_command = "convert -interlace plane -verbose $convert_options \"$source_file_path\" \"$target_file_path\"";
+    my $convert_command = "\"".&util::get_perl_exec()."\" -S gs-magick.pl convert -interlace plane -verbose $convert_options \"$source_file_path\" \"$target_file_path\"";
 
     my $print_info = { 'message_prefix' => $convert_id,
@@ -439 +447 @@
 
     # Use the ImageMagick "identify" command to get the file specs
-    my $command = "identify \"$image\" 2>&1";
+    my $command = "\"".&util::get_perl_exec()."\" -S gs-magick.pl identify \"$image\" 2>&1";
     print $outhandle "$command\n" if ($verbosity > 2);
     my $result = '';

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

@@ -36 +36 @@
 use HTMLPlugin;
 use ImageConverter; # want the identify method
+use util;
 
 use strict; # every perl program should have this!
@@ -327 +328 @@
         my $command = "convert -interlace plane -verbose "
         ."-geometry $newsize \"$img_filename\" \"$resized_filename\"";
+        $command = "\"".&util::get_perl_exec()."\" -S gs-magick.pl $command";
         #print $outhandle "ImageResize: $command\n" if ($verbosity > 2);
         #my $result = '';