Enable to set JPEG image as interlaced, implement feature #177.

CImage.php

@@ -423,6 +423,13 @@ class CImage
 
 
 
+    /*
+     * Use interlaced progressive mode for JPEG images.
+     */
+    private $interlace = false;
+
+
+
     /*
      * Image copy strategy, defaults to RESAMPLE.
      */
@@ -838,6 +845,7 @@ class CImage
             'blur'        => null,
             'convolve'       => null,
             'rotateAfter' => null,
+            'interlace' => null,
 
             // Output format
             'outputFormat' => null,
@@ -1183,7 +1191,7 @@ class CImage
                 $this->newWidth = $width;
                 $this->newHeight = $height;
             }
-            
+
 
             // Get image dimensions for pre-resize image.
             if ($this->cropToFit || $this->fillToFit) {
@@ -1402,6 +1410,7 @@ class CImage
         $rotateBefore = $this->rotateBefore ? "_rb{$this->rotateBefore}" : null;
         $rotateAfter  = $this->rotateAfter  ? "_ra{$this->rotateAfter}"  : null;
         $lossy        = $this->lossy        ? "_l"                       : null;
+        $interlace    = $this->interlace    ? "_i"                       : null;
 
         $saveAs = $this->normalizeFileExtension();
         $saveAs = $saveAs ? "_$saveAs" : null;
@@ -1468,7 +1477,7 @@ class CImage
             . $quality . $filters . $sharpen . $emboss . $blur . $palette
             . $optimize . $compress
             . $scale . $rotateBefore . $rotateAfter . $autoRotate . $bgColor
-            . $convolve . $copyStrat . $lossy . $saveAs;
+            . $convolve . $copyStrat . $lossy . $interlace . $saveAs;
 
         return $this->setTarget($file, $base);
     }
@@ -1788,7 +1797,7 @@ class CImage
             // Resize by crop to fit
             $this->log("Resizing using strategy - Crop to fit");
 
-            if (!$this->upscale 
+            if (!$this->upscale
                 && ($this->width < $this->newWidth || $this->height < $this->newHeight)) {
                 $this->log("Resizing - smaller image, do not upscale.");
 
@@ -2367,7 +2376,7 @@ class CImage
             $this->jpegOptimizeCmd = null;
         }
 
-        if (array_key_exists("png_lossy", $options) 
+        if (array_key_exists("png_lossy", $options)
             && $options['png_lossy'] !== false) {
             $this->pngLossy = $options['png_lossy'];
             $this->pngLossyCmd = $options['png_lossy_cmd'];
@@ -2440,6 +2449,12 @@ class CImage
 
             case 'jpeg':
             case 'jpg':
+                // Set as interlaced progressive JPEG
+                if ($this->interlace) {
+                    $this->Log("Set JPEG image to be interlaced.");
+                    $res = imageinterlace($this->image, true);
+                }
+
                 $this->Log("Saving image as JPEG to cache using quality = {$this->quality}.");
                 imagejpeg($this->image, $this->cacheFileName, $this->quality);
 

REVISION.md

@@ -5,10 +5,19 @@ Revision history
 [![Build Status](https://scrutinizer-ci.com/g/mosbth/cimage/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mosbth/cimage/build-status/master)
 
 
+v0.8.0 (2020-06-08)
+-------------------------------------
+
+* Enable to set JPEG image as interlaced, implement feature #177.
+* Add function getValue() to read from querystring.
+* Set PHP 7.0 as precondition (to prepare to update the codebase).
+
+
+
 v0.7.23 (2020-05-06)
 -------------------------------------
 
-* Fix error in composer.json 
+* Fix error in composer.json
 
 
 

webroot/img.php

@@ -285,7 +285,7 @@ $allowRemote = getConfig('remote_allow', false);
 
 if ($allowRemote && $passwordMatch !== false) {
     $cacheRemote = $cache->getPathToSubdir("remote");
-    
+
     $pattern = getConfig('remote_pattern', null);
     $img->setRemoteDownload($allowRemote, $cacheRemote, $pattern);
 
@@ -381,7 +381,7 @@ if ($dummyEnabled && $srcImage === $dummyFilename) {
                 matching file exists on the filesystem.',
                 404
             );
-    } 
+    }
 }
 
 if ($imagePathConstraint && !$dummyImage && !$remoteSource) {
@@ -920,6 +920,18 @@ if ($cacheControl) {
 
 
 
+/**
+ * interlace - Enable configuration for interlaced progressive JPEG images.
+ */
+$interlaceConfig  = getConfig('interlace', null);
+$interlaceValue   = getValue('interlace', null);
+$interlaceDefined = getDefined('interlace', true, null);
+$interlace = $interlaceValue ?? $interlaceDefined ?? $interlaceConfig;
+verbose("interlace (configfile) = ", $interlaceConfig);
+verbose("interlace = ", $interlace);
+
+
+
 /**
  * Prepare a dummy image and use it as source image.
  */
@@ -1081,6 +1093,7 @@ if (is_callable($hookBeforeCImage)) {
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,
@@ -1169,6 +1182,7 @@ $img->log("Incoming arguments: " . print_r(verbose(), 1))
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,

webroot/img_config.php

@@ -485,6 +485,17 @@ return array(
             "scale" => 14,
             "luminanceStrategy" => 3,
             "customCharacterSet" => null,
-        );
+        ), */
-    },*/
+
+
+
+    /**
+     * Default options using interlaced progressive JPEG images. Set to true to
+     * always render jpeg images as interlaced. This setting can be overridden
+     * by using `?interlace=true` or `?interlace=false`.
+     *
+     * Default values are:
+     *  interlace:  false
+     */
+     /*'interlace' => false,*/
 );

webroot/imgd.php

@@ -158,6 +158,25 @@ function getDefined($key, $defined, $undefined)
 
 
 
+/**
+ * Get value of input from query string or else $undefined.
+ *
+ * @param mixed $key       as string or array of string values to look for in $_GET.
+ * @param mixed $undefined value to return when $key has no, or empty value in $_GET.
+ *
+ * @return mixed value as or $undefined.
+ */
+function getValue($key, $undefined)
+{
+    $val = get($key);
+    if (is_null($val) || $val === "") {
+        return $undefined;
+    }
+    return $val;
+}
+
+
+
 /**
  * Get value from config array or default if key is not set in config array.
  *
@@ -183,7 +202,7 @@ function getConfig($key, $default)
  *
  * @return void or array.
  */
-function verbose($msg = null)
+function verbose($msg = null, $arg = "")
 {
     global $verbose, $verboseFile;
     static $log = array();
@@ -196,7 +215,15 @@ function verbose($msg = null)
         return $log;
     }
 
-    $log[] = $msg;
+    if (is_null($arg)) {
+        $arg = "null";
+    } elseif ($arg === false) {
+        $arg = "false";
+    } elseif ($arg === true) {
+        $arg = "true";
+    }
+
+    $log[] = $msg . $arg;
 }
 
 
@@ -1533,6 +1560,13 @@ class CImage
 
 
 
+    /*
+     * Use interlaced progressive mode for JPEG images.
+     */
+    private $interlace = false;
+
+
+
     /*
      * Image copy strategy, defaults to RESAMPLE.
      */
@@ -1948,6 +1982,7 @@ class CImage
             'blur'        => null,
             'convolve'       => null,
             'rotateAfter' => null,
+            'interlace' => null,
 
             // Output format
             'outputFormat' => null,
@@ -2293,7 +2328,7 @@ class CImage
                 $this->newWidth = $width;
                 $this->newHeight = $height;
             }
-            
+
 
             // Get image dimensions for pre-resize image.
             if ($this->cropToFit || $this->fillToFit) {
@@ -2512,6 +2547,7 @@ class CImage
         $rotateBefore = $this->rotateBefore ? "_rb{$this->rotateBefore}" : null;
         $rotateAfter  = $this->rotateAfter  ? "_ra{$this->rotateAfter}"  : null;
         $lossy        = $this->lossy        ? "_l"                       : null;
+        $interlace    = $this->interlace    ? "_i"                       : null;
 
         $saveAs = $this->normalizeFileExtension();
         $saveAs = $saveAs ? "_$saveAs" : null;
@@ -2578,7 +2614,7 @@ class CImage
             . $quality . $filters . $sharpen . $emboss . $blur . $palette
             . $optimize . $compress
             . $scale . $rotateBefore . $rotateAfter . $autoRotate . $bgColor
-            . $convolve . $copyStrat . $lossy . $saveAs;
+            . $convolve . $copyStrat . $lossy . $interlace . $saveAs;
 
         return $this->setTarget($file, $base);
     }
@@ -2898,7 +2934,7 @@ class CImage
             // Resize by crop to fit
             $this->log("Resizing using strategy - Crop to fit");
 
-            if (!$this->upscale 
+            if (!$this->upscale
                 && ($this->width < $this->newWidth || $this->height < $this->newHeight)) {
                 $this->log("Resizing - smaller image, do not upscale.");
 
@@ -3477,7 +3513,7 @@ class CImage
             $this->jpegOptimizeCmd = null;
         }
 
-        if (array_key_exists("png_lossy", $options) 
+        if (array_key_exists("png_lossy", $options)
             && $options['png_lossy'] !== false) {
             $this->pngLossy = $options['png_lossy'];
             $this->pngLossyCmd = $options['png_lossy_cmd'];
@@ -3550,6 +3586,12 @@ class CImage
 
             case 'jpeg':
             case 'jpg':
+                // Set as interlaced progressive JPEG
+                if ($this->interlace) {
+                    $this->Log("Set JPEG image to be interlaced.");
+                    $res = imageinterlace($this->image, true);
+                }
+
                 $this->Log("Saving image as JPEG to cache using quality = {$this->quality}.");
                 imagejpeg($this->image, $this->cacheFileName, $this->quality);
 
@@ -4681,7 +4723,7 @@ $allowRemote = getConfig('remote_allow', false);
 
 if ($allowRemote && $passwordMatch !== false) {
     $cacheRemote = $cache->getPathToSubdir("remote");
-    
+
     $pattern = getConfig('remote_pattern', null);
     $img->setRemoteDownload($allowRemote, $cacheRemote, $pattern);
 
@@ -4777,7 +4819,7 @@ if ($dummyEnabled && $srcImage === $dummyFilename) {
                 matching file exists on the filesystem.',
                 404
             );
-    } 
+    }
 }
 
 if ($imagePathConstraint && !$dummyImage && !$remoteSource) {
@@ -5316,6 +5358,18 @@ if ($cacheControl) {
 
 
 
+/**
+ * interlace - Enable configuration for interlaced progressive JPEG images.
+ */
+$interlaceConfig  = getConfig('interlace', null);
+$interlaceValue   = getValue('interlace', null);
+$interlaceDefined = getDefined('interlace', true, null);
+$interlace = $interlaceValue ?? $interlaceDefined ?? $interlaceConfig;
+verbose("interlace (configfile) = ", $interlaceConfig);
+verbose("interlace = ", $interlace);
+
+
+
 /**
  * Prepare a dummy image and use it as source image.
  */
@@ -5477,6 +5531,7 @@ if (is_callable($hookBeforeCImage)) {
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,
@@ -5565,6 +5620,7 @@ $img->log("Incoming arguments: " . print_r(verbose(), 1))
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,

webroot/imgp.php

@@ -158,6 +158,25 @@ function getDefined($key, $defined, $undefined)
 
 
 
+/**
+ * Get value of input from query string or else $undefined.
+ *
+ * @param mixed $key       as string or array of string values to look for in $_GET.
+ * @param mixed $undefined value to return when $key has no, or empty value in $_GET.
+ *
+ * @return mixed value as or $undefined.
+ */
+function getValue($key, $undefined)
+{
+    $val = get($key);
+    if (is_null($val) || $val === "") {
+        return $undefined;
+    }
+    return $val;
+}
+
+
+
 /**
  * Get value from config array or default if key is not set in config array.
  *
@@ -183,7 +202,7 @@ function getConfig($key, $default)
  *
  * @return void or array.
  */
-function verbose($msg = null)
+function verbose($msg = null, $arg = "")
 {
     global $verbose, $verboseFile;
     static $log = array();
@@ -196,7 +215,15 @@ function verbose($msg = null)
         return $log;
     }
 
-    $log[] = $msg;
+    if (is_null($arg)) {
+        $arg = "null";
+    } elseif ($arg === false) {
+        $arg = "false";
+    } elseif ($arg === true) {
+        $arg = "true";
+    }
+
+    $log[] = $msg . $arg;
 }
 
 
@@ -1533,6 +1560,13 @@ class CImage
 
 
 
+    /*
+     * Use interlaced progressive mode for JPEG images.
+     */
+    private $interlace = false;
+
+
+
     /*
      * Image copy strategy, defaults to RESAMPLE.
      */
@@ -1948,6 +1982,7 @@ class CImage
             'blur'        => null,
             'convolve'       => null,
             'rotateAfter' => null,
+            'interlace' => null,
 
             // Output format
             'outputFormat' => null,
@@ -2293,7 +2328,7 @@ class CImage
                 $this->newWidth = $width;
                 $this->newHeight = $height;
             }
-            
+
 
             // Get image dimensions for pre-resize image.
             if ($this->cropToFit || $this->fillToFit) {
@@ -2512,6 +2547,7 @@ class CImage
         $rotateBefore = $this->rotateBefore ? "_rb{$this->rotateBefore}" : null;
         $rotateAfter  = $this->rotateAfter  ? "_ra{$this->rotateAfter}"  : null;
         $lossy        = $this->lossy        ? "_l"                       : null;
+        $interlace    = $this->interlace    ? "_i"                       : null;
 
         $saveAs = $this->normalizeFileExtension();
         $saveAs = $saveAs ? "_$saveAs" : null;
@@ -2578,7 +2614,7 @@ class CImage
             . $quality . $filters . $sharpen . $emboss . $blur . $palette
             . $optimize . $compress
             . $scale . $rotateBefore . $rotateAfter . $autoRotate . $bgColor
-            . $convolve . $copyStrat . $lossy . $saveAs;
+            . $convolve . $copyStrat . $lossy . $interlace . $saveAs;
 
         return $this->setTarget($file, $base);
     }
@@ -2898,7 +2934,7 @@ class CImage
             // Resize by crop to fit
             $this->log("Resizing using strategy - Crop to fit");
 
-            if (!$this->upscale 
+            if (!$this->upscale
                 && ($this->width < $this->newWidth || $this->height < $this->newHeight)) {
                 $this->log("Resizing - smaller image, do not upscale.");
 
@@ -3477,7 +3513,7 @@ class CImage
             $this->jpegOptimizeCmd = null;
         }
 
-        if (array_key_exists("png_lossy", $options) 
+        if (array_key_exists("png_lossy", $options)
             && $options['png_lossy'] !== false) {
             $this->pngLossy = $options['png_lossy'];
             $this->pngLossyCmd = $options['png_lossy_cmd'];
@@ -3550,6 +3586,12 @@ class CImage
 
             case 'jpeg':
             case 'jpg':
+                // Set as interlaced progressive JPEG
+                if ($this->interlace) {
+                    $this->Log("Set JPEG image to be interlaced.");
+                    $res = imageinterlace($this->image, true);
+                }
+
                 $this->Log("Saving image as JPEG to cache using quality = {$this->quality}.");
                 imagejpeg($this->image, $this->cacheFileName, $this->quality);
 
@@ -4681,7 +4723,7 @@ $allowRemote = getConfig('remote_allow', false);
 
 if ($allowRemote && $passwordMatch !== false) {
     $cacheRemote = $cache->getPathToSubdir("remote");
-    
+
     $pattern = getConfig('remote_pattern', null);
     $img->setRemoteDownload($allowRemote, $cacheRemote, $pattern);
 
@@ -4777,7 +4819,7 @@ if ($dummyEnabled && $srcImage === $dummyFilename) {
                 matching file exists on the filesystem.',
                 404
             );
-    } 
+    }
 }
 
 if ($imagePathConstraint && !$dummyImage && !$remoteSource) {
@@ -5316,6 +5358,18 @@ if ($cacheControl) {
 
 
 
+/**
+ * interlace - Enable configuration for interlaced progressive JPEG images.
+ */
+$interlaceConfig  = getConfig('interlace', null);
+$interlaceValue   = getValue('interlace', null);
+$interlaceDefined = getDefined('interlace', true, null);
+$interlace = $interlaceValue ?? $interlaceDefined ?? $interlaceConfig;
+verbose("interlace (configfile) = ", $interlaceConfig);
+verbose("interlace = ", $interlace);
+
+
+
 /**
  * Prepare a dummy image and use it as source image.
  */
@@ -5477,6 +5531,7 @@ if (is_callable($hookBeforeCImage)) {
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,
@@ -5565,6 +5620,7 @@ $img->log("Incoming arguments: " . print_r(verbose(), 1))
             'blur'      => $blur,
             'convolve'  => $convolve,
             'rotateAfter' => $rotateAfter,
+            'interlace' => $interlace,
 
             // Output format
             'outputFormat' => $outputFormat,