php-cimage/CImage.php

<?php
/**
 * Resize and crop images on the fly. Store generated images in a cache.
 *
 * @author Mikael Roos mos@dbwebb.se
 * @example http://mikaelroos.se/cimage/test.php
 * @link https://github.com/mosbth/cimage
 */
class CImage {

  /**
   * Properties
   */
  private $image = null; // Object for open image
  public $imageFolder; // root folder of images
  public $imageName; // image filename, may include subdirectory, relative from $imageFolder
  public $pathToImage; // $imageFolder . '/' . $imageName;
  private $fileExtension;
  public $newWidth;
  public $newHeight;
  private $cropWidth;
  private $cropHeight;
  public $keepRatio;
  public $cropToFit;
  public $crop;
  public $crop_x;
  public $crop_y;
  private $quality;
  public $filters;
  public $saveFolder;
  public $newName;
  private $newFileName;
  private $mime; // Calculated from source image
  private $width; // Calculated from source image
  private $height; // Calculated from source image
  private $type; // Calculated from source image
  private $attr; // Calculated from source image
  private $validExtensions = array('jpg', 'jpeg', 'png', 'gif');


  /**
   * Constructor, can take arguments to init the object.
   *
   * @param string $imageName filename which may contain subdirectory.
   * @param string $imageFolder path to root folder for images.
   * @param string $saveFolder path to folder where to save the new file or null to skip saving.
   * @param string $newName new filename or leave to null to autogenerate filename.
   */
  public function __construct($imageName=null, $imageFolder=null, $saveFolder=null, $newName=null) {
    $this->imageName = ltrim($imageName, '/');
    $this->imageFolder = rtrim($imageFolder, '/');
    $this->pathToImage = $this->imageFolder . '/' . $this->imageName;
    $this->fileExtension = pathinfo($this->pathToImage, PATHINFO_EXTENSION);
    $this->saveFolder = $saveFolder;
    $this->newName = $newName;
  }


  /**
   * Raise error, enables to implement a selection of error methods.
   *
   * @param $message string the error message to display.
   */
  public function RaiseError($message) {
    throw new Exception($message);
  }
  
  
  /**
   * Create filename to save file in cache.
   */
  public function CreateFilename() {
    $parts = pathinfo($this->pathToImage);
    $cropToFit = $this->cropToFit ? '_cf' : null;
    $crop_x = $this->crop_x ? "_x{$this->crop_x}" : null;
    $crop_y = $this->crop_y ? "_y{$this->crop_y}" : null;
    $quality = $this->quality == 100 ? null : "_q{$this->quality}";
    $crop = $this->crop ? '_c' . $this->crop['width'] . '-' . $this->crop['height'] . '-' . $this->crop['start_x'] . '-' . $this->crop['start_y'] : null;
    $filters = null;
    if(isset($this->filters)) {
      foreach($this->filters as $filter) {
        if(is_array($filter)) {
          $filters .= "_f{$filter['id']}";
          for($i=1;$i<=$filter['argc'];$i++) {
            $filters .= ":".$filter["arg{$i}"];
          }
        }
      }
    }
    $subdir = str_replace('/', '-', dirname($this->imageName));
    $subdir = ($subdir == '.') ? '_.' : $subdir;
    return $this->saveFolder . '/' . $subdir . '_' . $parts['filename'] . '_' . round($this->newWidth) . '_' . round($this->newHeight) . $crop . $cropToFit . $crop_x . $crop_y . $quality . $filters . '.' . $parts['extension'];
  }
  
  
  /**
   * Init and do some sanity checks before any processing is done. Throws exception if not valid.
   */
  public function Init() {
    is_null($this->newWidth) or is_numeric($this->newWidth) or $this->RaiseError('Width not numeric');
    is_null($this->newHeight) or is_numeric($this->newHeight) or $this->RaiseError('Height not numeric');
    is_numeric($this->quality) and $this->quality >= 0 and $this->quality <= 100 or $this->RaiseError('Quality not in range.');
    //is_numeric($this->crop_x) && is_numeric($this->crop_y) or $this->RaiseError('Quality not in range.');
    //filter
    is_readable($this->pathToImage) or $this->RaiseError('File does not exist.');
    in_array($this->fileExtension, $this->validExtensions) or $this->RaiseError('Not a valid file extension.');
    is_null($this->saveFolder) or is_writable($this->saveFolder) or $this->RaiseError('Save directory does not exist or is not writable.');

    // Get details on image
    $info = list($this->width, $this->height, $this->type, $this->attr) = getimagesize($this->pathToImage);
    !empty($info) or $this->RaiseError("The file doesn't seem to be an image.");
    $this->mime = $info['mime'];

    return $this;
  }
  

  /**
   * Output image using caching.
   *
   */
  protected function Output($file) {
    $time = filemtime($file);  
    if(isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) && strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) >= $time){  
      header("HTTP/1.0 304 Not Modified");
    } else {  
      header('Content-type: ' . $this->mime);  
      header('Last-Modified: ' . gmdate("D, d M Y H:i:s",$time) . " GMT");  
      readfile($file);
    }
    exit;
  }
 
 
  /**
   * Open image.
   *
   */
  protected function Open() {
    switch($this->fileExtension) {  
      case 'jpg':
      case 'jpeg': $this->image = @imagecreatefromjpeg($this->pathToImage); break;  
      case 'gif':  $this->image = @imagecreatefromgif($this->pathToImage); break;  
      case 'png':  $this->image = @imagecreatefrompng($this->pathToImage); break;  
      default: $this->image = false; $this->RaiseError('No support for this file extension.');
    }
    return $this;
  }
  
  
  /**
   * Map filter name to PHP filter and id.
   *
   * @param string $name the name of the filter.
   */
  private function MapFilter($name) {
    $map = array(
      'negate' => array('id'=>0, 'argc'=>0, 'type'=>IMG_FILTER_NEGATE),    
      'grayscale' => array('id'=>1, 'argc'=>0, 'type'=>IMG_FILTER_GRAYSCALE),
      'brightness' => array('id'=>2, 'argc'=>1, 'type'=>IMG_FILTER_BRIGHTNESS),
      'contrast' => array('id'=>3, 'argc'=>1, 'type'=>IMG_FILTER_CONTRAST),
      'colorize' => array('id'=>4, 'argc'=>4, 'type'=>IMG_FILTER_COLORIZE),
      'edgedetect' => array('id'=>5, 'argc'=>0, 'type'=>IMG_FILTER_EDGEDETECT),
      'emboss' => array('id'=>6, 'argc'=>0, 'type'=>IMG_FILTER_EMBOSS),
      'gaussian_blur' => array('id'=>7, 'argc'=>0, 'type'=>IMG_FILTER_GAUSSIAN_BLUR),
      'selective_blur' => array('id'=>8, 'argc'=>0, 'type'=>IMG_FILTER_SELECTIVE_BLUR),
      'mean_removal' => array('id'=>9, 'argc'=>0, 'type'=>IMG_FILTER_MEAN_REMOVAL),
      'smooth' => array('id'=>10, 'argc'=>1, 'type'=>IMG_FILTER_SMOOTH),
      'pixelate' => array('id'=>11, 'argc'=>2, 'type'=>IMG_FILTER_PIXELATE),
    );
    if(isset($map[$name]))
      return $map[$name];
    else {
      $this->RaiseError('No such filter.');
    }
  }
  
  
  /**
   * Calculate new width and height of image.
   */
  protected function CalculateNewWidthAndHeight() {
    // Crop, use cropped width and height as base for calulations
    $width  = $this->width;
    $height = $this->height;
    if($this->crop) {
      if(empty($this->crop['width'])) {
        $this->crop['width'] = $this->width - $this->crop['start_x'];
      }
      if(empty($this->crop['height'])) {
        $this->crop['height'] = $this->height - $this->crop['start_y'];
      }
      $width  = $this->crop['width'];
      $height = $this->crop['height'];
    }
  
    // Calculate new width and height if keeping aspect-ratio. 
    if($this->keepRatio) {
    
      // Crop-to-fit and both new width and height are set.
      if($this->cropToFit && isset($this->newWidth) && isset($this->newHeight)) {
        // Use newWidth and newHeigh as width/height, image should fit in box.
        ;
      } 
     
      // Both new width and height are set.
      elseif(isset($this->newWidth) && isset($this->newHeight)) {
        // Use newWidth and newHeigh as max width/height, image should not be larger.
        $ratioWidth  = $width  / $this->newWidth;
        $ratioHeight = $height / $this->newHeight;
        $ratio = ($ratioWidth > $ratioHeight) ? $ratioWidth : $ratioHeight;
        $this->newWidth  = round($width  / $ratio);
        $this->newHeight = round($height / $ratio);
      } 
     
      // Use new width as max-width
      elseif(isset($this->newWidth)) {
        $factor = (float)$this->newWidth / (float)$width;
        $this->newHeight = round($factor * $height);
      } 
    
      // Use new height as max-hight
      elseif(isset($this->newHeight)) {
        $factor = (float)$this->newHeight / (float)$height;
        $this->newWidth = round($factor * $width);
      }
      
      // Use newWidth and newHeigh as defined width/height, image should fit the area.
      if($this->cropToFit) {
        $ratioWidth  = $width  / $this->newWidth;
        $ratioHeight = $height / $this->newHeight;
        $ratio = ($ratioWidth < $ratioHeight) ? $ratioWidth : $ratioHeight;
        $this->cropWidth  = round($width  / $ratio);
        $this->cropHeight = round($height / $ratio);
      }      
    }
    
    // Crop, ensure to set new width and height
    if($this->crop) {
      $this->newWidth = round(isset($this->newWidth) ? $this->newWidth : $this->crop['width']);
      $this->newHeight = round(isset($this->newHeight) ? $this->newHeight : $this->crop['height']);    
    }

    // No new height or width is set, use existing measures.
    $this->newWidth  = round(isset($this->newWidth) ? $this->newWidth : $this->width);
    $this->newHeight = round(isset($this->newHeight) ? $this->newHeight : $this->height);   
    
    return $this;
  }
  
  
  /**
   * Resize the image and optionally store/cache the new imagefile. Output the image.
   *
   * @param integer $newWidth the new width or null. Default is null.
   * @param integer $newHeight the new width or null. Default is null.
   * @param boolean $keepRatio true to keep aspect ratio else false. Default is true.
   * @param boolean $cropToFit true to crop image to fit in box specified by $newWidth and $newHeight. Default is false.
   * @param integer $quality the quality to use when saving the file, range 0-100, default is full quality which is 100.
   * @param array/string $crop converts string of 1,2,3,4 to array 'width'=>1, 'height'=>2, 'start_x'=>3, 'start_y'=>4.
   * @param array $filter.
   */
  public function ResizeAndOutput($args) {
    $defaults = array(
      'newWidth'=>null,
      'newHeight'=>null,
      'keepRatio'=>true,
      'cropToFit'=>false,
      'quality'=>100,
      'crop'=>null, //array('width'=>null, 'height'=>null, 'start_x'=>0, 'start_y'=>0), 
      'filters'=>null,
    );
    
    // Convert crop settins from string to array
    if(isset($args['crop']) && !is_array($args['crop'])) {
      $pices = explode(',', $args['crop']);
      $args['crop'] = array(
        'width'   => $pices[0],
        'height'  => $pices[1],
        'start_x' => $pices[2],
        'start_y' => $pices[3],
      );
    }
    
    // Convert filter settins from array of string to array of array
    if(isset($args['filters']) && is_array($args['filters'])) {
      foreach($args['filters'] as $key => $filterStr) {
        $parts = explode(',', $filterStr);
        $filter = $this->MapFilter($parts[0]);
        $filter['str'] = $filterStr;
        for($i=1;$i<=$filter['argc'];$i++) {
          if(isset($parts[$i])) {
            $filter["arg{$i}"] = $parts[$i];
          } else {
            $this->RaiseError('Missing arg to filter, review how many arguments are needed at http://php.net/manual/en/function.imagefilter.php');           
          }
        }
        $args['filters'][$key] = $filter;
      }
    }
    //echo "<pre>" . print_r($args['filters'], true) . "</pre>";
    
    // Merge default arguments with incoming and set properties.
    //$args = array_merge_recursive($defaults, $args);
    $args = array_merge($defaults, $args);
    foreach($defaults as $key=>$val) {
      $this->{$key} = $args[$key];
    }
    //echo "<pre>" . print_r($this, true) . "</pre>";
    
    // Init the object and do sanity checks on arguments
    $this->Init()->CalculateNewWidthAndHeight();
    //echo "<pre>" . print_r($this, true) . "</pre>";

    // Use original image?
    if(is_null($this->newWidth) && is_null($this->newHeight)) {
      $this->Output($this->pathToImage);
    }
    
    // Check cache before resizing.
    $this->newFileName = $this->CreateFilename();
    if(is_readable($this->newFileName)) {
      $fileTime   = filemtime($this->pathToImage);
      $cacheTime  = filemtime($this->newFileName);
      if($fileTime <= $cacheTime) {
        $this->Output($this->newFileName);
      }
    }
    
    // Resize and output and save new to cache 
    $this->Open()->ResizeAndSave();
  }
  

  /**
   * Create a image and keep transparency for png and gifs.
   *
   * $param int $width of the new image.
   * @param int $height of the new image.
   * @returns image resource.
   */
  public function CreateImageKeepTransparency($width, $height) {
    //echo $width . "x" . $height . "<br>";
    $img = imagecreatetruecolor($width, $height);

/*
    if($this->fileExtension == 'png' || ($this->fileExtension == 'gif')) { 
      imagealphablending($img, false);
      imagesavealpha($img, true);
      $transparent = imagecolorallocatealpha($img, 255, 255, 255, 127);
      imagefilledrectangle($img, 0, 0, $width, $height, $transparent);
    }
*/
    return $img;
  }

  
  /**
   * Resize, crop and output the image.
   *
   */
  public function ResizeAndSave() {

    // Do as crop, take only part of image
    if($this->crop) {
      //echo "Cropping";
      $img = $this->CreateImageKeepTransparency($this->crop['width'], $this->crop['height']);
      imagecopyresampled($img, $this->image, 0, 0, $this->crop['start_x'], $this->crop['start_y'], $this->crop['width'], $this->crop['height'], $this->crop['width'], $this->crop['height']);
      $this->image = $img;
      $this->width = $this->crop['width'];
      $this->height = $this->crop['height'];
    } 
    
    // Resize by crop to fit
    if($this->cropToFit) {
      //echo "Crop to fit";
      $cropX = ($this->cropWidth/2) - ($this->newWidth/2);  
      $cropY = ($this->cropHeight/2) - ($this->newHeight/2);  
      $imgPreCrop   = $this->CreateImageKeepTransparency($this->cropWidth, $this->cropHeight);
      $imageResized = $this->CreateImageKeepTransparency($this->newWidth, $this->newHeight);
      imagecopyresampled($imgPreCrop, $this->image, 0, 0, 0, 0, $this->cropWidth, $this->cropHeight, $this->width, $this->height);
      imagecopyresampled($imageResized, $imgPreCrop, 0, 0, $cropX, $cropY, $this->newWidth, $this->newHeight, $this->newWidth, $this->newHeight);
    } 
    
    // as is
    else {
      $imageResized = $this->CreateImageKeepTransparency($this->newWidth, $this->newHeight);
      imagecopyresampled($imageResized, $this->image, 0, 0, 0, 0, $this->newWidth, $this->newHeight, $this->width, $this->height);
    }
    
    // Apply filters
    if(isset($this->filters) && is_array($this->filters)) {
      foreach($this->filters as $filter) {
        switch($filter['argc']) {
          case 0: imagefilter($imageResized, $filter['type']); break;
          case 1: imagefilter($imageResized, $filter['type'], $filter['arg1']); break;
          case 2: imagefilter($imageResized, $filter['type'], $filter['arg1'], $filter['arg2']); break;
          case 3: imagefilter($imageResized, $filter['type'], $filter['arg1'], $filter['arg2'], $filter['arg3']); break;
          case 4: imagefilter($imageResized, $filter['type'], $filter['arg1'], $filter['arg2'], $filter['arg3'], $filter['arg4']); break;
        }
      }
    }
    
    switch($this->fileExtension)  
    {  
      case 'jpg':  
      case 'jpeg':  
        if(imagetypes() & IMG_JPG) {
          if($this->saveFolder) {
            imagejpeg($imageResized, $this->newFileName, $this->quality);
          }
          $imgFunction = 'imagejpeg';
        }  
      break;  
  
      case 'gif':  
        if (imagetypes() & IMG_GIF) {  
          if($this->saveFolder) {
            imagegif($imageResized, $this->newFileName);  
          }
          $imgFunction = 'imagegif';
        }  
      break;  
    
      case 'png':  
        // Scale quality from 0-100 to 0-9 and invert setting as 0 is best, not 9  
        $quality = 9 - round(($this->quality/100) * 9);  
        if (imagetypes() & IMG_PNG) {  
          if($this->saveFolder) {
            imagepng($imageResized, $this->newFileName, $quality);  
          }
          $imgFunction = 'imagepng';
        }  
      break;  
      default:
        $this->RaiseError('No support for this file extension.');
      break;
    }  
    header('Content-type: ' . $this->mime);
    header('Last-Modified: ' . gmdate("D, d M Y H:i:s", time()) . " GMT");
    $imgFunction($imageResized);
    exit;
  }
  
  
}