Changeset 1011

Timestamp:

05/21/05 09:53:27 (4 years ago)

Author:

torben

Message:

Moved the utility helper locations to the MidCOM configuration.
Did a lot of code cleanup along the way.

Note, that this transition is yet untested.

Files:

• trunk/lib/midcom/config/midcom_config.php (modified) (3 diffs)
• trunk/lib/midcom/helper/datamanager/datatype_image.php (modified) (17 diffs)
• trunk/lib/midcom/services/indexer/document_attachment.php (modified) (6 diffs)
• trunk/lib/net/siriux/photos/Photo.php (modified) (6 diffs)
• trunk/lib/net/siriux/photos/admin.php (modified) (8 diffs)
• trunk/lib/net/siriux/photos/filter.php (modified) (16 diffs)
• trunk/lib/net/siriux/photos/style/admin_upload.php (modified) (1 diff)

trunk/lib/midcom/config/midcom_config.php

@@ -142 +142 @@
- *   that, it might contain an URL which is not suitable for relcoations.
- * 
+ * <b>Utility Programs</b>
+ * 
+ * The various paths set here lead to the utility programs required by MidCOM, both 
+ * mandatory and optional applications are listed here. To indicate that a certain 
+ * application is unavailable, set it to null. It is recommended to set this in the
+ * /etc/midgard/midcom.conf file. The defaults assume that the files are within the
+ * $PATH of the Apache user and should be sufficient in most cases. Package mainatainers
+ * are encouraged to make the paths explicit.
+ * 
+ * - <b>string utility_imagemagick_base:</b> The base path of the ImageMagick executables,
+ *   the tools <i>mogrify</i>, <i>identify</i> and <i>convert</i> are needed for almost 
+ *   all kinds of image operations in MidCOM and have to be present therefore. The path
+ *   entered here requires a trailing slash.
+ * - <b>string utility_jpegtran:</b> JPEGTran is used to do losless rotation of JPEG
+ *   images for automatic EXIF rotation in n.s.photos for example. If unavailable, 
+ *   there is an automatic fallback to imagemagick.
+ * - <b>string utility_unzip:</b> The unzip utility, used for bulk uploads.
+ * - <b>string utility_gzip:</b> The gzip utility, used for bulk uploads.
+ * - <b>string utility_tar:</b> The tar utility, used for bulk uploads.
+ * - <b>string utility_jhead:</b> The jhead utility, used as a fallback to read EXIF
+ *   information if the PHP implementation (pre 4.3) is buggy.
+ * - <b>string utility_find:</b> The Find utility is used for bulk upload preprocessing 
+ *   and the like.
+ * - <b>string utility_file:</b> Utility to identify all kinds of uploaded files.
+ * - <b>string utility_catdoc:</b> Transforms Word Documents into text for indexing.
+ * - <b>string utility_pdftotext:</b> Transforms PDF Documents into text for indexing.
+ * - <b>string utility_unrtf:</b> Transforms RTF Documents into text files for indexing.
+ *  
+ * 
- * <b>Visibility settings (NAP)</b>
- * 
@@ -149 +178 @@
- * - <b>bool show_unapproved_objects:</b> This flag indicates wether objects should be
- *   shown even if they are not approved. This defaults to true.  
- * 
- * 
- * 
@@ -218 +246 @@
-$GLOBALS['midcom_config_default']['midcom_root_topic_guid'] = '';
-$GLOBALS['midcom_config_default']['midcom_site_url'] = '/';
+
+
+// Utilities
+$GLOBALS['midcom_config_default']['utility_imagemagick_base'] = '';
+$GLOBALS['midcom_config_default']['utility_jpegtran'] = 'jpegtran';
+$GLOBALS['midcom_config_default']['utility_unzip'] = 'unzip';
+$GLOBALS['midcom_config_default']['utility_gzip'] = 'gzip';
+$GLOBALS['midcom_config_default']['utility_tar'] = 'tar';
+$GLOBALS['midcom_config_default']['utility_jhead'] = 'jhead';
+$GLOBALS['midcom_config_default']['utility_find'] = 'find';
+$GLOBALS['midcom_config_default']['utility_file'] = 'file';
+$GLOBALS['midcom_config_default']['utility_catdoc'] = 'catdoc';
+$GLOBALS['midcom_config_default']['utility_pdftotext'] = 'pdftotext';
+$GLOBALS['midcom_config_default']['utility_unrtf'] = 'unrtf';
+
+
+// gzip tar jhead
+
-
-

trunk/lib/midcom/helper/datamanager/datatype_image.php

@@ -133 +133 @@
-    }
-    
-
+
+
-        debug_push("midcom_helper_datamanager_datatype_image::_handle_upload");
-        
@@ -152 +153 @@
-        $convert_options_thumb = '+profile "*" -quality ' . (int) $this->_thumbjpegqual;
-
-        /* check if "convert" is installed */
-        $convert = exec("which convert");
-        if ($convert == "") {
-            $midcom_errstr = "Could not find image convert utility in path.";
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
-            debug_add("Leaving");
-            debug_pop();
-            return false;
-        }
-
-        $id = parent::_handle_upload($params, $meta);
-        if (!$id) {
@@ -179 +170 @@
-        /* store image as-is, no thumbnail etc. */
-        
-
+
+
-            debug_add("Storing thumbnail as-is, no further conversion.", MIDCOM_LOG_DEBUG);
-            /* thumbguid == attachment guid
@@ -192 +184 @@
-        /* get mimetype and mimetype to convert to */
-        $file_orig = $params["tmp_name"];
-file -ib $file_orig
-$orig_mimetype
+{$GLOBALS['midcom_config']['utility_file']} -ib {$file_orig}
+{$orig_mimetype}
-        
-        /* auto detect mime type and file extension */
-
+
+
-            case "image/png":
-            case "image/gif":
@@ -213 +206 @@
-        debug_add("auto detected extension: " . $auto_ext, MIDCOM_LOG_DEBUG);
-
-
+
+
-            case "":
-                // auto detect
@@ -240 +234 @@
-        debug_add("new extension: " . $new_ext, MIDCOM_LOG_DEBUG);
-        
-
+
+
-            case "":
-                // auto detect
@@ -269 +264 @@
-        $file_tmp_thumb = $tmp_dir."/thumb_".$file_base.".".$thumb_ext;
-        
-
+
+
+
-            // convert original and overwrite attachment
-            debug_add("convert original and overwrite attachment...", MIDCOM_LOG_DEBUG);           
-            
-            // the "[0]" in the command line makes convert take only the first frame of an animated gif file...
-
+{$GLOBALS['midcom_config']['utility_imagemagick_base']}
-            debug_add("Executing: $cmd", MIDCOM_LOG_DEBUG);
-            exec($cmd);
-            
-            $dest = mgd_open_attachment($id);
-
+
+
-                $midcom_errstr = "Could not open File Attachment for writing: " . mgd_errstr();
-                debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -286 +284 @@
-            }
-            $source = fopen($file_tmp_orig,"r");
-
+
+
-                $midcom_errstr = "Could not open converted image for reading, aborting thumbnail creation.";
-                debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -294 +293 @@
-                return false;
-            }
-
+
+
-                fwrite($dest, fread($source, 100000));
+            }
-        
-            fclose($dest);
@@ -310 +311 @@
-        
-        $size = getimagesize($file_orig);
-
+
+
-            $orig_x = $size[0];
-            $orig_y = $size[1];
-            debug_add("original size: ".$orig_x."x".$orig_y, MIDCOM_LOG_DEBUG);
-
+
+
+
-            $orig_x = false;
-            $orig_y = false;
@@ -321 +325 @@
-  
-        /* create thumbnail */
-
+{$GLOBALS['midcom_config']['utility_imagemagick_base']}
-        debug_add("Executing: $cmd", MIDCOM_LOG_DEBUG);
-        exec($cmd);
-
-        /* run external filters 
-         *
-         * Code disabled until the author takes a minute to think about uniform code formatting,
-         * things like indentation width and spaces between operators
-         * 
-        if ($this->_filterfunction) {
-          $filter = $this->_filterfunction;
-          debug_add("Executing: ".$filter."(".$file_tmp_thumb.")", MIDCOM_LOG_DEBUG);
-          $filter($file_tmp_thumb);
-        }
-        */
-        
-        $size = getimagesize($file_tmp_thumb);
-
+
+
-            $new_x = $size[0];
-            $new_y = $size[1];
-            debug_add("thumbnail size: ".$new_x."x".$new_y, MIDCOM_LOG_DEBUG);
-
+
+
+
-            $new_x = false;
-            $new_y = false;
@@ -352 +347 @@
-        $filename = basename($file_tmp_thumb);
-       
-
+
+
-            $midcom_errstr = "A file with the thumbnail file name already exists.";
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -360 +356 @@
-        
-        $thumb_id = $this->_storage->createattachment($filename, $att->title, $new_mimetype);
-
+
+
-            $midcom_errstr = "Could not create Thumbnail File Attachment: " . mgd_errstr();
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -368 +365 @@
-        
-        $dest = mgd_open_attachment($thumb_id);
-
+
+
-            $midcom_errstr = "Could not open Thumbnail File Attachment for writing: " . mgd_errstr();
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -375 +373 @@
-        }
-        $source = fopen($file_tmp_thumb,"r");
-
+
+
-            $midcom_errstr = "Could not open scaled image for reading, aborting thumbnail creation.";
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
@@ -383 +382 @@
-            return $id;
-        }
-
+
+
-            fwrite($dest, fread($source, 100000));
+        }
-        
-        /* clean up */
@@ -395 +396 @@
-        $thumb_att = mgd_get_attachment($thumb_id);
-        $thumb_att->parameter("midcom.helper.datamanager.datatype.image","parent_guid",$att->guid());
-
+
+
-            $thumb_att->parameter("midcom.helper.datamanager.datatype.blob","size_x",$new_x);
-            $thumb_att->parameter("midcom.helper.datamanager.datatype.blob","size_y",$new_y);

trunk/lib/midcom/services/indexer/document_attachment.php

@@ -180 +180 @@
-    function _process_mime_word()
-    {
-! @exec('which catdoc'
+is_null($GLOBALS['midcom_config']['utility_catdoc']
-        {
-            debug_add('Could not find catdoc, indexing as binary.', MIDCOM_LOG_INFO);
@@ -192 +192 @@
-        $encoding = (strtoupper($this->_i18n->get_current_charset()) == 'UTF-8') ? 'utf-8' : '8859-1';
-        
-catdoc
+{$GLOBALS['midcom_config']['utility_catdoc']}
-        debug_add("Executing: {$command}");
-        exec ($command, $result, $returncode);
@@ -213 +213 @@
-    function _process_mime_pdf()
-    {
-! @exec('which pdftotext'
+is_null($GLOBALS['midcom_config']['utility_pdftotext']
-        {
-            debug_add('Could not find pdftotext, indexing as binary.', MIDCOM_LOG_INFO);
@@ -225 +225 @@
-        $encoding = (strtoupper($this->_i18n->get_current_charset()) == 'UTF-8') ? 'UTF-8' : 'Latin1';
-        
-pdftotext
+{$GLOBALS['midcom_config']['utility_pdftotext']}
-        debug_add("Executing: {$command}");
-        exec ($command, $result, $returncode);
@@ -244 +244 @@
-    function _process_mime_richtext()
-    {
-! @exec('which unrtf'
+is_null($GLOBALS['midcom_config']['utility_unrtf']
-        {
-            debug_add('Could not find unrtf, indexing as binary.', MIDCOM_LOG_INFO);
@@ -257 +257 @@
-        
-        // Kill the first five lines, they are crap from the converter.
-unrtf
+{$GLOBALS['midcom_config']['utility_unrtf']}
-        debug_add("Executing: {$command}");
-        exec ($command, $result, $returncode);

trunk/lib/net/siriux/photos/Photo.php

@@ -567 +567 @@
-        $geometry = escapeshellarg("{$width}x{$height}");
-        $tmpfile = tempnam ("/tmp", "net_siriux_photos");
-
+{$GLOBALS['midcom_config']['utility_imagemagick_base']}
-            . " -geometry $geometry -quality 80 +profile '*' -colorspace RGB"
-            . ' -unsharp 1x5 -modulate 100,110,100 -gamma 0.95'
@@ -726 +726 @@
-     * @return bool Indicating success.
-     */
-
-
+
+
+
+
-            $tmpfile = $this->_writeFullscaleFile();
-            if (! $tmpfile)
-                return FALSE;
-
+
+
+
-            $tmpfile = $file;
-        }
-        
-        $mode = "timestamp";
-@exec("which jhead"
+! is_null($GLOBALS['midcom_config']['utility_jhead']
-        $have_php = function_exists("read_exif_data");
-        
-        /* Detect operation mode, first check for PHP Version */
-
+
+
-            /* We have a version piror 4.2.0. exifread might be broken there. */
-            if ($have_jhead)
+            {
-                $mode = "jhead";
+            }
-            else if ($have_php)
+            {
-                $mode = "php";
-
+
+
+
+
-            if ($have_php)
+            {
-                $mode = "php";
+            }
-            else if ($have_jhead)
+            {
-                $mode = "jhead";
+            }
-        }
-        
@@ -758 +773 @@
-        $force = $this->_config->get("force_exif_reader");
-        if ($force == "php" && $have_php)
+        {
-            $mode = "php";
+        }
-        else if ($force == "jhead" && $have_jhead)
+        {
-            $mode = "jhead";
+        }
-        
-        debug_add("Trying EXIF Reader mode $mode");
@@ -769 +788 @@
-                $this->_getExifDataPHP($tmpfile);
-                if (! $this->_config->get("disable_autosync_created"))
+                {
-                    $this->syncArticleCreated();
+                }
-                break;
+                
-            case "jhead":
-                $this->_getExifDataJhead($tmpfile);
-                if (! $this->_config->get("disable_autosync_created"))
+                {
-                    $this->syncArticleCreated();
+                }
-                break;
+                
-            case "timestamp":
-                $this->_getExifDataTimestamp($tmpfile);
-                break;
+                
-            default:
-                die ("Unknown EXIF Reader selected, this should not happen.");
@@ -831 +857 @@
-     * @param string file The file from which to get the EXIF data.
-     */
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-                    $explodeReturn = explode(':', $value, 2);
-
-
-
-
-
-
+
+
+
+
+
+
+
-                    }
-                }
-            }            
-
+
+
+
-            debug_add("No EXIF Data found, so not setting anything.");
-            $taken = 0;
-        }
-
-
+
+
-            debug_add("EXIF Date not found, so not setting it.");
-            $taken = 0;
@@ -859 +893 @@
-        // replace silly colons in EXIF dates
-        $date = preg_replace("/(\d{4}):(\d{2}):(\d{2}) (\d{2}):(\d{2}):(\d{2})/", '\1-\2-\3 \4:\5:\6', $exif["Date/Time"]);
-
+
+
+
-            debug_add("Could not transform EXIF-Date into an ISO Timestamp, ignoring it.");
-            $taken = 0;

trunk/lib/net/siriux/photos/admin.php

@@ -86 +86 @@
-
-
-
+
+
-        debug_push($this->_debug_prefix."can_handle");
-        
@@ -94 +95 @@
-        $GLOBALS["midcom"]->set_custom_context_data("errstr", $this->errstr);
-        
-        /* check if "convert" is installed */
-        $convert = exec("which convert");
-        if ($convert == "") 
-        {
-            $midcom_errstr = "Could not find image convert utility in path.";
-            debug_add($midcom_errstr, MIDCOM_LOG_ERROR);
-            debug_add("Leaving");
-            debug_pop();
-            $GLOBALS["midcom"]->generate_error(MIDCOM_ERRCRIT, "Could not find image convert utility in path. Aborting.");
-            return false;
-        }
-        
-        debug_pop();
-        
@@ -113 +102 @@
-        }
-        
-
+
+
-            case "upload":
-            case "config":
@@ -137 +127 @@
-
-
-
+
+
-        debug_push($this->_debug_prefix . "handle");
-        
@@ -454 +445 @@
-        $uploadtempdir = "/tmp/net.siriux.photos.upload." . time() . "." . getmypid();
-        
-
+
+
-            case "zip":
-                $compressed = true;
-                $unzipcmd = 
-'unzip '
+"{$GLOBALS['midcom_config']['utility_unzip']} "
-                    . escapeshellarg($file['tmp_name'])
-                    . " -d{$uploadtempdir}";
@@ -467 +459 @@
-                $compressed = true;
-                $unzipcmd =
-tar
+{$GLOBALS['midcom_config']['utility_tar']}
-                    . escapeshellarg($file["tmp_name"]);
-                break;
@@ -501 +493 @@
-            
-            $find_result = Array();
-find
+{$GLOBALS['midcom_config']['utility_find']}
-            foreach ($find_result as $fullname)
-            {
@@ -691 +683 @@
-    function check_uploaded_image ($filename)
-    {
-
+
+
-        debug_add("Executing: {$cmd}");
-        exec ($cmd, $output, $return);
-
+=
-        {
-            debug_add("Check of image {$filename} failed, imagemagick return exit code {$return}", MIDCOM_LOG_INFO);

trunk/lib/net/siriux/photos/filter.php

@@ -11 +11 @@
-
-/**
-
+
+
+
+
- * 
- * @author Eero af Heurlin, Nemein Oy <eero.afheurlin@nemein.com>
@@ -19 +22 @@
- * @package net.siriux.photos
- */
-
+
+
-    
-    /**
@@ -42 +46 @@
-     * The constructor does a bit of variable initialization
-     */
-
+
+
-        $this->_filename = null;
-        $this->_quality = "-quality 90";
@@ -61 +66 @@
-     * @returns true, if the file is valid, false otherwise.
-     */
-
-
+
+
+
+
-            debug_add("The File {$filename} is not writeable.", MIDCOM_LOG_INFO);
-            return false;
@@ -80 +87 @@
-     * @returns true, if all filters have been successfully applied, false otherwise.
-     */
-
+
+
-        $filters = explode(";", $chain);
-        
-
-
+
+
+
+
-                debug_add("Execution of {$cmd} failed, aborting now.");
-                return false;
@@ -108 +118 @@
-     * @returns true, if the filter executed successfully, false otherwise.
-     */
-
+
+
-        debug_add("Parsing command {$cmd}");
-        $i = preg_match('/([a-z_]*)\(([^)]*)\)/', $cmd, $matches);
-
+
+
-            debug_add("Failed to parse command {$cmd}, aborting.", MIDCOM_LOG_INFO);
-            return false;
@@ -120 +132 @@
-        debug_print_r("Have to execute {$command} with these arguments:", $args);
-        
-
+
+
-            case "gamma":
-                if (array_key_exists(0, $args) && $args[0] > 0)
@@ -165 +178 @@
-     * the transformed image to. Has to be managed by the callee.
-     */
-
+
+
-        return tempnam("/tmp", "net_siriux_photos");
-    }
@@ -173 +187 @@
-     * of $tmpfile, deleting the temporary file afterwards.
-     */
-
+
+
-        $src = fopen($tmpname, "r");
-        $dst = fopen($this->_filename, "w+");
-
+
+
-            $buffer = fread($src, 131072); /* 128 kB */
-            fwrite($dst, $buffer, 131072);
@@ -231 +247 @@
-     * @returns true on success.
-     */
-
-
-
+
+
+
+
-        
-        exec($cmd, $output, $exit_code);
-debug_print_r("Imagemagick returned with {$exit_code} and produced this output:", $output);
-
-if ($exit_code === 0) 
+
+if ($exit_code === 0) 
+
-            return true;
-
-
-
+
+
+
+
+
+
-            return false;
-        }
@@ -258 +278 @@
-     * @returns true on success.
-     */
-
-
+
+
+
+
-            debug_add("read_exif_data required for exifrotate.", MIDCOM_LOG_ERROR);
-            return false;
-        }
-        $exif = read_exif_data($this->_filename);
-
+
+
-            debug_add("EXIF information misses the orientation tag. Skipping.", MIDCOM_LOG_INFO);
-            return true;
-        }
-
+
+
-            debug_add("No rotation neccessary.");
-            return true;
@@ -276 +300 @@
-        $imagesize = getimagesize($this->_filename);
-        
-
+
+
+
-            /* jpegtran */
-
+
+
-                case 2: $rotate = "-flip horizontal"; break;
-                case 3: $rotate = "-rotate 180"; break;
@@ -294 +321 @@
-            $tmpfile = $this->_get_tempfile();
-            $do_unlink = true;
-
-
+
+
+
+
-            /* Mogrify */
-            debug_add("jpegtran not found, falling back to mogrify.");
-            
-
+
+
-                case 2: $rotate = "-flip"; break;
-                case 3: $rotate = "-rotate 180"; break;
@@ -313 +343 @@
-            }
-            
-
+{$GLOBALS['midcom_config']['utility_imagemagick_base']}
-                . escapeshellarg($this->_filename);
-        }
-        
-        exec($cmd, $output, $exit_code);
-
-
-
-
-
-
-
+
+
+
-            debug_add("ImageMagick/jpegtran failed to convert the image, see LOG_DEBUG for details.", MIDCOM_LOG_ERROR);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-            debug_add("Command was: {$cmd}");
-            if ($do_unlink)
@@ -402 +360 @@
-            return false;
-        }
+        
+        if ($do_unlink)
+        {
+            $this->_process_tempfile($tmpfile);
+        }
+        return true;
+    }
+    
+    /**
+     * Manual image rotation
+     * 
+     * Filter Syntax: rotate($rotate)
+     *
+     * Where $gamma is a positive floating point number greater then 0
+     * and less then 360; if omitted, a NULL operation is done.
+     *
+     * @param $rotate Degrees of rotation clockwise, negative amounts possible
+     * @returns true on success.
+     */
+    function rotate($rotate) {
+        // Do some normalizing on the argument
+        while ($rotate < 0)
+        {
+            $rotate += 360;
+        }
+        while ($rotate > 360)
+        {
+            $rotate -= 360;
+        }
+        if ($rotate == 0 || $rotate == 360)
+        {
+            debug_add("Rotate is {$rotate}, we're happy as-is.");
+            // We're happy as-is :)
+            return true; 
+        }
+        
+        $do_unlink = false;
+        $imagesize = getimagesize($this->_filename);
+        
+        // Try lossless jpegtran rotation if possible
+        if (   $imagesize[2] == 2 
+            && ($rotate == 90 || $rotate == 180 || $rotate == 270) 
+            && ! is_null($GLOBALS['midcom_config']['utility_jpegtran']))
+        {
+            $tmpfile = $this->_get_tempfile();
+            $do_unlink = true;
+            $cmd = "{$GLOBALS['midcom_config']['utility_jpegtran']} -copy all -rotate {$rotate} -outfile {$tmpfile} " . escapeshellarg($this->_filename);
+        } 
+        else 
+        {
+            /* Mogrify */
+            debug_add("jpegtran not found or rotation incompatible, falling back to mogrify.");
+            
+            $cmd = "{$GLOBALS['midcom_config']['utility_imagemagick_base']}mogrify {$this->_quality} -rotate {$rotate} " . escapeshellarg($this->_filename);
+        }
+        
+        debug_add("We have to rotate clockwise by {$rotate} degrees, do_unlink: {$do_unlink}");
+        exec($cmd, $output, $exit_code);
+        
+        if ($exit_code !== 0) 
+        {
+            debug_add("ImageMagick/jpegtran failed to convert the image, see LOG_DEBUG for details.", MIDCOM_LOG_ERROR);
+            debug_print_r("Imagemagick/jpegtran returned with {$exit_code} and produced this output:", $output);
+            debug_add("Command was: {$cmd}");
+            if ($do_unlink)
+            {
+                unlink($tmpfile);
+            }
+            return false;
+        }
+        
+        if ($do_unlink)
+        {
+            $this->_process_tempfile($tmpfile);
+        }
+        return true;
-    }
-