X-Git-Url: https://git.nubati.net/cgi-bin/gitweb.cgi?p=phpfspot.git;a=blobdiff_plain;f=phpfspot.class.php;h=0711499f3ef113893fe89255225afb5c8baaee11;hp=3b4a62e9166abc2a420de0780bcd9b4fea7cb60f;hb=2ea665ef86c5573c244ebbba797fb31cadf6752b;hpb=072aed3d53445a6b09edabf1551706de4c3f1cb1 diff --git a/phpfspot.class.php b/phpfspot.class.php index 3b4a62e..0711499 100644 --- a/phpfspot.class.php +++ b/phpfspot.class.php @@ -2,8 +2,9 @@ /*************************************************************************** * - * Copyright (c) by Andreas Unterkircher, unki@netshadow.at - * All rights reserved + * phpfspot, presents your F-Spot photo collection in Web browsers. + * + * Copyright (c) by Andreas Unterkircher * * 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 @@ -24,20 +25,79 @@ require_once "phpfspot_cfg.php"; require_once "phpfspot_db.php"; +/** + * PHPFSPOT main class + * + * this class contains the most functions which will to the major + * work for phpfspot. + * + * @package phpfspot + */ class PHPFSPOT { + /** + * phpfspot configuration + * @access public + * @see PHPFSPOT_CFG() + * @var PHPFSPOT_CFG + */ var $cfg; + + /** + * SQLite database handle to f-spot database + * @see PHPFSPOT_DB() + * @access public + * @var PHPFSPOT_DB + */ var $db; + + /** + * SQLite database handle to phpfspot database + * @see PHPFSPOT_DB() + * @access public + * @var PHPFSPOT_DB + */ var $cfg_db; + + /** + * Smarty template engine + * @link http://smarty.php.net smarty.php.net + * @see PHPFSPOT_TMPL() + * @access public + * @var PHPFSPOT_TMPL + */ var $tmpl; + + /** + * full tag - list + * @access public + * @var array + */ var $tags; + + /** + * list of available, not-selected, tags + * @access public + * @var array + */ var $avail_tags; + /** + * true if runtime error occued + * @access private + * @var boolean + */ private $runtime_error = false; + + /** + * F-Spot database version + * @access private + * @var integer + */ private $dbver; /** - * class constructor + * class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver) * * this function will be called on class construct * and will check requirements, loads configuration, @@ -45,6 +105,14 @@ class PHPFSPOT { */ public function __construct() { + /** + * register PHPFSPOT class global + * + * @global PHPFSPOT $GLOBALS['phpfspot'] + * @name $phpfspot + */ + $GLOBALS['phpfspot'] =& $this; + $this->cfg = new PHPFSPOT_CFG; /* verify config settings */ @@ -54,7 +122,7 @@ class PHPFSPOT { /* set application name and version information */ $this->cfg->product = "phpfspot"; - $this->cfg->version = "1.4"; + $this->cfg->version = "1.5"; $this->sort_orders= array( 'date_asc' => 'Date ↑', @@ -89,6 +157,7 @@ class PHPFSPOT { "); } + /* get F-Spot database version */ $this->dbver = $this->getFspotDBVersion(); if(!is_writeable($this->cfg->base_path ."/templates_c")) { @@ -131,7 +200,17 @@ class PHPFSPOT { /* overload Smarty class with our own template handler */ require_once "phpfspot_tmpl.php"; - $this->tmpl = new PHPFSPOT_TMPL($this); + $this->tmpl = new PHPFSPOT_TMPL(); + + $this->tmpl->assign('web_path', $this->cfg->web_path); + + /* Starting with F-Spot 0.4.2, the rating-feature was available */ + if($this->dbver > 10) { + $this->sort_orders = array_merge($this->sort_orders, array( + 'rate_asc' => 'Rate ↑', + 'rate_desc' => 'Rate ↓', + )); + } /* check if all necessary indices exist */ $this->checkDbIndices(); @@ -153,6 +232,11 @@ class PHPFSPOT { if(isset($_SESSION['begin_with']) && $this->cfg->thumbs_per_page == 0) unset($_SESSION['begin_with']); + // if user-friendly-url's are enabled, set also a flag for the template handler + if($this->is_user_friendly_url()) { + $this->tmpl->assign('user_friendly_url', 'true'); + } + } // __construct() public function __destruct() @@ -176,6 +260,11 @@ class PHPFSPOT { $this->tmpl->assign('current_condition', $_SESSION['tag_condition']); $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name); + /* parse URL */ + if($this->is_user_friendly_url()) { + $content = $this->parse_user_friendly_url($_SERVER['REQUEST_URI']); + } + if(isset($_GET['mode'])) { $_SESSION['start_action'] = $_GET['mode']; @@ -236,9 +325,21 @@ class PHPFSPOT { $this->tmpl->assign('date_search_enabled', true); $this->tmpl->register_function("sort_select_list", array(&$this, "smarty_sort_select_list"), false); - $this->tmpl->assign('from_date', $this->get_calendar('from')); - $this->tmpl->assign('to_date', $this->get_calendar('to')); - $this->tmpl->assign('content_page', 'welcome.tpl'); + $this->tmpl->assign('search_from_date', $this->get_calendar('from')); + $this->tmpl->assign('search_to_date', $this->get_calendar('to')); + + $this->tmpl->assign('preset_selected_tags', $this->getSelectedTags()); + $this->tmpl->assign('preset_available_tags', $this->getAvailableTags()); + + if(!isset($content)) { + if(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags'])) + $this->tmpl->assign('initial_content', $this->showPhotoIndex()); + else + $this->tmpl->assign('initial_content', $this->tmpl->fetch('welcome.tpl')); + } + else + $this->tmpl->assign('initial_content', $content); + $this->tmpl->show("index.tpl"); } // show() @@ -321,6 +422,8 @@ class PHPFSPOT { * * retrieve all available details from f-spot's * database and return them as object + * @param integer $idx + * @return object|null */ public function get_photo_details($idx) { @@ -331,10 +434,19 @@ class PHPFSPOT { "; } else { - $query_str = " - SELECT p.id, p.uri, p.time, p.description - FROM photos p - "; + /* till F-Spot version 0.4.1 */ + if($this->dbver < 11) { + $query_str = " + SELECT p.id, p.uri, p.time, p.description + FROM photos p + "; + } + else { + $query_str = " + SELECT p.id, p.uri, p.time, p.description, p.rating + FROM photos p + "; + } } /* if show_tags is set, only return details for photos which @@ -377,6 +489,9 @@ class PHPFSPOT { * this function returns aligned (length) names for * an specific photo. If the length of the name exceeds * $limit the name will be shrinked (...) + * @param integer $idx + * @param integer $limit + * @return string|null */ public function getPhotoName($idx, $limit = 0) { @@ -391,12 +506,37 @@ class PHPFSPOT { } // getPhotoName() + /** + * get photo rating level + * + * this function will return the integer-based rating + * level of the photo. This can only be done, if the F-Spot + * database is at a specific level. If rating value can not + * be found, zero will be returned indicating no rating value + * is available. + * @param integer idx + * @return integer + */ + public function get_photo_rating($idx) + { + if($detail = $this->get_photo_details($idx)) { + if(isset($detail['rating'])) + return $detail['rating']; + } + + return 0; + + } // get_photo_rating() + /** * shrink text according provided limit * * If the length of the name exceeds $limit the * text will be shortend and some content in between * will be replaced with "..." + * @param string $ext + * @param integer $limit + * @return string */ private function shrink_text($text, $limit) { @@ -414,8 +554,10 @@ class PHPFSPOT { * as the full-qualified path recorded in the f-spot database * is usally not the same as on the webserver, this function * will replace the path with that one specified in the cfg + * @param string $path + * @return string */ - public function translate_path($path, $width = 0) + public function translate_path($path) { return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path); @@ -426,6 +568,7 @@ class PHPFSPOT { * * this function provides all the necessary information * for the single photo template. + * @param integer photo */ public function showPhoto($photo) { @@ -483,8 +626,11 @@ class PHPFSPOT { $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo); } + /* get mime-type, height and width from the original photo */ + $info = getimagesize($orig_path); + /* get EXIF information if JPEG */ - if($details['mime'] == "image/jpeg") { + if($info['mime'] == "image/jpeg") { $meta = $this->get_meta_informations($orig_path); } @@ -492,7 +638,6 @@ class PHPFSPOT { if(isset($meta['ExifImageWidth'])) { $meta_res = $meta['ExifImageWidth'] ."x". $meta['ExifImageLength']; } else { - $info = getimagesize($orig_path); $meta_res = $info[0] ."x". $info[1]; } @@ -516,20 +661,28 @@ class PHPFSPOT { return; } - $info = getimagesize($thumb_path); + $info_thumb = getimagesize($thumb_path); $this->tmpl->assign('description', $details['description']); $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename')); + $this->tmpl->assign('image_rating', $this->get_photo_rating($photo)); - $this->tmpl->assign('width', $info[0]); - $this->tmpl->assign('height', $info[1]); + $this->tmpl->assign('width', $info_thumb[0]); + $this->tmpl->assign('height', $info_thumb[1]); $this->tmpl->assign('ExifMadeOn', $meta_date); $this->tmpl->assign('ExifMadeWith', $meta_make); $this->tmpl->assign('ExifOrigResolution', $meta_res); $this->tmpl->assign('ExifFileSize', $meta_size); - $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width); - $this->tmpl->assign('image_url_full', 'phpfspot_img.php?idx='. $photo); + if($this->is_user_friendly_url()) { + $this->tmpl->assign('image_url', '/photo/'. $photo ."/". $this->cfg->photo_width); + $this->tmpl->assign('image_url_full', '/photo/'. $photo); + } + else { + $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width); + $this->tmpl->assign('image_url_full', 'phpfspot_img.php?idx='. $photo); + } + $this->tmpl->assign('image_filename', $this->parse_uri($details['uri'], 'filename')); $this->tmpl->assign('tags', $this->get_photo_tags($photo)); @@ -537,12 +690,12 @@ class PHPFSPOT { $this->tmpl->assign('current_img', $photo); if($previous_img) { - $this->tmpl->assign('previous_url', "javascript:showImage(". $previous_img .");"); + $this->tmpl->assign('previous_url', "javascript:showPhoto(". $previous_img .");"); $this->tmpl->assign('prev_img', $previous_img); } if($next_img) { - $this->tmpl->assign('next_url', "javascript:showImage(". $next_img .");"); + $this->tmpl->assign('next_url', "javascript:showPhoto(". $next_img .");"); $this->tmpl->assign('next_img', $next_img); } $this->tmpl->assign('mini_width', $this->cfg->mini_width); @@ -550,7 +703,7 @@ class PHPFSPOT { $this->tmpl->assign('photo_number', $i); $this->tmpl->assign('photo_count', count($all_photos)); - $this->tmpl->show("single_photo.tpl"); + return $this->tmpl->fetch("single_photo.tpl"); } // showPhoto() @@ -627,13 +780,15 @@ class PHPFSPOT { $b = '88'; if(isset($this->tags[$key])) { - $output.= "". $this->tags[$key] .", "; + if($this->is_user_friendly_url()) + $output.= "cfg->web_path ."/tag/". $key ."\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] .", "; + else + $output.= "cfg->web_path ."/index.php?mode=showpi\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] .", "; } - } $output = substr($output, 0, strlen($output)-2); - print $output; + return $output; } // getAvailableTags() @@ -643,8 +798,9 @@ class PHPFSPOT { * this function output all tags which have been selected * by the user. the selected tags are stored in the * session-variable $_SESSION['selected_tags'] + * @return string */ - public function getSelectedTags() + public function getSelectedTags($type = 'link') { /* retrive tags from database */ $this->get_tags(); @@ -655,7 +811,22 @@ class PHPFSPOT { { // return all selected tags if(isset($_SESSION['selected_tags']) && in_array($tag, $_SESSION['selected_tags'])) { - $output.= "". $this->tags[$tag] .", "; + + switch($type) { + default: + case 'link': + $output.= "". $this->tags[$tag] .", "; + break; + case 'img': + $output.= " +
+ "; + break; + } } } @@ -675,6 +846,7 @@ class PHPFSPOT { * this function will add the specified to users current * tag selection. if a date search has been made before * it will be now cleared + * @return string */ public function addTag($tag) { @@ -684,10 +856,15 @@ class PHPFSPOT { if(isset($_SESSION['searchfor_tag'])) unset($_SESSION['searchfor_tag']); + // has the user requested to hide this tag, and still someone, + // somehow tries to add it, don't allow this. + if(!isset($this->cfg->hide_tags) && + in_array($this->get_tag_name($tag), $this->cfg->hide_tags)) + return "ok"; + if(!in_array($tag, $_SESSION['selected_tags'])) array_push($_SESSION['selected_tags'], $tag); - return "ok"; } // addTag() @@ -697,6 +874,8 @@ class PHPFSPOT { * * this function removes the specified tag from * users current tag selection + * @param string $tag + * @return string */ public function delTag($tag) { @@ -727,7 +906,8 @@ class PHPFSPOT { } // resetTags() /** - * returns the value for the autocomplet tag-search + * returns the value for the autocomplete tag-search + * @return string */ public function get_xml_tag_list() { @@ -836,6 +1016,7 @@ class PHPFSPOT { * the tag-selection, tag- or date-search. * the tag-search also has to take care of AND * and OR conjunctions + * @return array */ public function getPhotoSelection() { @@ -1040,6 +1221,7 @@ class PHPFSPOT { * * this function provides all the necessary information * for the photo index template. + * @return string */ public function showPhotoIndex() { @@ -1073,6 +1255,7 @@ class PHPFSPOT { $img_name[$thumbs] = Array(); $img_fullname[$thumbs] = Array(); $img_title = Array(); + $img_rating = Array(); for($i = $begin_with; $i < $end_with; $i++) { @@ -1083,6 +1266,7 @@ class PHPFSPOT { $img_name[$thumbs] = htmlspecialchars($this->getPhotoName($photos[$i], 15)); $img_fullname[$thumbs] = htmlspecialchars($this->getPhotoName($photos[$i], 0)); $img_title[$thumbs] = "Click to view photo ". htmlspecialchars($this->getPhotoName($photos[$i], 0)); + $img_rating[$thumbs] = $this->get_photo_rating($photos[$i]); $thumb_path = $this->get_thumb_path($this->cfg->thumb_width, $photos[$i]); @@ -1151,7 +1335,16 @@ class PHPFSPOT { else $style = ""; - $select = "is_user_friendly_url()) { + $select = "cfg->web_path ."/tag/205/". $start_with ."\""; + } + else { + $select = "cfg->web_path ."/index.php?mode=showpi tags=". $current_tags ." begin_with=". $begin_with ."\""; + } + $select.= " onclick=\"showPhotoIndex(". $start_with ."); return false;\""; + if($style != "") $select.= $style; $select.= ">". $i ." "; @@ -1189,7 +1382,6 @@ class PHPFSPOT { if($last_page > 1) $this->tmpl->assign('page_selector', $page_select); } - $current_tags = $this->getCurrentTags(); $extern_link = "index.php?mode=showpi"; @@ -1222,19 +1414,23 @@ class PHPFSPOT { $this->tmpl->assign('img_name', $img_name); $this->tmpl->assign('img_fullname', $img_fullname); $this->tmpl->assign('img_title', $img_title); + $this->tmpl->assign('img_rating', $img_rating); $this->tmpl->assign('thumbs', $thumbs); + $this->tmpl->assign('selected_tags', $this->getSelectedTags('img')); - $this->tmpl->show("photo_index.tpl"); + $result = $this->tmpl->fetch("photo_index.tpl"); /* if we are returning to photo index from an photo-view, scroll the window to the last shown photo-thumbnail. after this, unset the last_photo session variable. */ if(isset($_SESSION['last_photo'])) { - print "\n"; + $result.= "\n"; unset($_SESSION['last_photo']); } + return $result; + } // showPhotoIndex() /** @@ -1250,12 +1446,16 @@ class PHPFSPOT { } // showCredits() /** - * create_thumbnails for the requested width + * create thumbnails for the requested width * * this function creates image thumbnails of $orig_image * stored as $thumb_image. It will check if the image is * in a supported format, if necessary rotate the image * (based on EXIF orientation meta headers) and re-sizing. + * @param string $orig_image + * @param string $thumb_image + * @param integer $width + * @return boolean */ public function create_thumbnail($orig_image, $thumb_image, $width) { @@ -1263,13 +1463,13 @@ class PHPFSPOT { return false; } - $details = getimagesize($orig_image); - + $mime = $this->get_mime_info($orig_image); + /* check if original photo is a support image type */ - if(!$this->checkifImageSupported($details['mime'])) + if(!$this->checkifImageSupported($mime)) return false; - switch($details['mime']) { + switch($mime) { case 'image/jpeg': @@ -1299,32 +1499,66 @@ class PHPFSPOT { } $src_img = @imagecreatefromjpeg($orig_image); + $handler = "gd"; break; case 'image/png': $src_img = @imagecreatefrompng($orig_image); + $handler = "gd"; + break; + + case 'image/x-portable-pixmap': + + $src_img = new Imagick($orig_image); + $handler = "imagick"; break; } - if(!$src_img) { + if(!isset($src_img) || empty($src_img)) { print "Can't load image from ". $orig_image ."\n"; return false; } - /* grabs the height and width */ - $cur_width = imagesx($src_img); - $cur_height = imagesy($src_img); + switch($handler) { + + case 'gd': + + /* grabs the height and width */ + $cur_width = imagesx($src_img); + $cur_height = imagesy($src_img); + + // If requested width is more then the actual image width, + // do not generate a thumbnail, instead safe the original + // as thumbnail but with lower quality. But if the image + // is to heigh too, then we still have to resize it. + if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) { + $result = imagejpeg($src_img, $thumb_image, 75); + imagedestroy($src_img); + return true; + } + break; + + case 'imagick': + + $cur_width = $src_img->getImageWidth(); + $cur_height = $src_img->getImageHeight(); + + // If requested width is more then the actual image width, + // do not generate a thumbnail, instead safe the original + // as thumbnail but with lower quality. But if the image + // is to heigh too, then we still have to resize it. + if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) { + $src_img->setCompressionQuality(75); + $src_img->setImageFormat('jpeg'); + $src_img->writeImage($thumb_image); + $src_img->clear(); + $src_img->destroy(); + return true; + } + break; - // If requested width is more then the actual image width, - // do not generate a thumbnail, instead safe the original - // as thumbnail but with lower quality. But if the image - // is to heigh too, then we still have to resize it. - if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) { - $result = imagejpeg($src_img, $thumb_image, 75); - imagedestroy($src_img); - return true; } // If the image will be rotate because EXIF orientation said so @@ -1366,48 +1600,94 @@ class PHPFSPOT { } } - /* creates new image of that size */ - $dst_img = imagecreatetruecolor($new_w, $new_h); + switch($handler) { - imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255)); + case 'gd': - /* copies resized portion of original image into new image */ - imagecopyresampled($dst_img, $src_img, 0, 0, 0, 0, $new_w, $new_h, imagesx($src_img), imagesy($src_img)); + /* creates new image of that size */ + $dst_img = imagecreatetruecolor($new_w, $new_h); - /* needs the image to be flipped horizontal? */ - if($flip_hori) { - $this->_debug("(FLIP)"); - $dst_img = $this->flipImage($dst_img, 'hori'); - } - /* needs the image to be flipped vertical? */ - if($flip_vert) { - $this->_debug("(FLIP)"); - $dst_img = $this->flipImage($dst_img, 'vert'); - } + imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255)); - if($rotate) { - $this->_debug("(ROTATE)"); - $dst_img = $this->rotateImage($dst_img, $rotate); - } + /* copies resized portion of original image into new image */ + imagecopyresampled($dst_img, $src_img, 0, 0, 0, 0, $new_w, $new_h, imagesx($src_img), imagesy($src_img)); + + /* needs the image to be flipped horizontal? */ + if($flip_hori) { + $this->_debug("(FLIP)"); + $dst_img = $this->flipImage($dst_img, 'hori'); + } + /* needs the image to be flipped vertical? */ + if($flip_vert) { + $this->_debug("(FLIP)"); + $dst_img = $this->flipImage($dst_img, 'vert'); + } - /* write down new generated file */ - $result = imagejpeg($dst_img, $thumb_image, 75); + if($rotate) { + $this->_debug("(ROTATE)"); + $dst_img = $this->rotateImage($dst_img, $rotate); + } - /* free your mind */ - imagedestroy($dst_img); - imagedestroy($src_img); + /* write down new generated file */ + $result = imagejpeg($dst_img, $thumb_image, 75); - if($result === false) { - print "Can't write thumbnail ". $thumb_image ."\n"; - return false; - } + /* free your mind */ + imagedestroy($dst_img); + imagedestroy($src_img); - return true; + if($result === false) { + print "Can't write thumbnail ". $thumb_image ."\n"; + return false; + } + + return true; + + break; + + case 'imagick': + + $src_img->resizeImage($new_w, $new_h, Imagick::FILTER_LANCZOS, 1); + + /* needs the image to be flipped horizontal? */ + if($flip_hori) { + $this->_debug("(FLIP)"); + $src_img->rotateImage(new ImagickPixel(), 90); + $src_img->flipImage(); + $src_img->rotateImage(new ImagickPixel(), -90); + } + /* needs the image to be flipped vertical? */ + if($flip_vert) { + $this->_debug("(FLIP)"); + $src_img->flipImage(); + } + + if($rotate) { + $this->_debug("(ROTATE)"); + $src_img->rotateImage(new ImagickPixel(), $rotate); + } + + $src_img->setCompressionQuality(75); + $src_img->setImageFormat('jpeg'); + + if(!$src_img->writeImage($thumb_image)) { + print "Can't write thumbnail ". $thumb_image ."\n"; + return false; + } + + $src_img->clear(); + $src_img->destroy(); + return true; + + break; + + } } // create_thumbnail() /** * return all exif meta data from the file + * @param string $file + * @return array */ public function get_meta_informations($file) { @@ -1446,6 +1726,9 @@ class PHPFSPOT { * readable * 2. Check if the md5sum of the original file has changed * 3. Generate the thumbnails if needed + * @param integer $idx + * @param integer $force + * @param boolean $overwrite */ public function gen_thumb($idx = 0, $force = 0, $overwrite = false) { @@ -1455,6 +1738,7 @@ class PHPFSPOT { $this->cfg->thumb_width, $this->cfg->photo_width, $this->cfg->mini_width, + 30, ); /* get details from F-Spot's database */ @@ -1473,10 +1757,27 @@ class PHPFSPOT { return; } - $file_md5 = md5_file($full_path); - $this->_debug("Image [". $idx ."] ". $this->shrink_text($this->parse_uri($details['uri'], 'filename'), 20) ." Thumbnails:"); + /* If Nikon NEF format, we need to treat it another way */ + if(isset($this->cfg->dcraw_bin) && + file_exists($this->cfg->dcraw_bin) && + is_executable($this->cfg->dcraw_bin) && + preg_match('/\.nef$/i', $details['uri'])) { + + $ppm_path = preg_replace('/\.nef$/i', '.ppm', $full_path); + + /* if PPM file does not exist, let dcraw convert it from NEF */ + if(!file_exists($ppm_path)) { + system($this->cfg->dcraw_bin ." -a ". $full_path); + } + + /* for now we handle the PPM instead of the NEF */ + $full_path = $ppm_path; + + } + + $file_md5 = md5_file($full_path); $changes = false; foreach($resolutions as $resolution) { @@ -1528,6 +1829,8 @@ class PHPFSPOT { * * this function queries the phpfspot database for a * stored MD5 checksum of the specified photo + * @param integer $idx + * @return string|null */ public function getMD5($idx) { @@ -1547,6 +1850,8 @@ class PHPFSPOT { /** * set MD5 sum for the specific photo + * @param integer $idx + * @param string $md5 */ private function setMD5($idx, $md5) { @@ -1562,6 +1867,8 @@ class PHPFSPOT { * * this function stores the current tag condition * (AND or OR) in the users session variables + * @param string $mode + * @return string */ public function setTagCondition($mode) { @@ -1579,6 +1886,7 @@ class PHPFSPOT { * it also handles the date search. * getPhotoSelection() will then only return the matching * photos. + * @return string */ public function startSearch() { @@ -1629,6 +1937,8 @@ class PHPFSPOT { * * this function is invoked by RPC and will sort the requested * sort order in the session variable. + * @param string $sort_order + * @return string */ public function updateSortOrder($order) { @@ -1646,6 +1956,9 @@ class PHPFSPOT { * * this function rotates the image according the * specified angel. + * @param string $img + * @param integer $degress + * @return image */ private function rotateImage($img, $degrees) { @@ -1723,6 +2036,9 @@ class PHPFSPOT { * * this function will return an either horizontal or * vertical flipped truecolor image. + * @param string $image + * @param string $mode + * @return image */ private function flipImage($image, $mode) { @@ -1749,6 +2065,8 @@ class PHPFSPOT { /** * return all assigned tags for the specified photo + * @param integer $idx + * @return array */ private function get_photo_tags($idx) { @@ -1762,8 +2080,11 @@ class PHPFSPOT { $tags = Array(); - while($row = $this->db->db_fetch_object($result)) + while($row = $this->db->db_fetch_object($result)) { + if(isset($this->cfg->hide_tags) && in_array($row['name'], $this->cfg->hide_tags)) + continue; $tags[$row['id']] = $row['name']; + } return $tags; @@ -1771,6 +2092,11 @@ class PHPFSPOT { /** * create on-the-fly images with text within + * @param string $txt + * @param string $color + * @param integer $space + * @param integer $font + * @param integer $w */ public function showTextImage($txt, $color=000000, $space=4, $font=4, $w=300) { @@ -1800,6 +2126,7 @@ class PHPFSPOT { /** * check if all requirements are met + * @return boolean */ private function check_requirements() { @@ -1854,16 +2181,29 @@ class PHPFSPOT { /** * check if specified MIME type is supported + * @param string $mime + * @return boolean */ public function checkifImageSupported($mime) { - if(in_array($mime, Array("image/jpeg", "image/png"))) + $supported_types = Array( + "image/jpeg", + "image/png", + "image/x-portable-pixmap", + "image/tiff" + ); + + if(in_array($mime, $supported_types)) return true; return false; } // checkifImageSupported() + /** + * output error text + * @param string $text + */ public function _error($text) { switch($this->cfg->logging) { @@ -1886,6 +2226,8 @@ class PHPFSPOT { /** * output calendard input fields + * @param string $mode + * @return string */ private function get_calendar($mode) { @@ -1912,6 +2254,9 @@ class PHPFSPOT { /** * output calendar matrix + * @param integer $year + * @param integer $month + * @param integer $day */ public function get_calendar_matrix($year = 0, $month = 0, $day = 0) { @@ -1990,6 +2335,7 @@ class PHPFSPOT { /** * output export page + * @param string $mode */ public function getExport($mode) { @@ -1998,7 +2344,7 @@ class PHPFSPOT { foreach($pictures as $picture) { - $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture; + $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture; if($current_tags != "") { $orig_url.= "&tags=". $current_tags; } @@ -2006,7 +2352,12 @@ class PHPFSPOT { $orig_url.= "&from_date=". $_SESSION['from_date'] ."&to_date=". $_SESSION['to_date']; } - $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width; + if($this->is_user_friendly_url()) { + $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width; + } + else { + $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width; + } switch($mode) { @@ -2055,7 +2406,7 @@ class PHPFSPOT { foreach($pictures as $picture) { - $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture; + $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture; if($current_tags != "") { $orig_url.= "&tags=". $current_tags; } @@ -2065,7 +2416,13 @@ class PHPFSPOT { $details = $this->get_photo_details($picture); - $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width; + if($this->is_user_friendly_url()) { + $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width; + } + else { + $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width; + } + $thumb_html = htmlspecialchars("