Skip to content

Commit

Permalink
Refactor annotate photo, watermark photo, image.php
Browse files Browse the repository at this point in the history 
Rewritten the annotate photo function to no longer use a temporary file.
Computers nowadays are fast enough to generate the image on the fly.

Moved annotate photo into a subclass annotatePhoto and made a similar
change to watermarking, creating subclass watermarkPhoto. Moved parts
of image.php into these classes and also into the class photo.
  • Loading branch information
@jeroenrnl
jeroenrnl committed Nov 16, 2012
1 parent 9e45426 commit 3f4ab55
Show file tree
Hide file tree
Showing 8 changed files with 472 additions and 373 deletions.
8 changes: 0 additions & 8 deletions php/auth.inc.php
View file
Expand Up @@ -68,10 +68,6 @@

// no user was in the session, try logging in
if ($_action == "logout") {
// delete left over temp files
if($user) {
delete_temp_annotated_files($user->get("user_id"));
}
session_destroy();
$user = null;
redirect("logon.php", "Logout");
Expand Down Expand Up @@ -100,10 +96,6 @@
$updated_user->set("lastlogin", "now()");
$updated_user->set("lastip", $_SERVER["REMOTE_ADDR"]);
$updated_user->update();

// delete left over temp files
delete_temp_annotated_files($user->get("user_id"));

} else {
$this_page=urlencode(preg_replace("/^\//", "", $_SERVER['REQUEST_URI']));
redirect("logon.php?redirect=" . $this_page);
Expand Down
210 changes: 210 additions & 0 deletions php/classes/annotatedPhoto.inc.php
View file
@@ -0,0 +1,210 @@
<?php
/**
* A class representing an annotated photo
* An annotated photo is a photo with information about the
* photo added to the image
*
* This file is part of Zoph.
*
* Zoph 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.
*
* Zoph 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.
* You should have received a copy of the GNU General Public License
* along with Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
* @author Richard P. Childs
*/

class annotatedPhoto extends photo {

/** The vars that are going to be displayed on the photo */
private $vars=array();

/**
* Creates a jpeg photo with
* text annotation at the bottom.
*
* Copyright 2003, Nixon P. Childs
* @param string type of image to display mid, thumb or null for full-sized
* @return array Return an array that contains:
* array headers: the headers
* string jpeg: the jpeg file
* @throws photoException
*/
public function display($type=null) {
if($type=="full") {
$type=null;
}
$headers=array();
$vars=&$this->vars;
if ($type == 'mid') {
$font = 4;
$padding = 2;
$indent = 8;
} else if (empty($type)) {
$font = 5;
$padding = 2;
$indent = 8;
} else {
throw new photoException("Unknown type");
}

/* ********************************
* Read in original image.
* Need to do now so we know
* the width of the text lines.
* ********************************/

$image_path = conf::get("path.images") . $this->get("path");
$name=$this->get("name");
if (empty($type)) {
$image_path .= "/" . $name;
} else {
$image_path .= "/" . $type . "/" . $type . "_" . $name;
}

$image_info = getimagesize($image_path);
switch ($image_info[2]) {
case 1:
$orig_image = imagecreatefromgif($image_path);
break;
case 2:
$orig_image = imagecreatefromjpeg($image_path);
break;
case 3:
$orig_image = imagecreatefrompng($image_path);
break;
default:
log::msg("Unsupported image type.", log::ERROR, log::IMG);
return '';
}

$row = ImageSY($orig_image) + ($padding/2);
$maxWidthPixels = ImageSX($orig_image) - (2 * $indent);
$maxWidthChars = floor($maxWidthPixels / ImageFontWidth($font)) - 1;


/* **********************************************
* Create Image
* In order to create the text area, we must
* first create the text and determine how much
* space it requires.
*
* I tried implode;wordwrap;explode, but
* wordwrap doesn't respect \n's in the text.
* To complicate things, ImageString just
* renders \n as an upside-down Y.
*
* So the current solution is a little awkward,
* but it works. The only (known) problem is
* that wrapped lines don't have the same
* right margin as non-wrapped lines. This is
* because wordwrap doesn't take into account
* the line separation string.
* **********************************************/

$count = 0;
$final_array=array();
if ($vars) {
while (list($key, $val) = each($vars)) {
$tmp_array = explode("\n", wordwrap($val, $maxWidthChars, "\n "));
while (list($key1, $val1) = each($tmp_array)) {
$final_array[$count++] = $val1;
}
}
}

$noted_image = ImageCreateTrueColor (ImageSX($orig_image), ImageSY($orig_image) + ((ImageFontHeight($font) + $padding) * $count));
$white = ImageColorAllocate($noted_image, 255,255, 255);

/* Use a light grey background to hide the jpeg artifacts caused by the sharp edges in text. */

$offwhite = ImageColorAllocate($noted_image, 240,240, 240);
ImageFill($noted_image, 0, ImageSY($orig_image) +1, $offwhite);
$black = ImageColorAllocate($noted_image, 0, 0, 0);
ImageColorTransparent($noted_image, $black);

ImageCopy($noted_image, $orig_image, 0, 0, 0, 0, ImageSX($orig_image), ImageSY($orig_image));

if ($final_array) {
while (list($key, $val) = each($final_array)) {
ImageString ($noted_image, $font, $indent, $row, $val, $black);
$row += ImageFontHeight($font) + $padding;
}
}

ob_start();
imagejpeg($noted_image);
imagedestroy($orig_image);
imagedestroy($noted_image);
$jpeg=ob_get_clean();

$headers["Content-Length"]=strlen($jpeg);
$headers["Content-Disposition"]="inline; filename=" . $name;
// Return current time as last modified time
// this is debatable, we could also send the file time as last modified
$headers["Last-Modified"]=gmdate("D, d M Y H:i:s") . ' GMT';
$headers["Content-type"]="image/jpeg";

return array($headers, $jpeg);


}

/**
* Sets fields from the given array. Can be used to set vars
* directly from a GET or POST.
* @param array vars to import into $this->vars;
*/
public function setVars(array $vars) {
reset($vars);
while (list($key, $val) = each($vars)) {

// ignore empty keys or values
if (empty($key) || $val == "") { continue; }

if (strcmp(Substr($key, strlen($key) - 3), "_cb") == 0) {

/* *****************************************
* Everthing else uses the checkbox name
* as the "get" key.
* *****************************************/

$real_key = Substr($key, 0, strlen($key) - 3);
$real_val = $vars[$real_key];

/* *****************************************
* Have to handle title separately because
* breadcrumbs.inc.php assumes title is
* the page title.
* *****************************************/

if ($real_key == "photo_title") {
$real_key = "title";
}
else if ($real_key == "extra") {
$real_key = $vars["extra_name"];
}

$this->vars[$real_key] = translate($real_key, 0) . ": " . $real_val;
}
}
}

/**
* Return the vars, so the can be re-used after a form POST
*/
public function getVars() {
return $this->vars;
}
}
?>
112 changes: 112 additions & 0 deletions php/classes/watermarkedPhoto.inc.php
View file
@@ -0,0 +1,112 @@
<?php
/**
* A class representing a watermarked photo
* This is a photo with a "watermark" superimposed over it
* usually to prevent unauthorized use the photo
*
* This file is part of Zoph.
*
* Zoph 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.
*
* Zoph 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.
* You should have received a copy of the GNU General Public License
* along with Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
*/

class watermarkedPhoto extends photo {
/**
* Display the watermarked image
* @param string type of image to display mid, thumb or null for full-sized
* @return array Return an array that contains:
* array headers: the headers
* string jpeg: the jpeg file
* @todo only supports JPEG currently, should support more filetypes
*/
public function display($type=null) {
$headers=array();
// Only fullsize images are (currently) watermarked
if(empty($type)) {
$watermark_file = conf::get("path.images") . "/" . conf::get("watermark.file");
if (file_exists($watermark_file)) {
$name = $this->get("name");
$image_path = conf::get("path.images") . "/" . $this->get("path") . "/" . $name;
$image=imagecreatefromjpeg($image_path);
$image=$this->watermark($image, $watermark_file, conf::get("watermark.pos.x"), conf::get("watermark.pos.y"), conf::get("watermark.transparency"));
ob_start();
imagejpeg($image);
imagedestroy($image);
$jpeg=ob_get_clean();
$headers["Content-Length"]=strlen($jpeg);
$headers["Content-Disposition"]="inline; filename=" . $name;
// Return current time as last modified time
// this is debatable, we could also send the file time as last modified
$headers["Last-Modified"]=gmdate("D, d M Y H:i:s") . ' GMT';
$headers["Content-type"]="image/jpeg";

return array($headers, $jpeg);

}
}
return parent::display($type);
}

/**
* Watermark the photo
* @param imageresource photo
* @param string GIF image to be used as watermark
* @param string position horizontally (center, left or right)
* @param string position vertically (center, top or bottom)
* @param int transparency (0 = invisible, 100 = no transparency)
* @return imageresource watermarked photo
*/
private function watermark($orig, $watermark, $positionX = "center", $positionY = "center", $transparency = 50) {

$wm=imagecreatefromgif($watermark);

$width_orig=ImageSX($orig);
$height_orig=ImageSY($orig);

$width_wm=ImageSX($wm);
$height_wm=ImageSY($wm);

switch ($positionX) {
case "left":
$destX = 5;
break;
case "right":
$destX = $width_orig - $width_wm - 5;
break;
default:
$destX = ($width_orig / 2) - ($width_wm / 2);
break;
}

switch ($positionY) {
case "top":
$destY = 5;
break;
case "bottom":
$destY = $height_orig - $height_wm - 5;
break;
default:
$destY = ($height_orig / 2) - ($height_wm / 2);
break;
}
ImageCopyMerge($orig, $wm, $destX, $destY, 0, 0, $width_wm, $height_wm, $transparency);
imagedestroy($wm);
return $orig;
}


}
?>

1 comment on commit 3f4ab55

@jeroenrnl
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partly fixes issue 4
#4

Please sign in to comment.