<?php
+/***************************************************************************
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *
+ ***************************************************************************/
+
require_once "phpfspot_cfg.php";
require_once "phpfspot_db.php";
-require_once "phpfspot_tmpl.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;
- var $current_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 ($cfg, $db, $cfg_db, $tmpl, $db_ver)
+ *
+ * this function will be called on class construct
+ * and will check requirements, loads configuration,
+ * open databases and start the user session
+ */
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.5";
+
+ $this->sort_orders= array(
+ 'date_asc' => 'Date ↑',
+ 'date_desc' => 'Date ↓',
+ 'name_asc' => 'Name ↑',
+ 'name_desc' => 'Name ↓',
+ 'tags_asc' => 'Tags ↑',
+ 'tags_desc' => 'Tags ↓',
+ );
+
/* Check necessary requirements */
- if(!$this->checkRequirements()) {
+ if(!$this->check_requirements()) {
exit(1);
}
- $this->cfg = new PHPFSPOT_CFG;
+ /******* 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);
+ }
+
+ /* open the database */
+ $this->db = new PHPFSPOT_DB($this, $this->cfg->fspot_db);
+
+ /* 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);
+ }
+
+ 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 *********/
- $this->db = new PHPFSPOT_DB(&$this, $this->cfg->fspot_db);
- $this->cfg_db = new PHPFSPOT_DB(&$this, $this->cfg->phpfspot_db);
+ /* 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);
+ }
+
+ /* open the database */
+ $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);
+
+ /* 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 ."'
+ ");
+ }
+
+ /* Check if some tables need to be created */
$this->check_config_table();
- $this->tmpl = new PHPFSPOT_TMPL($this);
+ /* overload Smarty class with our own template handler */
+ require_once "phpfspot_tmpl.php";
+ $this->tmpl = new PHPFSPOT_TMPL();
- $this->get_tags();
+ /* check if all necessary indices exist */
+ $this->checkDbIndices();
- session_start();
+ /* if session is not yet started, do it now */
+ if(session_id() == "")
+ session_start();
if(!isset($_SESSION['tag_condition']))
$_SESSION['tag_condition'] = 'or';
- if(!isset($_SESSION['searchfor']))
- $_SESSION['searchfor'] = '';
+ if(!isset($_SESSION['sort_order']))
+ $_SESSION['sort_order'] = 'date_desc';
- // 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(!isset($_SESSION['searchfor_tag']))
+ $_SESSION['searchfor_tag'] = '';
+
+ // 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']);
} // __construct()
} // __destruct()
+ /**
+ * show - generate html output
+ *
+ * this function can be called after the constructor has
+ * prepared everyhing. it will load the index.tpl smarty
+ * template. if necessary it will registere pre-selects
+ * (photo index, photo, tag search, date search) into
+ * users session.
+ */
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);
- switch($_GET['mode']) {
- case 'showpi':
- if(isset($_GET['tags'])) {
- $_SESSION['selected_tags'] = split(',', $_GET['tags']);
- }
- break;
+ if(isset($_GET['mode'])) {
+
+ $_SESSION['start_action'] = $_GET['mode'];
+
+ switch($_GET['mode']) {
+ case 'showpi':
+ if(isset($_GET['tags'])) {
+ $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);
+ }
+ if(isset($_GET['from_date']) && $this->isValidDate($_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'] ." 23:59:59");
+ }
+ break;
+ case 'showp':
+ if(isset($_GET['tags'])) {
+ $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);
+ $_SESSION['start_action'] = 'showp';
+ }
+ if(isset($_GET['id']) && is_numeric($_GET['id'])) {
+ $_SESSION['current_photo'] = $_GET['id'];
+ $_SESSION['start_action'] = 'showp';
+ }
+ if(isset($_GET['from_date']) && $this->isValidDate($_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'] ." 23:59:59");
+ }
+ break;
+ case 'export':
+ $this->tmpl->show("export.tpl");
+ return;
+ break;
+ case 'slideshow':
+ $this->tmpl->show("slideshow.tpl");
+ return;
+ break;
+ case 'rss':
+ if(isset($_GET['tags'])) {
+ $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);
+ }
+ if(isset($_GET['from_date']) && $this->isValidDate($_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'] ." 23:59:59");
+ }
+ $this->getRSSFeed();
+ return;
+ break;
+ }
}
+ if(isset($_SESSION['from_date']) && isset($_SESSION['to_date']))
+ $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->show("index.tpl");
-
} // show()
+ /**
+ * get_tags - grab all tags of f-spot's database
+ *
+ * this function will get all available tags from
+ * the f-spot database and store them within two
+ * arrays within this class for later usage. in
+ * fact, if the user requests (hide_tags) it will
+ * opt-out some of them.
+ *
+ * this function is getting called once by show()
+ */
private function get_tags()
{
-
$this->avail_tags = Array();
$count = 0;
- $result = $this->db->db_query("
- SELECT id,name
- FROM tags
- ORDER BY sort_priority ASC
- ");
+ if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+ $query_str="
+ SELECT
+ DISTINCT t1.id as id, t1.name as name
+ FROM
+ photo_tags pt1
+ INNER JOIN photo_tags
+ pt2 ON pt1.photo_id=pt2.photo_id
+ INNER JOIN tags t1
+ ON t1.id=pt1.tag_id
+ INNER JOIN tags t2
+ ON t2.id=pt2.tag_id
+ WHERE
+ t2.name IN ('".implode("','",$this->cfg->show_tags)."')
+ ORDER BY
+ t1.sort_priority ASC";
+
+ $result = $this->db->db_query($query_str);
+ }
+ else
+ {
+ $result = $this->db->db_query("
+ SELECT id,name
+ FROM tags
+ ORDER BY sort_priority ASC
+ ");
+ }
while($row = $this->db->db_fetch_object($result)) {
$tag_id = $row['id'];
$tag_name = $row['name'];
- /* check if config requests to ignore this tag */
+ /* if the user has specified to ignore this tag in phpfspot's
+ configuration, ignore it here so it does not get added to
+ the tag list.
+ */
if(in_array($row['name'], $this->cfg->hide_tags))
continue;
+ /* if you include the following if-clause and the user has specified
+ to only show certain tags which are specified in phpfspot's
+ configuration, ignore all others so they will not be added to the
+ tag list.
+ if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags) &&
+ !in_array($row['name'], $this->cfg->show_tags))
+ continue;
+ */
+
$this->tags[$tag_id] = $tag_name;
$this->avail_tags[$count] = $tag_id;
-
$count++;
}
} // get_tags()
+ /**
+ * extract all photo details
+ *
+ * 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)
{
- $result = $this->db->db_query("
- SELECT *
- FROM photos
- WHERE id='". $idx ."'
- ");
-
- return $this->db->db_fetch_object($result);
+ if($this->dbver < 9) {
+ $query_str = "
+ SELECT p.id, p.name, p.time, p.directory_path, p.description
+ FROM photos p
+ ";
+ }
+ else {
+ $query_str = "
+ SELECT p.id, p.uri, p.time, p.description
+ 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 p.id='". $idx ."'
+ AND t.name IN ('".implode("','",$this->cfg->show_tags)."')";
+ }
+ else {
+ $query_str.= "
+ WHERE p.id='". $idx ."'
+ ";
+ }
+
+ if($result = $this->db->db_query($query_str)) {
+
+ $row = $this->db->db_fetch_object($result);
+
+ if($this->dbver < 9) {
+ $row['uri'] = "file://". $row['directory_path'] ."/". $row['name'];
+ }
+
+ return $row;
+
+ }
+
+ return null;
} // get_photo_details
- public function translate_path($path, $width = 0)
+ /**
+ * returns aligned photo names
+ *
+ * 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)
+ {
+ if($details = $this->get_photo_details($idx)) {
+ if($long_name = $this->parse_uri($details['uri'], 'filename')) {
+ $name = $this->shrink_text($long_name, $limit);
+ return $name;
+ }
+ }
+
+ return null;
+
+ } // getPhotoName()
+
+ /**
+ * 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)
+ {
+ if($limit != 0 && strlen($text) > $limit) {
+ $text = substr($text, 0, $limit-5) ."...". substr($text, -($limit-5));
+ }
+
+ return $text;
+
+ } // shrink_text();
+
+ /**
+ * translate f-spoth photo path
+ *
+ * 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)
{
return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
} // translate_path
+ /**
+ * control HTML ouput for a single photo
+ *
+ * this function provides all the necessary information
+ * for the single photo template.
+ * @param integer photo
+ */
public function showPhoto($photo)
{
+ /* get all photos from the current photo selection */
$all_photos = $this->getPhotoSelection();
$count = count($all_photos);
for($i = 0; $i < $count; $i++) {
- if($get_next) {
+ // $get_next will be set, when the photo which has to
+ // be displayed has been found - this means that the
+ // next available is in fact the NEXT image (for the
+ // navigation icons)
+ if(isset($get_next)) {
$next_img = $all_photos[$i];
break;
}
+ /* the next photo is our NEXT photo */
if($all_photos[$i] == $photo) {
$get_next = 1;
}
}
$details = $this->get_photo_details($photo);
- $orig_path = $this->translate_path($details['directory_path']) ."/". $details['name'];
- $thumb_path = $this->cfg->base_path ."/thumbs/". $this->cfg->photo_width ."_". $this->getMD5($photo);
+
+ if(!$details) {
+ print "error";
+ return;
+ }
+
+ $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+ $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
if(!file_exists($orig_path)) {
- $this->_warning("Photo ". $orig_path ." does not exist!<br />\n");
+ $this->_error("Photo ". $orig_path ." does not exist!<br />\n");
+ return;
}
if(!is_readable($orig_path)) {
- $this->_warning("Photo ". $orig_path ." is not readable for user ". get_current_user() ."<br />\n");
+ $this->_error("Photo ". $orig_path ." is not readable for user ". $this->getuid() ."<br />\n");
+ return;
}
/* If the thumbnail doesn't exist yet, try to create it */
if(!file_exists($thumb_path)) {
$this->gen_thumb($photo, true);
+ $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
}
- $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 {
+ $meta_res = $info[0] ."x". $info[1];
+ }
$meta_date = isset($meta['FileDateTime']) ? strftime("%a %x %X", $meta['FileDateTime']) : "n/a";
- $meta_make = isset($meta['Make']) ? $meta['Make'] ." ". $meta['Model'] : "n/a";
- $meta_res = isset($meta['ExifImageWidth']) ? $meta['ExifImageWidth'] ."x". $meta['ExifImageLength'] : "n/a";
+ $meta_make = isset($meta['Make']) ? $meta['Make'] ." / ". $meta['Model'] : "n/a";
$meta_size = isset($meta['FileSize']) ? round($meta['FileSize']/1024, 1) ."kbyte" : "n/a";
- if(file_exists($thumb_path)) {
+ $extern_link = "index.php?mode=showp&id=". $photo;
+ $current_tags = $this->getCurrentTags();
+ if($current_tags != "") {
+ $extern_link.= "&tags=". $current_tags;
+ }
+ if(isset($_SESSION['from_date']) && isset($_SESSION['to_date'])) {
+ $extern_link.= "&from_date=". $this->ts2str($_SESSION['from_date']) ."&to_date=". $this->ts2str($_SESSION['to_date']);
+ }
- $info = getimagesize($thumb_path);
+ $this->tmpl->assign('extern_link', $extern_link);
- $this->tmpl->assign('description', $details['description']);
- $this->tmpl->assign('image_name', $details['name']);
+ if(!file_exists($thumb_path)) {
+ $this->_error("Can't open file ". $thumb_path ."\n");
+ return;
+ }
- $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);
+ $info_thumb = getimagesize($thumb_path);
- $this->tmpl->assign('tags', $this->get_photo_tags($photo));
- $this->tmpl->assign('current', $current);
- }
- else {
- $this->_warning("Can't open file ". $thumb_path ."\n");
- }
+ $this->tmpl->assign('description', $details['description']);
+ $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename'));
+
+ $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);
+ $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);
}
if($next_img) {
$this->tmpl->assign('next_url', "javascript:showImage(". $next_img .");");
+ $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");
} // showPhoto()
+ /**
+ * all available tags and tag cloud
+ *
+ * this function outputs all available tags (time ordered)
+ * and in addition output them as tag cloud (tags which have
+ * many photos will appears more then others)
+ */
public function getAvailableTags()
{
+ /* retrive tags from database */
+ $this->get_tags();
+
+ $output = "";
+
$result = $this->db->db_query("
SELECT tag_id as id, count(tag_id) as quantity
FROM photo_tags
projects / phpfspot.git / blobdiff