20090115_gradient.phps

<?php

// NOTE--A newer version of this script can be found here:
//    http://www.vacant-nebula.com/files/for_blog/20100707_gradient.phps

/**
 * Programmatically generates a gradient image.
 * 
 * $_GET parameters:
 * top         The color at the top of the gradient.  Specified as a 6- or 8-digit
 *             hexadecimal string.  For horizontal gradients, this will be the 
 *             color on the left.  The two most-significant-digits specify the 7-bit
 *             alpha channel, from 00 (opaque) to 7f (transparent). 
 * bottom      The color at the bottom of the gradient.  Specified as a 6-or 8-digit
 *             hexadecimal string.  For horizontal gradients, this will be the
 *             color on the right.  The two most-significant-digits specify the 7-bit
 *             alpha channel, from 00 (opaque) to 7f (transparent).
 * height      The height of this gradient, in pixels.  For horizontal
 *             gradients, this will be the width.
 * orientation This should be 'h' for horizontal, 'v' for vertical.  Defaults
 *             'v' in the case of invalid input.
 * 
 * define'd constants:
 * CACHE_DIR      The directory in which generated gradients will be stored.
 *                This directory must have rwx privileges.
 * MAX_CACHE_SIZE The maximum disk space which will be used, in bytes, by the
 *                cache directory.
 * WIDTH          The width of the gradient.  For horizontal gradients, this
 *                will be the height.
 * MIN_HEIGHT     The minimum acceptable value for $_GET['height'].
 * MAX_HEIGHT     The maximum acceptable value for $_GET['height'].
 * 
 * @author Kip Robinson, http://www.vacant-nebula.com
 */

define('CACHE_DIR', $_SERVER['DOCUMENT_ROOT'] . '/../gradient_cache');
define('MAX_CACHE_SIZE', 5*1024*1024); //5 MB
define('WIDTH', 16);
define('MIN_HEIGHT', 10);
define('MAX_HEIGHT', 1000);

//Validate/sanitize $_GET parameters
//---------------------------------------------------------
$top = clamp(hexdec(strval($_GET['top'])), 0, 0x7fffffff);
$top_hex = str_pad(dechex(intval($top)), 8, '0', STR_PAD_LEFT);

$bottom = clamp(hexdec(strval($_GET['bottom'])), 0, 0x7fffffff);
$bottom_hex = str_pad(dechex(intval($bottom)), 8, '0', STR_PAD_LEFT);

$is_vertical = strval($_GET['orientation']) !== 'h';
$orientation = $is_vertical ? 'v' : 'h';

$height = clamp(intval($_GET['height']), MIN_HEIGHT, MAX_HEIGHT);

//If we haven't cached this gradient, generate it.
//---------------------------------------------------------
$file = CACHE_DIR . "/$top_hex-$bottom_hex-$height-$orientation.png";
if(!file_exists($file))
{
  clean_cache();
  
  if($is_vertical)
    $image = imagecreatetruecolor(WIDTH, $height);
  else
    $image = imagecreatetruecolor($height, WIDTH);
  
  $top_a = ($top >> 24) & 0x7f;
  $top_r = ($top >> 16) & 0xff;
  $top_g = ($top >>  8) & 0xff;
  $top_b = ($top      ) & 0xff;
  
  $bottom_a = ($bottom >> 24) & 0x7f;
  $bottom_r = ($bottom >> 16) & 0xff;
  $bottom_g = ($bottom >>  8) & 0xff;
  $bottom_b = ($bottom      ) & 0xff;
  
  //Allow us to save the alpha channel if either color is not opaque.
  if($top_a > 0 || $bottom_a > 0)
  {
    imagealphablending($image, false);
    imagesavealpha($image, true);
  }
  
  //Precompute the "slope" for the interpolation function.
  //Note: first row will always be $top color, and last
  //      row will always be $bottom color.
  $m_a = ($bottom_a - $top_a) / ($height - 1.0);
  $m_r = ($bottom_r - $top_r) / ($height - 1.0);
  $m_g = ($bottom_g - $top_g) / ($height - 1.0);
  $m_b = ($bottom_b - $top_b) / ($height - 1.0);
  
  for($row = 0; $row < $height; $row++)
  {
    $a = round($m_a * $row + $top_a);
    $r = round($m_r * $row + $top_r);
    $g = round($m_g * $row + $top_g);
    $b = round($m_b * $row + $top_b);
    $color = ($a << 24) | ($r << 16) | ($g << 8) | $b;
    
    for($col = 0; $col < WIDTH; $col++)
    {
      if($is_vertical)
        imagesetpixel($image, $col, $row, $color);
      else
        imagesetpixel($image, $row, $col, $color);
    }
  }
  
  //Write the image to the cache.
  imagepng($image, $file);
  imagedestroy($image);
}

//Update mtime (since LRU are cleared from cache first)
touch($file);


//Write headers to convince browser that this is an image
//and not a web page.  Use "Expires" header to let browser
//cache the image locally (it's not like it's going to change).
//---------------------------------------------------------
header('Content-type: image/png');
header('Content-Length: ' . filesize($file));
header('Pragma:'); //undo the pragma garbage PHP already wrote
header('Expires: ' . gmdate('r', mktime() + 3600*24*365));
header('Last-Modified: ' . gmdate('r', filectime($file)));

//Finally, output the file and we're done!
//---------------------------------------------------------
readfile($file);


//=========================================================
// HELPER FUNCTIONS
//=========================================================


/**
 * Limits $val to the range [$min..$max].
 */ 
function clamp($val, $min, $max)
{
  if ($min > $max)
    return clamp($val, $max, $min);
  else if ($val < $min)
    return $min;
  else if ($val > $max)
    return $max;
  else
    return $val;
}

/**
 * Cleans up the cache to limit the total size of all cached gradients
 * to MAX_CACHE_SIZE.  Least-recently-used files will be deleted first.
 * Requires execute permission on cache directory.
 */ 
function clean_cache()
{
  $tmp_files = scandir(CACHE_DIR);
  $files = array();
  foreach($tmp_files as $file)
  {
    $path = CACHE_DIR . "/$file";
    //ignore subdirectories if there are any..
    if (is_file($path))
      $files[] = $path;
  }
  unset($tmp_files);
  
  //sort newest to oldest
  usort($files, create_function('$a, $b', 'return filemtime($b)-filemtime($a);') );
  
  //Compute the size (storage space) of cached files, starting with most recent.  Once that
  //  size is over MAX_CACHE_SIZE, delete that file and any older files.
  $cache_size = 0;
  foreach($files as $file)
  {
    $cache_size += filesize($file);
    if ($cache_size > MAX_CACHE_SIZE)
      @unlink($file);
  }
}