X-Git-Url: https://git.nubati.net/cgi-bin/gitweb.cgi?p=phpfspot.git;a=blobdiff_plain;f=phpfspot.class.php;h=d2bb907009a9a29d98809247f7699b1aecb65425;hp=05532044dbfa2015d63bdc8f6082c712238312e7;hb=4eb1005353a0d5cb65b329338d7bcccb07e2e677;hpb=66fc274f7ae4d70998e416917c9cfe2ba62add97 diff --git a/phpfspot.class.php b/phpfspot.class.php index 0553204..d2bb907 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,18 +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, @@ -43,58 +105,103 @@ 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 */ + if($this->check_config_options()) { + exit(1); + } + /* set application name and version information */ $this->cfg->product = "phpfspot"; - $this->cfg->version = "1.2"; + $this->cfg->version = "1.5"; $this->sort_orders= array( 'date_asc' => 'Date ↑', 'date_desc' => 'Date ↓', 'name_asc' => 'Name ↑', - 'name_desc' => 'Name ↓' + 'name_desc' => 'Name ↓', + 'tags_asc' => 'Tags ↑', + 'tags_desc' => 'Tags ↓', ); /* Check necessary requirements */ - if(!$this->checkRequirements()) { + if(!$this->check_requirements()) { exit(1); } - $this->db = new PHPFSPOT_DB($this, $this->cfg->fspot_db); + /******* Opening F-Spot's sqlite database *********/ + + /* Check if database file is writeable */ if(!is_writeable($this->cfg->fspot_db)) { print $this->cfg->fspot_db ." is not writeable for user ". $this->getuid() ."\n"; exit(1); } - $this->dbver = $this->getFspotDBVersion(); + /* open the database */ + $this->db = new PHPFSPOT_DB($this, $this->cfg->fspot_db); - if(!is_writeable(dirname($this->cfg->phpfspot_db))) { - print dirname($this->cfg->phpfspot_db) .": directory is not writeable for user ". $this->getuid() ."\n"; - exit(1); + /* change sqlite temp directory, if requested */ + if(isset($this->cfg->sqlite_temp_dir)) { + $this->db->db_exec(" + PRAGMA + temp_store_directory = '". $this->cfg->sqlite_temp_dir ."' + "); } + $this->dbver = $this->getFspotDBVersion(); + if(!is_writeable($this->cfg->base_path ."/templates_c")) { print $this->cfg->base_path ."/templates_c: directory is not writeable for user ". $this->getuid() ."\n"; exit(1); } - $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db); + if(!is_writeable($this->cfg->thumb_path)) { + print $this->cfg->thumb_path .": directory is not writeable for user ". $this->getuid() ."\n"; + exit(1); + } + + /******* Opening phpfspot's sqlite database *********/ + + /* Check if directory where the database file is stored is writeable */ + if(!is_writeable(dirname($this->cfg->phpfspot_db))) { + print dirname($this->cfg->phpfspot_db) .": directory is not writeable for user ". $this->getuid() ."\n"; + exit(1); + } + + /* Check if database file is writeable */ if(!is_writeable($this->cfg->phpfspot_db)) { print $this->cfg->phpfspot_db ." is not writeable for user ". $this->getuid() ."\n"; exit(1); } - $this->check_config_table(); + /* open the database */ + $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db); - /* include Smarty template engine */ - if(!$this->check_readable($this->cfg->smarty_path .'/libs/Smarty.class.php')) { - exit(1); + /* change sqlite temp directory, if requested */ + if(isset($this->cfg->sqlite_temp_dir)) { + $this->cfg_db->db_exec(" + PRAGMA + temp_store_directory = '". $this->cfg->sqlite_temp_dir ."' + "); } - require $this->cfg->smarty_path .'/libs/Smarty.class.php'; - /* overload Smarty class if our own template handler */ + + /* Check if some tables need to be created */ + $this->check_config_table(); + + /* 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); /* check if all necessary indices exist */ $this->checkDbIndices(); @@ -107,15 +214,20 @@ class PHPFSPOT { $_SESSION['tag_condition'] = 'or'; if(!isset($_SESSION['sort_order'])) - $_SESSION['sort_order'] = 'date_asc'; + $_SESSION['sort_order'] = 'date_desc'; - if(!isset($_SESSION['searchfor'])) - $_SESSION['searchfor'] = ''; + if(!isset($_SESSION['searchfor_tag'])) + $_SESSION['searchfor_tag'] = ''; - // if begin_with is still set but rows_per_page is now 0, unset it - if(isset($_SESSION['begin_with']) && $this->cfg->rows_per_page == 0) + // if begin_with is still set but thumbs_per_page is now 0, unset it + 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() @@ -134,11 +246,16 @@ class PHPFSPOT { */ public function show() { - $this->tmpl->assign('searchfor', $_SESSION['searchfor']); + $this->tmpl->assign('searchfor_tag', $_SESSION['searchfor_tag']); $this->tmpl->assign('page_title', $this->cfg->page_title); $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']; @@ -165,10 +282,10 @@ class PHPFSPOT { $_SESSION['start_action'] = 'showp'; } if(isset($_GET['from_date']) && $this->isValidDate($_GET['from_date'])) { - $_SESSION['from_date'] = strtotime($_GET['from_date']); + $_SESSION['from_date'] = strtotime($_GET['from_date'] ." 00:00:00"); } if(isset($_GET['to_date']) && $this->isValidDate($_GET['to_date'])) { - $_SESSION['to_date'] = strtotime($_GET['to_date']); + $_SESSION['to_date'] = strtotime($_GET['to_date'] ." 23:59:59"); } break; case 'export': @@ -199,9 +316,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() @@ -284,6 +413,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) { @@ -340,6 +471,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) { @@ -360,6 +494,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) { @@ -377,8 +514,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); @@ -389,6 +528,7 @@ class PHPFSPOT { * * this function provides all the necessary information * for the single photo template. + * @param integer photo */ public function showPhoto($photo) { @@ -446,14 +586,18 @@ class PHPFSPOT { $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo); } - /* get f-spot database meta information */ - $meta = $this->get_meta_informations($orig_path); + /* get mime-type, height and width from the original photo */ + $info = getimagesize($orig_path); + + /* get EXIF information if JPEG */ + if($info['mime'] == "image/jpeg") { + $meta = $this->get_meta_informations($orig_path); + } /* If EXIF data are available, use them */ if(isset($meta['ExifImageWidth'])) { $meta_res = $meta['ExifImageWidth'] ."x". $meta['ExifImageLength']; } else { - $info = getimagesize($orig_path); $meta_res = $info[0] ."x". $info[1]; } @@ -472,31 +616,38 @@ class PHPFSPOT { $this->tmpl->assign('extern_link', $extern_link); - if(file_exists($thumb_path)) { - - $info = getimagesize($thumb_path); + if(!file_exists($thumb_path)) { + $this->_error("Can't open file ". $thumb_path ."\n"); + return; + } - $this->tmpl->assign('description', $details['description']); - $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename')); + $info_thumb = getimagesize($thumb_path); - $this->tmpl->assign('width', $info[0]); - $this->tmpl->assign('height', $info[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); + $this->tmpl->assign('description', $details['description']); + $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename')); - $this->tmpl->assign('tags', $this->get_photo_tags($photo)); - $this->tmpl->assign('current', $current); + $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); + + 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->_error("Can't open file ". $thumb_path ."\n"); - return; + $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)); + $this->tmpl->assign('current_page', $this->getCurrentPage($current, $count)); + $this->tmpl->assign('current_img', $photo); + if($previous_img) { $this->tmpl->assign('previous_url', "javascript:showImage(". $previous_img .");"); $this->tmpl->assign('prev_img', $previous_img); @@ -507,10 +658,11 @@ class PHPFSPOT { $this->tmpl->assign('next_img', $next_img); } $this->tmpl->assign('mini_width', $this->cfg->mini_width); + $this->tmpl->assign('photo_width', $this->cfg->photo_width); $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() @@ -547,6 +699,10 @@ class PHPFSPOT { $max_size = 125; // max font size in % $min_size = 75; // min font size in % + // color + $max_sat = hexdec('cc'); + $min_sat = hexdec('44'); + // get the largest and smallest array values $max_qty = max(array_values($tags)); $min_qty = min(array_values($tags)); @@ -560,6 +716,7 @@ class PHPFSPOT { // determine the font-size increment // this is the increase per tag quantity (times used) $step = ($max_size - $min_size)/($spread); + $step_sat = ($max_sat - $min_sat)/($spread); // loop through our tag array foreach ($tags as $key => $value) { @@ -575,14 +732,22 @@ class PHPFSPOT { // uncomment if you want sizes in whole %: $size = ceil($size); + $color = $min_sat + ($value - $min_qty) * $step_sat; + + $r = '44'; + $g = dechex($color); + $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() @@ -592,8 +757,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(); @@ -604,7 +770,29 @@ 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.= " +
+
+ tags[$tag] ."\"> + cfg->web_path ."/phpfspot_img.php?tagidx=". $tag ."\" /> + +
+
+ tags[$tag] ."\"> + cfg->web_path ."/resources/underbar.png\" /> + +
+
+ "; + break; + } } } @@ -624,17 +812,26 @@ 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) { if(!isset($_SESSION['selected_tags'])) $_SESSION['selected_tags'] = Array(); - if(isset($_SESSION['searchfor'])) - unset($_SESSION['searchfor']); + 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() @@ -643,11 +840,13 @@ class PHPFSPOT { * * this function removes the specified tag from * users current tag selection + * @param string $tag + * @return string */ public function delTag($tag) { - if(isset($_SESSION['searchfor'])) - unset($_SESSION['searchfor']); + if(isset($_SESSION['searchfor_tag'])) + unset($_SESSION['searchfor_tag']); if(isset($_SESSION['selected_tags'])) { $key = array_search($tag, $_SESSION['selected_tags']); @@ -655,6 +854,8 @@ class PHPFSPOT { sort($_SESSION['selected_tags']); } + return "ok"; + } // delTag() /** @@ -670,6 +871,58 @@ class PHPFSPOT { } // resetTags() + /** + * returns the value for the autocomplete tag-search + * @return string + */ + public function get_xml_tag_list() + { + if(!isset($_GET['search']) || !is_string($_GET['search'])) + $_GET['search'] = ''; + + $length = 15; + $i = 1; + + /* retrive tags from database */ + $this->get_tags(); + + $matched_tags = Array(); + + header("Content-Type: text/xml"); + + $string = "\n"; + $string.= "\n"; + + foreach($this->avail_tags as $tag) + { + if(!empty($_GET['search']) && + preg_match("/". $_GET['search'] ."/i", $this->tags[$tag]) && + count($matched_tags) < $length) { + + $count = $this->get_num_photos($tag); + + if($count == 1) { + $string.= " ". $this->tags[$tag] ."\n"; + } + else { + $string.= " ". $this->tags[$tag] ."\n"; + + } + $i++; + } + + /* if we have collected enough items, break out */ + if(count($matched_tags) >= $length) + break; + } + + $string.= "\n"; + + return $string; + + } // get_xml_tag_list() + + /** * reset single photo * @@ -686,17 +939,28 @@ class PHPFSPOT { /** * reset tag search * - * if any tag search has taken place, reset - * it now + * if any tag search has taken place, reset it now */ public function resetTagSearch() { - if(isset($_SESSION['searchfor'])) - unset($_SESSION['searchfor']); + if(isset($_SESSION['searchfor_tag'])) + unset($_SESSION['searchfor_tag']); } // resetTagSearch() - /** + /** + * reset name search + * + * if any name search has taken place, reset it now + */ + public function resetNameSearch() + { + if(isset($_SESSION['searchfor_name'])) + unset($_SESSION['searchfor_name']); + + } // resetNameSearch() + + /** * reset date search * * if any date search has taken place, reset @@ -718,41 +982,64 @@ 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() { $matched_photos = Array(); + $additional_where_cond = ""; if(isset($_SESSION['from_date']) && isset($_SESSION['to_date'])) { $from_date = $_SESSION['from_date']; $to_date = $_SESSION['to_date']; - $additional_where_cond = " + $additional_where_cond.= " p.time>='". $from_date ."' AND p.time<='". $to_date ."' "; } + if(isset($_SESSION['searchfor_name'])) { + if($this->dbver < 9) { + $additional_where_cond.= " + ( + p.name LIKE '%". $_SESSION['searchfor_name'] ."%' + OR + p.description LIKE '%". $_SESSION['searchfor_name'] ."%' + ) + "; + } + else { + $additional_where_cond.= " + ( + basename(p.uri) LIKE '%". $_SESSION['searchfor_name'] ."%' + OR + p.description LIKE '%". $_SESSION['searchfor_name'] ."%' + ) + "; + } + } + if(isset($_SESSION['sort_order'])) { $order_str = $this->get_sort_order(); } /* return a search result */ - if(isset($_SESSION['searchfor']) && $_SESSION['searchfor'] != '') { + if(isset($_SESSION['searchfor_tag']) && $_SESSION['searchfor_tag'] != '') { $query_str = " SELECT DISTINCT pt1.photo_id FROM photo_tags pt1 INNER JOIN photo_tags pt2 ON pt1.photo_id=pt2.photo_id - INNER JOIN tags t1 - ON pt1.tag_id=t1.id + INNER JOIN tags t + ON pt1.tag_id=t.id INNER JOIN photos p ON pt1.photo_id=p.id INNER JOIN tags t2 ON pt2.tag_id=t2.id - WHERE t1.name LIKE '%". $_SESSION['searchfor'] ."%' "; + WHERE t.name LIKE '%". $_SESSION['searchfor_tag'] ."%' "; - if(isset($additional_where_cond)) + if(isset($additional_where_cond) && !empty($additional_where_cond)) $query_str.= "AND ". $additional_where_cond ." "; if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { @@ -789,7 +1076,7 @@ class PHPFSPOT { ON pt1.photo_id=p.id WHERE pt1.tag_id IN (". $selected .") "; - if(isset($additional_where_cond)) + if(isset($additional_where_cond) && !empty($additional_where_cond)) $query_str.= "AND ". $additional_where_cond ." "; if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { @@ -845,7 +1132,7 @@ class PHPFSPOT { AND pt". ($i+2) .".tag_id=". $_SESSION['selected_tags'][$i] ." "; } - if(isset($additional_where_cond)) + if(isset($additional_where_cond) && !empty($additional_where_cond)) $query_str.= "AND ". $additional_where_cond; if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { @@ -866,7 +1153,7 @@ class PHPFSPOT { /* return all available photos */ $query_str = " - SELECT p.id + SELECT DISTINCT p.id FROM photos p LEFT JOIN photo_tags pt ON p.id=pt.photo_id @@ -874,11 +1161,14 @@ class PHPFSPOT { ON pt.tag_id=t.id "; - if(isset($additional_where_cond)) + if(isset($additional_where_cond) && !empty($additional_where_cond)) $query_str.= "WHERE ". $additional_where_cond ." "; if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { - $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')"; + if(isset($additional_where_cond) && !empty($additional_where_cond)) + $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')"; + else + $query_str.= "WHERE t.name IN ('".implode("','",$this->cfg->show_tags). "')"; } if(isset($order_str)) @@ -897,6 +1187,7 @@ class PHPFSPOT { * * this function provides all the necessary information * for the photo index template. + * @return string */ public function showPhotoIndex() { @@ -904,85 +1195,59 @@ class PHPFSPOT { $count = count($photos); - if(isset($_SESSION['begin_with']) && $_SESSION['begin_with'] != "") - $anchor = $_SESSION['begin_with']; - - if(!isset($this->cfg->rows_per_page) || $this->cfg->rows_per_page == 0) { - + /* if all thumbnails should be shown on one page */ + if(!isset($this->cfg->thumbs_per_page) || $this->cfg->thumbs_per_page == 0) { $begin_with = 0; $end_with = $count; - } - elseif($this->cfg->rows_per_page > 0) { + /* thumbnails should be splitted up in several pages */ + elseif($this->cfg->thumbs_per_page > 0) { if(!isset($_SESSION['begin_with']) || $_SESSION['begin_with'] == 0) { $begin_with = 0; } else { - $begin_with = $_SESSION['begin_with']; - - // verify $begin_with - perhaps the thumbs-per-rows or - // rows-per-page variables have changed or the jump back - // from a photo wasn't exact - so calculate the real new - // starting point - $multiplicator = $this->cfg->rows_per_page * $this->cfg->thumbs_per_row; - for($i = 0; $i <= $count; $i+=$multiplicator) { - if($begin_with >= $i && $begin_with < $i+$multiplicator) { - $begin_with = $i; - break; - } - } } - $end_with = $begin_with + ($this->cfg->rows_per_page * $this->cfg->thumbs_per_row); + $end_with = $begin_with + $this->cfg->thumbs_per_page; } - - $rows = 0; - $cols = 0; - $images[$rows] = Array(); - $img_height[$rows] = Array(); - $img_width[$rows] = Array(); - $img_id[$rows] = Array(); - $img_name[$rows] = Array(); + $thumbs = 0; + $images[$thumbs] = Array(); + $img_height[$thumbs] = Array(); + $img_width[$thumbs] = Array(); + $img_id[$thumbs] = Array(); + $img_name[$thumbs] = Array(); + $img_fullname[$thumbs] = Array(); $img_title = Array(); for($i = $begin_with; $i < $end_with; $i++) { if(isset($photos[$i])) { - $images[$rows][$cols] = $photos[$i]; - $img_id[$rows][$cols] = $i; - $img_name[$rows][$cols] = htmlspecialchars($this->getPhotoName($photos[$i], 15)); - $img_title[$rows][$cols] = "Click to view photo ". htmlspecialchars($this->getPhotoName($photos[$i], 0)); + $images[$thumbs] = $photos[$i]; + $img_id[$thumbs] = $i; + $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)); $thumb_path = $this->get_thumb_path($this->cfg->thumb_width, $photos[$i]); if(file_exists($thumb_path)) { $info = getimagesize($thumb_path); - $img_width[$rows][$cols] = $info[0]; - $img_height[$rows][$cols] = $info[1]; - } - - if($cols == $this->cfg->thumbs_per_row-1) { - $cols = 0; - $rows++; - $images[$rows] = Array(); - $img_width[$rows] = Array(); - $img_height[$rows] = Array(); - } - else { - $cols++; + $img_width[$thumbs] = $info[0]; + $img_height[$thumbs] = $info[1]; } + $thumbs++; } } // +1 for for smarty's selection iteration - $rows++; + $thumbs++; - if(isset($_SESSION['searchfor']) && $_SESSION['searchfor'] != '') - $this->tmpl->assign('searchfor', $_SESSION['searchfor']); + if(isset($_SESSION['searchfor_tag']) && $_SESSION['searchfor_tag'] != '') + $this->tmpl->assign('searchfor_tag', $_SESSION['searchfor_tag']); if(isset($_SESSION['from_date']) && isset($_SESSION['to_date'])) { $this->tmpl->assign('from_date', $this->ts2str($_SESSION['from_date'])); @@ -994,20 +1259,20 @@ class PHPFSPOT { } /* do we have to display the page selector ? */ - if($this->cfg->rows_per_page != 0) { + if($this->cfg->thumbs_per_page != 0) { $page_select = ""; /* calculate the page switchers */ - $previous_start = $begin_with - ($this->cfg->rows_per_page * $this->cfg->thumbs_per_row); - $next_start = $begin_with + ($this->cfg->rows_per_page * $this->cfg->thumbs_per_row); + $previous_start = $begin_with - $this->cfg->thumbs_per_page; + $next_start = $begin_with + $this->cfg->thumbs_per_page; if($begin_with != 0) $this->tmpl->assign("previous_url", "javascript:showPhotoIndex(". $previous_start .");"); if($end_with < $count) $this->tmpl->assign("next_url", "javascript:showPhotoIndex(". $next_start .");"); - $photo_per_page = $this->cfg->rows_per_page * $this->cfg->thumbs_per_row; + $photo_per_page = $this->cfg->thumbs_per_page; $last_page = ceil($count / $photo_per_page); /* get the current selected page */ @@ -1034,7 +1299,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 ." "; @@ -1072,7 +1346,6 @@ class PHPFSPOT { if($last_page > 1) $this->tmpl->assign('page_selector', $page_select); } - $current_tags = $this->getCurrentTags(); $extern_link = "index.php?mode=showpi"; @@ -1095,21 +1368,31 @@ class PHPFSPOT { $this->tmpl->assign('rss_link', $rss_link); $this->tmpl->assign('count', $count); $this->tmpl->assign('width', $this->cfg->thumb_width); - $this->tmpl->assign('thumb_container_width', $this->cfg->thumb_width+20); - $this->tmpl->assign('thumb_container_height', $this->cfg->thumb_height); + $this->tmpl->assign('preview_width', $this->cfg->photo_width); + $this->tmpl->assign('thumb_container_width', $this->cfg->thumb_width); + $this->tmpl->assign('thumb_container_height', $this->cfg->thumb_height+20); $this->tmpl->assign('images', $images); $this->tmpl->assign('img_width', $img_width); $this->tmpl->assign('img_height', $img_height); $this->tmpl->assign('img_id', $img_id); $this->tmpl->assign('img_name', $img_name); + $this->tmpl->assign('img_fullname', $img_fullname); $this->tmpl->assign('img_title', $img_title); - $this->tmpl->assign('rows', $rows); - $this->tmpl->assign('columns', $this->cfg->thumbs_per_row); + $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(isset($anchor)) - print "\n"; + /* 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'])) { + $result.= "\n"; + unset($_SESSION['last_photo']); + } + + return $result; } // showPhotoIndex() @@ -1126,12 +1409,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) { @@ -1139,56 +1426,102 @@ 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; - $meta = $this->get_meta_informations($orig_image); + switch($mime) { + + case 'image/jpeg': + + $meta = $this->get_meta_informations($orig_image); + + $rotate = 0; + $flip_hori = false; + $flip_vert = false; + + switch($meta['Orientation']) { + case 1: /* top, left */ + /* nothing to do */ break; + case 2: /* top, right */ + $rotate = 0; $flip_hori = true; break; + case 3: /* bottom, left */ + $rotate = 180; break; + case 4: /* bottom, right */ + $flip_vert = true; break; + case 5: /* left side, top */ + $rotate = 90; $flip_vert = true; break; + case 6: /* right side, top */ + $rotate = 90; break; + case 7: /* left side, bottom */ + $rotate = 270; $flip_vert = true; break; + case 8: /* right side, bottom */ + $rotate = 270; break; + } - $rotate = 0; - $flip = false; + $src_img = @imagecreatefromjpeg($orig_image); + $handler = "gd"; + break; - switch($meta['Orientation']) { + case 'image/png': - case 1: /* top, left */ - $rotate = 0; $flip = false; break; - case 2: /* top, right */ - $rotate = 0; $flip = true; break; - case 3: /* bottom, left */ - $rotate = 180; $flip = false; break; - case 4: /* bottom, right */ - $rotate = 180; $flip = true; break; - case 5: /* left side, top */ - $rotate = 90; $flip = true; break; - case 6: /* right side, top */ - $rotate = 90; $flip = false; break; - case 7: /* left side, bottom */ - $rotate = 270; $flip = true; break; - case 8: /* right side, bottom */ - $rotate = 270; $flip = false; break; - } + $src_img = @imagecreatefrompng($orig_image); + $handler = "gd"; + break; - $src_img = @imagecreatefromjpeg($orig_image); + case 'image/x-portable-pixmap': - if(!$src_img) { + $src_img = new Imagick($orig_image); + $handler = "imagick"; + break; + + } + + 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 @@ -1230,46 +1563,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) { - print "(FLIP)"; - $image = $dst_img; - for($x = 0; $x < $new_w; $x++) { - imagecopy($dst_img, $image, $x, 0, $w - $x - 1, 0, 1, $h); - } - } + 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)); - /* write down new generated file */ - $result = imagejpeg($dst_img, $thumb_image, 75); + /* 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'); + } - /* free your mind */ - imagedestroy($dst_img); - imagedestroy($src_img); + if($rotate) { + $this->_debug("(ROTATE)"); + $dst_img = $this->rotateImage($dst_img, $rotate); + } - if($result === false) { - print "Can't write thumbnail ". $thumb_image ."\n"; - return false; - } + /* write down new generated file */ + $result = imagejpeg($dst_img, $thumb_image, 75); - return true; + /* free your mind */ + imagedestroy($dst_img); + imagedestroy($src_img); + + 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) { @@ -1308,6 +1689,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) { @@ -1317,6 +1701,7 @@ class PHPFSPOT { $this->cfg->thumb_width, $this->cfg->photo_width, $this->cfg->mini_width, + 30, ); /* get details from F-Spot's database */ @@ -1335,10 +1720,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) { @@ -1348,6 +1750,7 @@ class PHPFSPOT { $thumb_sub_path = substr($file_md5, 0, 2); $thumb_path = $this->cfg->thumb_path ."/". $thumb_sub_path ."/". $resolution ."_". $file_md5; + /* if thumbnail-subdirectory does not exist yet, create it */ if(!file_exists(dirname($thumb_path))) { mkdir(dirname($thumb_path), 0755); } @@ -1389,6 +1792,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) { @@ -1408,6 +1813,8 @@ class PHPFSPOT { /** * set MD5 sum for the specific photo + * @param integer $idx + * @param string $md5 */ private function setMD5($idx, $md5) { @@ -1423,11 +1830,15 @@ 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) { $_SESSION['tag_condition'] = $mode; + return "ok"; + } // setTagCondition() /** @@ -1438,30 +1849,50 @@ class PHPFSPOT { * it also handles the date search. * getPhotoSelection() will then only return the matching * photos. + * @return string */ - public function startSearch($searchfor, $from = 0, $to = 0) + public function startSearch() { + if(isset($_POST['from']) && $this->isValidDate($_POST['from'])) { + $from = $_POST['from']; + } + if(isset($_POST['to']) && $this->isValidDate($_POST['to'])) { + $to = $_POST['to']; + } + + if(isset($_POST['for_tag']) && is_string($_POST['for_tag'])) { + $searchfor_tag = $_POST['for_tag']; + $_SESSION['searchfor_tag'] = $_POST['for_tag']; + } + + if(isset($_POST['for_name']) && is_string($_POST['for_name'])) { + $searchfor_name = $_POST['for_name']; + $_SESSION['searchfor_name'] = $_POST['for_name']; + } + $this->get_tags(); - $_SESSION['searchfor'] = $searchfor; - if($from != 0) - $_SESSION['from_date'] = strtotime($from); + if(isset($from) && !empty($from)) + $_SESSION['from_date'] = strtotime($from ." 00:00:00"); else unset($_SESSION['from_date']); - if($to != 0) - $_SESSION['to_date'] = strtotime($to); + + if(isset($to) && !empty($to)) + $_SESSION['to_date'] = strtotime($to ." 23:59:59"); else unset($_SESSION['to_date']); - if($searchfor != "") { + if(isset($searchfor_tag) && !empty($searchfor_tag)) { /* new search, reset the current selected tags */ $_SESSION['selected_tags'] = Array(); foreach($this->avail_tags as $tag) { - if(preg_match('/'. $searchfor .'/i', $this->tags[$tag])) + if(preg_match('/'. $searchfor_tag .'/i', $this->tags[$tag])) array_push($_SESSION['selected_tags'], $tag); } } + return "ok"; + } // startSearch() /** @@ -1469,6 +1900,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) { @@ -1486,6 +1919,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) { @@ -1558,8 +1994,42 @@ class PHPFSPOT { } // rotateImage() + /** + * returns flipped image + * + * 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) + { + $w = imagesx($image); + $h = imagesy($image); + $flipped = imagecreatetruecolor($w, $h); + + switch($mode) { + case 'vert': + for ($y = 0; $y < $h; $y++) { + imagecopy($flipped, $image, 0, $y, 0, $h - $y - 1, $w, 1); + } + break; + case 'hori': + for ($x = 0; $x < $w; $x++) { + imagecopy($flipped, $image, $x, 0, $w - $x - 1, 0, 1, $h); + } + break; + } + + return $flipped; + + } // flipImage() + /** * return all assigned tags for the specified photo + * @param integer $idx + * @return array */ private function get_photo_tags($idx) { @@ -1573,8 +2043,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; @@ -1582,6 +2055,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) { @@ -1611,8 +2089,9 @@ class PHPFSPOT { /** * check if all requirements are met + * @return boolean */ - private function checkRequirements() + private function check_requirements() { if(!function_exists("imagecreatefromjpeg")) { print "PHP GD library extension is missing
\n"; @@ -1641,6 +2120,11 @@ class PHPFSPOT { print "PEAR Console_Getopt package is missing
\n"; $missing = true; } + @include_once $this->cfg->smarty_path .'/libs/Smarty.class.php'; + if(isset($php_errormsg) && preg_match('/Failed opening.*for inclusion/i', $php_errormsg)) { + print "Smarty template engine can not be found in ". $this->cfg->smarty_path ."/libs/Smarty.class.php
\n"; + $missing = true; + } ini_restore('track_errors'); if(isset($missing)) @@ -1648,7 +2132,7 @@ class PHPFSPOT { return true; - } // checkRequirements() + } // check_requirements() private function _debug($text) { @@ -1660,22 +2144,36 @@ 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"))) + $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) { + default: case 'display': print "\"warning\"\n"; - print $text; + print $text ."
\n"; break; case 'errorlog': error_log($text); @@ -1685,10 +2183,14 @@ class PHPFSPOT { break; } + $this->runtime_error = true; + } // _error() /** * output calendard input fields + * @param string $mode + * @return string */ private function get_calendar($mode) { @@ -1715,6 +2217,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) { @@ -1793,6 +2298,7 @@ class PHPFSPOT { /** * output export page + * @param string $mode */ public function getExport($mode) { @@ -1801,7 +2307,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; } @@ -1809,7 +2315,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) { @@ -1858,7 +2369,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; } @@ -1868,14 +2379,25 @@ 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("
". $details['description']); $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath')); - $meta = $this->get_meta_informations($orig_path); + + /* get EXIF information if JPEG */ + if($details['mime'] == "image/jpeg") { + $meta = $this->get_meta_informations($orig_path); + } + $meta_date = isset($meta['FileDateTime']) ? $meta['FileDateTime'] : filemtime($orig_path); ?> @@ -1903,6 +2425,7 @@ class PHPFSPOT { /** * return all selected tags as one string + * @return array */ private function getCurrentTags() { @@ -1934,11 +2457,11 @@ 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() { if(isset($_SESSION['current_photo']) && $_SESSION['start_action'] == 'showp') { - return "show_photo"; } elseif(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags'])) { return "showpi_tags"; @@ -1947,12 +2470,11 @@ class PHPFSPOT { return "showpi"; } - return "nothing special"; - } // whatToDo() /** * return the current process-user + * @return string */ private function getuid() { @@ -1968,6 +2490,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) { @@ -1987,6 +2512,7 @@ class PHPFSPOT { /** * returns the currently selected sort order + * @return string */ private function get_sort_order() { @@ -2013,16 +2539,23 @@ class PHPFSPOT { return " ORDER BY basename(p.uri) DESC"; } break; + case 'tags_asc': + return " ORDER BY t.name ASC ,p.time ASC"; + break; + case 'tags_desc': + return " ORDER BY t.name DESC ,p.time ASC"; + break; } } // 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(); @@ -2032,16 +2565,21 @@ class PHPFSPOT { else $_SESSION['slideshow_img']++; - return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width; + if($this->is_user_friendly_url()) { + return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width; + } + + return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width; } // 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(); @@ -2051,7 +2589,11 @@ class PHPFSPOT { else $_SESSION['slideshow_img']--; - return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width; + if($this->is_user_friendly_url()) { + return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width; + } + + return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width; } // getPrevSlideShowImage() @@ -2059,27 +2601,44 @@ class PHPFSPOT { { if(isset($_SESSION['slideshow_img'])) unset($_SESSION['slideshow_img']); + } // 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(); - $result = $this->db->db_query(" - SELECT id - FROM photos - "); - + $query_str = " + SELECT p.id + FROM photos p + "; + + /* if show_tags is set, only return details for photos which + are specified to be shown + */ + if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { + $query_str.= " + INNER JOIN photo_tags pt + ON p.id=pt.photo_id + INNER JOIN tags t + ON pt.tag_id=t.id + WHERE + t.name IN ('".implode("','",$this->cfg->show_tags)."')"; + } + + $result = $this->db->db_query($query_str); + while($row = $this->db->db_fetch_object($result)) { array_push($all, $row['id']); } @@ -2088,12 +2647,64 @@ class PHPFSPOT { } // get_random_photo() + /** + * get random photo tag photo + * + * this function will get all photos tagged with the requested + * tag 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_tag_photo($tagidx) + { + $all = Array(); + + $query_str = " + SELECT p.id + FROM photos p + INNER JOIN photo_tags pt + ON p.id=pt.photo_id + "; + + if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { + $query_str.= " + INNER JOIN tags t + ON pt.tag_id=t.id + "; + } + $query_str.= " + WHERE + pt.tag_id LIKE '". $tagidx ."' + "; + + /*if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) { + $query_str.= " + AND + t.name IN ('".implode("','",$this->cfg->show_tags)."') + "; + }*/ + + $result = $this->db->db_query($query_str); + + while($row = $this->db->db_fetch_object($result)) { + array_push($all, $row['id']); + } + + return $all[array_rand($all)]; + + } // get_random_tag_photo() + /** * validates provided date * * 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) { @@ -2108,15 +2719,24 @@ class PHPFSPOT { /** * timestamp to string conversion + * @param integer $timestamp + * @return string */ private function ts2str($timestamp) { - return strftime("%Y-%m-%d", $timestamp); + if(!empty($timestamp) && is_numeric($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) { @@ -2130,6 +2750,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) { @@ -2147,6 +2770,7 @@ class PHPFSPOT { /** * returns server's virtual host name + * @return string */ private function get_server_name() { @@ -2154,8 +2778,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() { @@ -2167,11 +2791,34 @@ class PHPFSPOT { /** * return url to this phpfspot installation + * @return string */ private function get_phpfspot_url() { return $this->get_web_protocol() ."://". $this->get_server_name() . $this->cfg->web_path; + } // get_phpfspot_url() + + /** + * returns the number of photos which are tagged with $tag_id + * @param integer $tag_id + * @return integer + */ + public function get_num_photos($tag_id) + { + if($result = $this->db->db_fetchSingleRow(" + SELECT count(*) as number + FROM photo_tags + WHERE + tag_id LIKE '". $tag_id ."'")) { + + return $result['number']; + + } + + return 0; + + } // get_num_photos() /** * check file exists and is readable @@ -2179,6 +2826,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) { @@ -2223,6 +2873,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() { @@ -2239,8 +2890,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) { @@ -2263,6 +2916,279 @@ class PHPFSPOT { } // parse_uri() + /** + * validate config options + * + * this function checks if all necessary configuration options are + * specified and set. + * @return boolean + */ + private function check_config_options() + { + if(!isset($this->cfg->page_title) || $this->cfg->page_title == "") + $this->_error("Please set \$page_title in phpfspot_cfg"); + + if(!isset($this->cfg->base_path) || $this->cfg->base_path == "") + $this->_error("Please set \$base_path in phpfspot_cfg"); + + if(!isset($this->cfg->web_path) || $this->cfg->web_path == "") + $this->_error("Please set \$web_path in phpfspot_cfg"); + + if(!isset($this->cfg->thumb_path) || $this->cfg->thumb_path == "") + $this->_error("Please set \$thumb_path in phpfspot_cfg"); + + if(!isset($this->cfg->smarty_path) || $this->cfg->smarty_path == "") + $this->_error("Please set \$smarty_path in phpfspot_cfg"); + + if(!isset($this->cfg->fspot_db) || $this->cfg->fspot_db == "") + $this->_error("Please set \$fspot_db in phpfspot_cfg"); + + if(!isset($this->cfg->db_access) || $this->cfg->db_access == "") + $this->_error("Please set \$db_access in phpfspot_cfg"); + + if(!isset($this->cfg->phpfspot_db) || $this->cfg->phpfspot_db == "") + $this->_error("Please set \$phpfspot_db in phpfspot_cfg"); + + if(!isset($this->cfg->thumb_width) || $this->cfg->thumb_width == "") + $this->_error("Please set \$thumb_width in phpfspot_cfg"); + + if(!isset($this->cfg->thumb_height) || $this->cfg->thumb_height == "") + $this->_error("Please set \$thumb_height in phpfspot_cfg"); + + if(!isset($this->cfg->photo_width) || $this->cfg->photo_width == "") + $this->_error("Please set \$photo_width in phpfspot_cfg"); + + if(!isset($this->cfg->mini_width) || $this->cfg->mini_width == "") + $this->_error("Please set \$mini_width in phpfspot_cfg"); + + if(!isset($this->cfg->thumbs_per_page)) + $this->_error("Please set \$thumbs_per_page in phpfspot_cfg"); + + if(!isset($this->cfg->path_replace_from) || $this->cfg->path_replace_from == "") + $this->_error("Please set \$path_replace_from in phpfspot_cfg"); + + if(!isset($this->cfg->path_replace_to) || $this->cfg->path_replace_to == "") + $this->_error("Please set \$path_replace_to in phpfspot_cfg"); + + if(!isset($this->cfg->hide_tags)) + $this->_error("Please set \$hide_tags in phpfspot_cfg"); + + if(!isset($this->cfg->theme_name)) + $this->_error("Please set \$theme_name in phpfspot_cfg"); + + if(!isset($this->cfg->logging)) + $this->_error("Please set \$logging in phpfspot_cfg"); + + if(isset($this->cfg->logging) && $this->cfg->logging == 'logfile') { + + if(!isset($this->cfg->log_file)) + $this->_error("Please set \$log_file because you set logging = log_file in phpfspot_cfg"); + + if(!is_writeable($this->cfg->log_file)) + $this->_error("The specified \$log_file ". $log_file ." is not writeable!"); + + } + + /* remove trailing slash, if set */ + if($this->cfg->web_path == "/") + $this->cfg->web_path = ""; + elseif(preg_match('/\/$/', $this->cfg->web_path)) + $this->cfg->web_path = preg_replace('/\/$/', '', $this->cfg->web_path); + + return $this->runtime_error; + + } // check_config_options() + + /** + * cleanup phpfspot own database + * + * When photos are getting delete from F-Spot, there will remain + * remain some residues in phpfspot own database. This function + * will try to wipe them out. + */ + public function cleanup_phpfspot_db() + { + $to_delete = Array(); + + $result = $this->cfg_db->db_query(" + SELECT img_idx + FROM images + ORDER BY img_idx ASC + "); + + while($row = $this->cfg_db->db_fetch_object($result)) { + if(!$this->db->db_fetchSingleRow(" + SELECT id + FROM photos + WHERE id='". $row['img_idx'] ."'")) { + + array_push($to_delete, $row['img_idx'], ','); + } + } + + print count($to_delete) ." unnecessary objects will be removed from phpfspot's database.\n"; + + $this->cfg_db->db_exec(" + DELETE FROM images + WHERE img_idx IN (". implode($to_delete) .") + "); + + } // cleanup_phpfspot_db() + + /** + * return first image of the page, the $current photo + * lies in. + * + * this function is used to find out the first photo of the + * 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) + { + if(isset($this->cfg->thumbs_per_page) && !empty($this->cfg->thumbs_per_page)) { + for($page_start = 0; $page_start <= $max; $page_start+=$this->cfg->thumbs_per_page) { + if($current >= $page_start && $current < ($page_start+$this->cfg->thumbs_per_page)) + return $page_start; + } + } + return 0; + + } // getCurrentPage() + + /** + * return mime info + * + * this function tries to find out the correct mime-type + * for the provided file. + * @param string $file + * @return string + */ + public function get_mime_info($file) + { + $details = getimagesize($file); + + /* if getimagesize() returns empty, try at least to find out the + mime type. + */ + if(empty($details) && function_exists('mime_content_type')) { + + // mime_content_type is marked as deprecated in the documentation, + // but is it really necessary to force users to install a PECL + // extension? + $details['mime'] = mime_content_type($file); + } + + return $details['mime']; + + } // get_mime_info() + + /** + * return tag-name by tag-idx + * + * this function returns the tag-name for the requested + * tag specified by tag-idx. + * @param integer $idx + * @return string + */ + public function get_tag_name($idx) + { + if($result = $this->db->db_fetchSingleRow(" + SELECT name + FROM tags + WHERE + id LIKE '". $idx ."'")) { + + return $result['name']; + + } + + return 0; + + } // get_tag_name() + + /** + * parse user friendly url which got rewritten by the websever + * @param string $request_uri + * @return string + */ + private function parse_user_friendly_url($request_uri) + { + if(preg_match('/\/photoview\/|\/photo\/|\/tag\//', $request_uri)) { + + unset($_SESSION['start_action']); + unset($_SESSION['selected_tags']); + + $options = explode('/', $request_uri); + + switch($options[1]) { + case 'photoview': + if(is_numeric($options[2])) { + $_GET['mode'] = 'showp'; + return $this->showPhoto($options[2]); + } + break; + case 'photo': + if(is_numeric($options[2])) { + require_once "phpfspot_img.php"; + $img = new PHPFSPOT_IMG; + if(isset($options[3]) && is_numeric($options[3])) + $img->showImg($options[2], $options[3]); + else + $img->showImg($options[2]); + } + exit; + break; + case 'tag': + if(is_numeric($options[2])) { + $this->session_cleanup(); + $_GET['tags'] = $options[2]; + $_SESSION['selected_tags'] = Array($options[2]); + if(isset($options[3]) && is_numeric($options[3])) + $_SESSION['begin_with'] = $options[3]; + return $this->showPhotoIndex(); + } + break; + } + } + + } // parse_user_friendly_url() + + /** + * check if user-friendly-urls are enabled + * + * this function will return true, if the config option + * $user_friendly_url has been set. Otherwise false. + * @return boolean + */ + private function is_user_friendly_url() + { + if(isset($this->cfg->user_friendly_url) && $this->cfg->user_friendly_url) + return true; + + return false; + + } // is_user_friendly_url() + + /** + * session cleanup + * + * this function will cleanup user's session information + */ + private function session_cleanup() + { + unset($_SESSION['begin_with']); + $this->resetDateSearch(); + $this->resetPhotoView(); + $this->resetTagSearch(); + $this->resetNameSearch(); + $this->resetDateSearch(); + + } // session_cleanup() + } // class PHPFSPOT ?>