X-Git-Url: https://git.nubati.net/cgi-bin/gitweb.cgi?p=phpfspot.git;a=blobdiff_plain;f=phpfspot.class.php;h=eb2312bf709a9b5ff0302d4538fa18480e6c2a1b;hp=d192d0d6445acee4f4a5f3ab69d03ca73e215329;hb=5aacb6d86fa943c66ee94eb603887bb40e034ec5;hpb=e57f68e3a9df5a040bccb483da6cc21d2d028ad8 diff --git a/phpfspot.class.php b/phpfspot.class.php index d192d0d..eb2312b 100644 --- a/phpfspot.class.php +++ b/phpfspot.class.php @@ -25,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, @@ -46,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 */ @@ -132,7 +199,7 @@ 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(); /* check if all necessary indices exist */ $this->checkDbIndices(); @@ -322,6 +389,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) { @@ -378,6 +447,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) { @@ -398,6 +470,9 @@ class PHPFSPOT { * 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) { @@ -415,8 +490,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); @@ -427,6 +504,7 @@ class PHPFSPOT { * * this function provides all the necessary information * for the single photo template. + * @param integer photo */ public function showPhoto($photo) { @@ -646,6 +724,7 @@ 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() { @@ -678,6 +757,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) { @@ -700,6 +780,8 @@ class PHPFSPOT { * * this function removes the specified tag from * users current tag selection + * @param string $tag + * @return string */ public function delTag($tag) { @@ -731,6 +813,7 @@ class PHPFSPOT { /** * returns the value for the autocomplet tag-search + * @return string */ public function get_xml_tag_list() { @@ -839,6 +922,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() { @@ -1259,6 +1343,10 @@ class PHPFSPOT { * 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) { @@ -1302,115 +1390,141 @@ class PHPFSPOT { } $src_img = @imagecreatefromjpeg($orig_image); + $handler = "gd"; break; case 'image/png': $src_img = @imagecreatefrompng($orig_image); + $handler = "gd"; break; - } + case 'image/tiff': + + $src_img = new Imagick($orig_image); + print_r($src_img->queryFormats()); + + $handler = "imagick"; + exit(1); + break; - if(!$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); - // 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; - } + switch($handler) { - // If the image will be rotate because EXIF orientation said so - // 'virtually rotate' the image for further calculations - if($rotate == 90 || $rotate == 270) { - $tmp = $cur_width; - $cur_width = $cur_height; - $cur_height = $tmp; - } + case 'gd': - /* calculates aspect ratio */ - $aspect_ratio = $cur_height / $cur_width; + if(!isset($src_img) || empty($src_img)) { + print "Can't load image from ". $orig_image ."\n"; + return false; + } - /* sets new size */ - if($aspect_ratio < 1) { - $new_w = $width; - $new_h = abs($new_w * $aspect_ratio); - } else { - /* 'virtually' rotate the image and calculate it's ratio */ - $tmp_w = $cur_height; - $tmp_h = $cur_width; - /* now get the ratio from the 'rotated' image */ - $tmp_ratio = $tmp_h/$tmp_w; - /* now calculate the new dimensions */ - $tmp_w = $width; - $tmp_h = abs($tmp_w * $tmp_ratio); - - // now that we know, how high they photo should be, if it - // gets rotated, use this high to scale the image - $new_h = $tmp_h; - $new_w = abs($new_h / $aspect_ratio); - - // If the image will be rotate because EXIF orientation said so - // now 'virtually rotate' back the image for the image manipulation - if($rotate == 90 || $rotate == 270) { - $tmp = $new_w; - $new_w = $new_h; - $new_h = $tmp; - } - } + /* 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; + } + + // If the image will be rotate because EXIF orientation said so + // 'virtually rotate' the image for further calculations + if($rotate == 90 || $rotate == 270) { + $tmp = $cur_width; + $cur_width = $cur_height; + $cur_height = $tmp; + } - /* creates new image of that size */ - $dst_img = imagecreatetruecolor($new_w, $new_h); + /* calculates aspect ratio */ + $aspect_ratio = $cur_height / $cur_width; - imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255)); + /* sets new size */ + if($aspect_ratio < 1) { + $new_w = $width; + $new_h = abs($new_w * $aspect_ratio); + } else { + /* 'virtually' rotate the image and calculate it's ratio */ + $tmp_w = $cur_height; + $tmp_h = $cur_width; + /* now get the ratio from the 'rotated' image */ + $tmp_ratio = $tmp_h/$tmp_w; + /* now calculate the new dimensions */ + $tmp_w = $width; + $tmp_h = abs($tmp_w * $tmp_ratio); + + // now that we know, how high they photo should be, if it + // gets rotated, use this high to scale the image + $new_h = $tmp_h; + $new_w = abs($new_h / $aspect_ratio); + + // If the image will be rotate because EXIF orientation said so + // now 'virtually rotate' back the image for the image manipulation + if($rotate == 90 || $rotate == 270) { + $tmp = $new_w; + $new_w = $new_h; + $new_h = $tmp; + } + } - /* 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': + + break; + + } } // create_thumbnail() /** * return all exif meta data from the file + * @param string $file + * @return array */ public function get_meta_informations($file) { @@ -1449,6 +1563,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) { @@ -1531,6 +1648,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) { @@ -1550,6 +1669,8 @@ class PHPFSPOT { /** * set MD5 sum for the specific photo + * @param integer $idx + * @param string $md5 */ private function setMD5($idx, $md5) { @@ -1565,6 +1686,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) { @@ -1582,6 +1705,7 @@ class PHPFSPOT { * it also handles the date search. * getPhotoSelection() will then only return the matching * photos. + * @return string */ public function startSearch() { @@ -1632,6 +1756,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) { @@ -1649,6 +1775,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) { @@ -1726,6 +1855,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) { @@ -1752,6 +1884,8 @@ class PHPFSPOT { /** * return all assigned tags for the specified photo + * @param integer $idx + * @return array */ private function get_photo_tags($idx) { @@ -1774,6 +1908,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) { @@ -1803,6 +1942,7 @@ class PHPFSPOT { /** * check if all requirements are met + * @return boolean */ private function check_requirements() { @@ -1857,16 +1997,22 @@ 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"))) + if(in_array($mime, Array("image/jpeg", "image/png", "image/tiff"))) return true; return false; } // checkifImageSupported() + /** + * output error text + * @param string $text + */ public function _error($text) { switch($this->cfg->logging) { @@ -1889,6 +2035,8 @@ class PHPFSPOT { /** * output calendard input fields + * @param string $mode + * @return string */ private function get_calendar($mode) { @@ -1915,6 +2063,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) { @@ -1993,6 +2144,7 @@ class PHPFSPOT { /** * output export page + * @param string $mode */ public function getExport($mode) { @@ -2108,6 +2260,7 @@ class PHPFSPOT { /** * return all selected tags as one string + * @return array */ private function getCurrentTags() { @@ -2139,6 +2292,7 @@ class PHPFSPOT { * to do next. This is necessary for directly jumping * into photo index or single photo view when the are * requested with specific URLs + * @return string */ public function whatToDo() { @@ -2158,6 +2312,7 @@ class PHPFSPOT { /** * return the current process-user + * @return string */ private function getuid() { @@ -2173,6 +2328,9 @@ class PHPFSPOT { /** * returns a select-dropdown box to select photo index sort parameters + * @param array $params + * @param smarty $smarty + * @return string */ public function smarty_sort_select_list($params, &$smarty) { @@ -2192,6 +2350,7 @@ class PHPFSPOT { /** * returns the currently selected sort order + * @return string */ private function get_sort_order() { @@ -2228,12 +2387,13 @@ class PHPFSPOT { } // get_sort_order() - /*** - * return the next to be shown slide show image - * - * this function returns the URL of the next image - * in the slideshow sequence. - */ + /** + * return the next to be shown slide show image + * + * this function returns the URL of the next image + * in the slideshow sequence. + * @return string + */ public function getNextSlideShowImage() { $all_photos = $this->getPhotoSelection(); @@ -2247,12 +2407,13 @@ class PHPFSPOT { } // getNextSlideShowImage() - /*** - * return the previous to be shown slide show image - * - * this function returns the URL of the previous image - * in the slideshow sequence. - */ + /** + * return the previous to be shown slide show image + * + * this function returns the URL of the previous image + * in the slideshow sequence. + * @return string + */ public function getPrevSlideShowImage() { $all_photos = $this->getPhotoSelection(); @@ -2273,16 +2434,17 @@ class PHPFSPOT { } // resetSlideShow() - /*** - * get random photo - * - * this function will get all photos from the fspot - * database and randomly return ONE entry - * - * saddly there is yet no sqlite3 function which returns - * the bulk result in array, so we have to fill up our - * own here. - */ + /** + * get random photo + * + * this function will get all photos from the fspot + * database and randomly return ONE entry + * + * saddly there is yet no sqlite3 function which returns + * the bulk result in array, so we have to fill up our + * own here. + * @return array + */ public function get_random_photo() { $all = Array(); @@ -2306,6 +2468,8 @@ class PHPFSPOT { * this function validates if the provided date * contains a valid date and will return true * if it is. + * @param string $date_str + * @return boolean */ public function isValidDate($date_str) { @@ -2320,15 +2484,22 @@ class PHPFSPOT { /** * timestamp to string conversion + * @param integer $timestamp + * @return string */ private function ts2str($timestamp) { return strftime("%Y-%m-%d", $timestamp); } // ts2str() + /** + * extract tag-names from $_GET['tags'] + * @param string $tags_str + * @return string + */ private function extractTags($tags_str) { - $not_validated = split(',', $_GET['tags']); + $not_validated = split(',', $tags_str); $validated = array(); foreach($not_validated as $tag) { @@ -2342,6 +2513,9 @@ class PHPFSPOT { /** * returns the full path to a thumbnail + * @param integer $width + * @param integer $photo + * @return string */ public function get_thumb_path($width, $photo) { @@ -2359,6 +2533,7 @@ class PHPFSPOT { /** * returns server's virtual host name + * @return string */ private function get_server_name() { @@ -2366,8 +2541,8 @@ class PHPFSPOT { } // get_server_name() /** - * returns type of webprotocol which is - * currently used + * returns type of webprotocol which is currently used + * @return string */ private function get_web_protocol() { @@ -2379,6 +2554,7 @@ class PHPFSPOT { /** * return url to this phpfspot installation + * @return string */ private function get_phpfspot_url() { @@ -2387,6 +2563,8 @@ class PHPFSPOT { /** * returns the number of photos which are tagged with $tag_id + * @param integer $tag_id + * @return integer */ public function get_num_photos($tag_id) { @@ -2410,6 +2588,9 @@ class PHPFSPOT { * returns true, if everything is ok, otherwise false * if $silent is not set, this function will output and * error message + * @param string $file + * @param boolean $silent + * @return boolean */ private function check_readable($file, $silent = null) { @@ -2454,6 +2635,7 @@ class PHPFSPOT { * * this function will return the F-Spot database version number * It is stored within the sqlite3 database in the table meta + * @return string|null */ public function getFspotDBVersion() { @@ -2470,8 +2652,10 @@ class PHPFSPOT { } // getFspotDBVersion() /** - * parse the provided URI and will returned the - * requested chunk + * parse the provided URI and will returned the requested chunk + * @param string $uri + * @param string $mode + * @return string */ public function parse_uri($uri, $mode) { @@ -2499,6 +2683,7 @@ class PHPFSPOT { * * this function checks if all necessary configuration options are * specified and set. + * @return boolean */ private function check_config_options() { @@ -2618,6 +2803,9 @@ class PHPFSPOT { * current page, in which the $current photo lies. this is * used to display the correct photo, when calling showPhotoIndex() * from showImage() + * @param integer $current + * @param integer $max + * @return integer */ private function getCurrentPage($current, $max) {