Changeset 24600 for main/trunk/gli

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.

File:

• main/trunk/gli/src/org/greenstone/gatherer/Gatherer.java (modified) (4 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;
             }
         }