<?php

//  Pimp (PHP Image Pre-Processor)
    $VERSION = '0.30';
/*  Author: Dave Gough (dave at megapoo dot com)
 
    What does it do?
    ----------------

    Reads a directory of .jpg photos (at aspect ratio 1:1.333 recurring), rescales them to "full size" and "thumb size", places them in directories: thumbs and fulls. Then it creates the gallery html for the thumbs.

    What does it need?
    ------------------

    * Requires Apache/PHP installed.
    * Requires PHP module gd 2.0 or higher (with JPG support) compiled in.
    * Requires Imagemagick installed.
    * Permissions setting on the directory; see below.

     Uploading images to the server
     ------------------------------

     Files can be batch resized before uploading using:

     mogrify -resize 412x550! *.jpg
     
     Where 412 is the width and 550 the height. Batch sizing them like this only works if they are are all the same orientation i.e. All landscape, or all portrait.
     
     Mogrify is part of the imagemagick package.
     
     Resizing prior to uploading is not nescessary but reduces upload time and server storage space.

     Permissions
     -----------

     Permissions needed setting (as root) on the directory of images

     chown spacepleb portrait/               
     chgrp www-data portrait/
     chmod ug+rwx portrait/
         
     Development notes
     -----------------

     * Presently set up to use an aspect ratio of 1:1.333 recurring.     
     * Needs to recalculate the image size with compression.
     * Need to detect no files and bow out gracefully.
     * Some sort of fixed width for spare cells.
     * It does not currently remove the original unscaled images.
     * If watermarking is important then originals lying around is a problem
     * Choosing thumbnail size and quantity across the page needs careful thought to avoid horizontal scrolling.

     History
     -------
     
     0.23
     Added JPG compression quality. Set to 40%.
     
     0.23.1 - 25 Oct 04
     Improved notes

     0.24 - 25 Oct 04
     Branched into caching in html.

     0.25 - 26 Oct
     Now produces multiple cached gallery pages.

     0.25.3 - 27 Oct
     Stopped index page redirecting to a lack of page
     
     0.25.4 - 27 Oct
     Corrected spare row on non full galleries.

     0.25.5 - 9 Nov 04
     Pulled out separate style declarations

     0.25.6 - 8 Dec 04
     Added time and date on which page generated

     0.25.7 - 15 Dec
     Made page title optional on page
     Made selected page larger on gallery index
     Added a global URL to find PIMP

     0.25.8 - 15 Dec
     Moved next and previous around page numbering
    
     0.25.9 - 16 Dec
     Added link separator character

     0.26 - 16 Dec 
     Validated and added optional XHMTL logo

     0.27 - 31 Jan 05
     Corrected missing leading zeroes in gallery generation time

     0.28 - 2 Feb 05
     Hardened the file handling to avoid errors when using directory names with spaces in. Improved the .jpg searching using regular expressions

     0.29 - 8 Feb 05
     Added the controversial ?command=clear parameter which wipes all the unnescessary files from the directory ready to start again. Defaults to switched off. 

     0.30
     Document Root now fetched using $_SERVER['DOCUMENT_ROOT'] (made by mash at psandgravy dot com)

BUG - Fails on adding fourth image, the structure by which it checks files / lays table out need looking at.

Needs:
To remove the unused cells, or force them to the right size, maybe false image, or single pixel?

Needs to maintain aspect ratio for values other than 1.33333?
Maybe it should test for the aspect ratio and maintain that?

Needs to scan the file time stamp also, so that it can lay up an index page of the last x images uploaded.

IDEAS....

Here's how it goes. The User does not run pimp. It gets called pimp.php, and can be called by anyone who updates, or anyone really. Then it creates gallery indexs, you can have index.html to be a menu, the latest gallery, or even the last x photos uploaded. It would be good to get it to run every ten minutes or so...  Maybe the user calls pimp which checks when it last ran, and runs itself if it was more than x minutes ago? 

Then you could have nameable galleries which don't change so that links become permanent as long as the gallery is hosted.

Look at reading the time stamps of the files written (images and html).


*/

// ----------------------------------------------------------------------

// START USER CONFIGURATION

// -----------------------------------------------------     
// Setup directory config
// -----------------------------------------------------

$dir_path = dirname($_SERVER['PHP_SELF']).'/';

//Set this if is running from a different directory
//$dir_path = '/images/photos/portrait/'; //For example

$dir = $_SERVER['DOCUMENT_ROOT'] . $dir_path;

$dir_thumbs = $dir.'thumbs/';
$dir_fulls = $dir.'fulls/';

$CAN_DELETE = false;  //Switch to true if you want to be able to run with the parameter ?command=clear 
                      //Use with caution on a public server. Anyone could wipe your images.

// -----------------------------------------------------
// Setup image configs
// -----------------------------------------------------

// These sizes will swap height / width to suit landscape / portrait

$fulls_portrait->width = 465; //Sizes for larger photos
$fulls_portrait->height = 620; 

$thumbs_portrait->width = 150; //Sizes for thumb photos
$thumbs_portrait->height = 200;

$sWATERMARK = "";   //Watermark string to be stamped on the larger images
                    //  set to "" for no watermark.

$iJPEG_QUALITY = 74;     //jpg compression quality 1% to 100%.
                         //  40% seems fine for web. 100% is good, 1% bad.

// -------------------------------------------------------
// Setup page content / layout
// -------------------------------------------------------


$sPAGE_TITLE = 'PIMP Gallery. 2005';  //Page title in browser title bar

$isPAGE_TITLE = 0;   //Whether the page title is to be laid up at the top of the page HTML also.

$sSEPARATOR = '.'; //Non alphanumeric character to separate links. Do NOT use a single quote (')

$iCOLUMNS = 3;   //How many photo thumbs you want across the gallery page.
$iROWS = 3;      //How many rows of photo thumbs you want down each page.

$sCOPYRIGHT = 'PIMP : 2005';
$sAUTHORS = "Dave Gough";

$isXHTML_LOGO = 0; //Whether to display Valid XHTML! logo  

// ------------------------------------------------------
// Setup styles for gallery pages
// -------------------------------------------------------

// Style applied to each gallery page

$sStyle = '
<style type="text/css">
//
	body{		background-color:#eeeeee}
	img{		border:1px solid black}
	td.image{	padding:1em;border:1px solid black;
	                text-align:center;}
        h1{             font-size:120%;}
        span.here{      color:red;font-size:130%;}
//
</style>
'."\n";

// Style applied to Index page - gallery menu

$sStyle_index = '
<style type="text/css">
//
	body{		background-color:#eeeeee}
	img{		border:1px solid black}
	td.image{	padding:1em;border:1px solid black;
	                text-align:center;}
        h1{             font-size:120%;}
        span.here{      color:red;font-size:130%;}
//
</style>

'."\n";

// --------------------------------------------------------
// Setup output / caching configs
// --------------------------------------------------------

$isDEBUG = false; // Switch this to true to get loads of verbal ;-)
$isREDIRECT = false; // Redirects the index.html page to the latest gallery

$sURL_PIMP = 'http://www.computertorture.com/pimp/';

//---------------------------------------------------------
//
// END USER CONFIGURATION
//
//---------------------------------------------------------


// --------------------------------------------------------
// Pre-process images
// --------------------------------------------------------

if (isset($command)){
  if ($command="clear"){
    if ($CAN_DELETE){
  system ('rm -r "'.$dir_thumbs.'" "'.$dir_fulls.'" *JPG *jpg *html');
  echo '<html><head><title>Cleared directory</title></head><body><p>Cleared directory.</p></body></html>';
  exit;
    }else{
      echo '<html><head><title>Authorisation failure</title></head><body><p>You do not have permission to run the ?command=clear parameter.</p><p>If your are admin you need to set $CAN_DELETE=true in the config at the top of index.php.</p><p>This causes a security issue if running on a public server (anyone could delete your images).</p></body></html>';
  exit;
    }
  }
}

$sSEPARATOR = htmlentities($sSEPARATOR);

function read_directory($dir_path){
  //     Reads all the .jpg files in a directory to an array
  global $isDEBUG;
  $files = array();
  $count = 0;
  $directory = opendir($dir_path);
  
  while ($file = readdir($directory)){
    if (preg_match("/\.jpg$/i",$file)){
      $files[$count]->name = $file;   
      $files[$count]->size = image_size_kb($dir_path.$files[$count]->name);
      $sizes = image_size_xy($dir_path.$files[$count]->name);
      $files[$count]->width = $sizes["width"];
      $files[$count]->height = $sizes["height"];
      $files[$count]->geometry = 'square';
      if ($sizes["width"] > $sizes["height"]){
	$files[$count]->geometry = 'landscape';
      }
      if ($sizes["width"] < $sizes["height"]){
	$files[$count]->geometry = 'portrait';
      }
      
      if ($isDEBUG){
	echo $files[$count]->name.' ';
	echo $files[$count]->width.'w x '.$files[$count]->height.'h ('.$files[$count]->geometry.') ';
	echo $files[$count]->size.'<acronym title="Kilobytes">Kb</acronym><br />';
      }
      $count++;
    }
  }
  closedir($directory);
  return $files;
}

function image_size_kb($sFile){
  //     Reads file size of image
  
  clearstatcache();
  return floor(filesize($sFile) / 1000);
}

function image_size_xy($sFile){
  $img = ImageCreateFromJPEG($sFile);
  $info["width"] = ImageSx($img);
  $info["height"] = ImageSy($img);
  ImageDestroy($img);
  return $info;
}

  
$files = read_directory($dir);

if(!is_dir($dir_thumbs)){
  if (!mkdir ($dir_thumbs)){
    echo 'Could not create directory '.$dir_thumbs;
    exit();
  }
  $dir_thumbs = $dir.'thumbs/';
}
  
if(!is_dir($dir_fulls)){
  if (!mkdir ($dir_fulls)){
    echo 'Could not create directory '.$dir_fulls;
    exit();
  }
}
  
foreach ($files as $image){
	echo 'The file we have is ' . $image->name;
  if (!file_exists($dir_thumbs.$image->name))
{
	echo 'Copying file.';
    system ('cp "'.$dir.$image->name.'" "'.$dir_thumbs.$image->name . '"');
    if ($image->geometry == 'portrait'){
      system ('mogrify -resize '.$thumbs_portrait->width.'x'.$thumbs_portrait->height.'! -quality '.$iJPEG_QUALITY.' "'.$dir_thumbs.$image->name .'"');
      if ($isDEBUG){echo 'Portrait: mogrify -resize '.$thumbs_portrait->width.'x'.$thumbs_portrait->height.'! -quality '.$iJPEG_QUALITY.' "'.$dir_thumbs.$image->name.'"<br />';}
    }else{
      system ('mogrify -resize '.$thumbs_portrait->height.'x'.$thumbs_portrait->width.'! -quality '.$iJPEG_QUALITY.' "'.$dir_thumbs.$image->name . '"');
      if ($isDEBUG){echo 'Landscape: mogrify -resize '.$thumbs_portrait->height.'x'.$thumbs_portrait->width.'! -quality '.$iJPEG_QUALITY.' "'.$dir_thumbs.$image->name.'"<br />';}
    }
  }
  if (!file_exists($dir_fulls.$image->name)){
    system ('cp "'.$dir.$image->name.'" "'.$dir_fulls.$image->name . '"');
    if ($image->geometry == 'portrait'){
      system ('mogrify -resize '.$fulls_portrait->width.'x'.$fulls_portrait->height.'! -quality '.$iJPEG_QUALITY.' "'.$dir_fulls.$image->name . '"');
      if ($isDEBUG){echo 'Portrait: mogrify -resize '.$fulls_portrait->width.'x'.$fulls_portrait->height.'! -quality '.$iJPEG_QUALITY.' "'.$dir_fulls.$image->name.'"<br />';}
    }else{
      system ('mogrify -resize '.$fulls_portrait->height.'x'.$fulls_portrait->width.'! -quality '.$iJPEG_QUALITY.' "'.$dir_fulls.$image->name .'"');
      if ($isDEBUG){echo'Lanscape: mogrify -resize '.$fulls_portrait->height.'x'.$fulls_portrait->width.'! -quality '.$iJPEG_QUALITY.' "'.$dir_fulls.$image->name.'"<br />';}
    }
      
    if(isset($sWATERMARK) && $sWATERMARK!=""){
	
      //   Add watermark to larger images if set
	
      $img = ImageCreateFromJPEG($dir_fulls.$image->name);
      $black = ImageColorAllocate($img,0,0,0);
      $white = ImageColorAllocate($img,0xFF,0xFF,0xFF);
      ImageTTFText($img, 26, 0, 20, 40, $black, '/usr/share/enlightenment/E-docs/aircut3.ttf', $sWATERMARK);
      ImageJPEG($img , $dir_fulls.$image->name);
      ImageDestroy($img);
    } 
  }  
}


$iImages_per_page = $iCOLUMNS * $iROWS;
$iPages = ceil(count($files)/$iImages_per_page);

if ($isDEBUG){
  echo 'Number of files: ' . count($files);
  echo ' Number of images per page: '.$iImages_per_page;
  echo ' Number of pages: '.$iPages;
}

$iCell = 0;

for ($iPage = 1; $iPage < $iPages+1; $iPage ++){ 

  // ----------------------------------------------------
  // Output the HTML for each gallery page
  // ----------------------------------------------------

  $sOut = '';

  $sOut .= '<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'."\n";
  
  $sOut .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en">'."\n";

  if ($sCOPYRIGHT != ''){
    $sOut .= '<!-- Copyright '.$sCOPYRIGHT.' -->'."\n";
  }

  $sOut .= "\n".'<head>'."\n";

  $sOut .= '<title>'.$sPAGE_TITLE;

  if ($iPages > 1){$sOut .= ' '.$sSEPARATOR.' Page '.$iPage;}

  $sOut .= '</title>'."\n";

  if ($sAUTHORS != ""){
    $sOut .= '<meta name="author" content="'.$sAUTHORS.'" />'."\n";
  }

  if ($sCOPYRIGHT != ''){
    $sOut .= '<meta name="copyright" content="'.$sCOPYRIGHT.'" />'."\n";
  }

  $sOut .= '<meta name="description" content="PHP Image Preprocessor, automatic photo journalism tool." />'."\n";
  $sOut .= '<meta name="generator" content="Pimp '.$VERSION.'. Automatic photo journalism tool. '.$sURL_PIMP.'" />'."\n";

  $sOut .= $sStyle;
  
  $sOut .= '</head>'."\n";
  $sOut .= "\n".'<body>'."\n";

  if ($isPAGE_TITLE == 1){
    $sOut .= '<h1>'.$sPAGE_TITLE;
    if ($iPages > 1){$sOut .= ' '.$sSEPARATOR.' Page '.$iPage;}
    $sOut .= '</h1>'."\n";
  }

  // Lay up page navigation, if nescessary.
  
  if ($iPages > 1){
    $sOut .= '<p>';
    if ($iPage > 1){
      $sOut .= '<a title="View previous gallery page." href="index'.($iPage-1).'.html">&lt;</a> <a title="View previous gallery page." href="index'.($iPage-1).'.html">Previous</a> '.$sSEPARATOR.' ';
    }  
    for ($c = 1; $c < $iPages+1; $c++){
      if ( $c != $iPage){
	$sOut .= '<a title="View gallery page '.$c.'" href="index'.$c.'.html">'.$c.'</a>';
      }else{
	$sOut .= '<span class="here">'.$c.'</span>';
      }
      if ($c != $iPages){$sOut .= ' '.$sSEPARATOR.' ';}
    }

    if ($iPage < $iPages){
      $sOut .= ' '.$sSEPARATOR.' <a title="View next gallery page." href="index'.($iPage+1).'.html">Next</a> <a title="View next gallery page." href="index'.($iPage+1).'.html">&gt;</a>';
    }

    // $sOut .= '<br />'."\n";

    //   if ($iPage > 1){
    //   $sOut .= '&lt; <a title="View previous gallery page." href="index'.($iPage-1).'.html">Previous</a>';
    // }
    //if ($iPage > 1 && $iPage < $iPages){$sOut .= ' '.$sSEPARATOR.' ';}
    //if ($iPage < $iPages){
    //  $sOut .= '<a title="View next gallery page." href="index'.($iPage+1).'.html">Next</a> &gt;';
    //}

    $sOut .='</p>'."\n";

  }

  //     Output the gallery table:
  
  $isImage = true;
  $iImage_count = 0;
  
  $sOut .= '<table>'."\n";
  
  while($isImage){
  
    $sOut .= '<tr>'."\n";
    
    for ($x = 0; $x<$iCOLUMNS; $x++){ 
    
      $iImage_count++;

      if (isset($files[$iCell])){
	$sOut .= '<td class="image">';

	$sOut .= '<a href="fulls/'.$files[$iCell]->name.'" title="Larger picture available ('.image_size_kb($dir.'fulls/'.$files[$iCell]->name).' Kb)">';

	if($files[$iCell]->geometry == 'portrait'){
	  $sOut .= '<img src="thumbs/'.$files[$iCell]->name.'" alt="*" width="'.$thumbs_portrait->width.'" height="'.$thumbs_portrait->height.'" />';
	}else{
	  $sOut .= '<img src="thumbs/'.$files[$iCell]->name.'" alt="*" width="'.$thumbs_portrait->height.'" height="'.$thumbs_portrait->width.'" />';
	}
      
	$sOut .= '</a></td>'."\n";
      }else{
	$sOut .= '<td class="image">&nbsp;</td>'."\n";
	$isImage = false;
      }
      $iCell ++;
    }
    
    $sOut .= '</tr>'."\n";
    if ($iImage_count == $iImages_per_page){$isImage = false; break;}
    if (!isset($files[$iCell+1])){$isImage = false; break;}
  }
  
  $sOut .= '</table>'."\n";

  if ($iPages > 1){
    $sOut .= '<p>';
    
    if ($iPage > 1){
      $sOut .= '&lt; <a title="View previous gallery page." href="index'.($iPage-1).'.html">Previous</a>';
    }
    if ($iPage > 1 && $iPage < $iPages){$sOut .= ' '.$sSEPARATOR.' ';}
    if ($iPage < $iPages){
      $sOut .= '<a title="View next gallery page." href="index'.($iPage+1).'.html">Next</a> &gt;';
    }

    $sOut .='</p>'."\n";

  }

  $sOut .= '<p>';

  if ($sCOPYRIGHT != ''){
    $sOut .= 'Copyright &copy; '.$sCOPYRIGHT.'.<br />';
  }
 
  $sOut .= 'Gallery generated at '.date("H:i").' on '.date("Y-m-d").' with <a title="PHP Image Preprocessor, released under the GPL." href="'.$sURL_PIMP.'"><strong>Pimp</strong></a> Version '.$VERSION.' using '.$iJPEG_QUALITY.'% <acronym title="Joint Photographic Experts Group">JPEG</acronym> compression.</p>'."\n";

  if ($isXHTML_LOGO){
    $sOut .='<p>
      <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" style="border:0px;" /></a>
    </p>'."\n";
  }
 
  $sOut .= '</body>'."\n";
  $sOut .= '</html>'."\n";
 
  // Do buffering and caching. index1.html, index2.html, etc....
 
  ob_start();

  echo $sOut;

  $sCachefile = 'index'.$iPage.'.html';

  $fp = fopen($sCachefile, 'w');
  fwrite($fp, ob_get_contents());
  fclose($fp);

  ob_end_clean();

}

// ----------------------------------------------------
// Output the Index HTML page
// ----------------------------------------------------

$sOut = '';

$sOut .= '<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'."\n";
  
$sOut .= '<html xmlns="http://www.w3.org/1999/xhtml" lang="en">'."\n";

if ($sCOPYRIGHT != ''){
  $sOut .= '<!-- Copyright '.$sCOPYRIGHT.' -->'."\n";
}

$sOut .= "\n".'<head>'."\n";

$sOut .= '<title>'.$sPAGE_TITLE.'</title>'."\n";

if ($isREDIRECT){
  if (file_exists('index'.$iPages.'.html')) {
    $sOut .= '<meta http-equiv="Refresh" content="0;url=index'.$iPages.'.html">'."\n";
  }
}

if ($sAUTHORS != ""){
  $sOut .= '<meta name="author" content="'.$sAUTHORS.'" />'."\n";
}

if ($sCOPYRIGHT != ''){
  $sOut .= '<meta name="copyright" content="'.$sCOPYRIGHT.'" />'."\n";
}

$sOut .= '<meta name="description" content="Here should be a description of the home page for your galleries." />'."\n";

$sOut .= '<meta name="generator" content="Pimp '.$VERSION.'. Automatic photo journalism tool. '.$sURL_PIMP.'" />'."\n";

$sOut .= $sStyle_index;
  
$sOut .= '</head>'."\n";
$sOut .= "\n".'<body>'."\n";

if ($isPAGE_TITLE == 1){
  $sOut .= '<h1>'.$sPAGE_TITLE;
  $sOut .= '</h1>'."\n";
}

$sOut .= '<ul>'."\n";
for ($c = 1; $c < $iPages+1; $c++){
  $sOut .= '<li><a href="index'.$c.'.html">Gallery '.$c.'</a></li>'."\n";
}
$sOut .= '</ul>'."\n";


if ($iPages == 0){
  $sOut .= '<p>There are no image galleries to view.</p> <p>The lack of pictures is most likely because there are no images in this directory from which to create the galleries.</p>'."\n";
}

$sOut .= '<p>';

if ($sCOPYRIGHT != ''){
  $sOut .= 'Copyright &copy; '.$sCOPYRIGHT.'.<br />';
}
 
$sOut .= 'Gallery menu generated with <a title="PHP Image Preprocessor, released under the GPL." href="'.$sURL_PIMP.'"><strong>Pimp</strong></a> Version '.$VERSION.'.</p>'."\n";
 
if ($isXHTML_LOGO){
  $sOut .='<p>
      <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" style="border:0px;" /></a>
    </p>'."\n";
}

$sOut .= '</body>'."\n";
$sOut .= '</html>'."\n";

// Do buffering and caching of index.html
 
ob_start();

echo $sOut;

$sCachefile = 'index.html';

$fp = fopen($sCachefile, 'w');
fwrite($fp, ob_get_contents());
fclose($fp);

ob_end_clean();

// Finally chuck the browser out to the last HTML page created

if (file_exists($sCachefile)) {

  include($sCachefile); 
  exit;
}

/*
 
Copyright (c) 2002 - 2004 Psand Ltd.

     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
*/

?>