/***************************************************************************
*
- * 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
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,
*/
public function __construct()
{
+ /**
+ * register PHPFSPOT class global
+ *
+ * @global PHPFSPOT $GLOBALS['phpfspot']
+ * @name $phpfspot
+ */
+ $GLOBALS['phpfspot'] =& $this;
+
$this->cfg = new PHPFSPOT_CFG;
/* verify config settings */
);
/* 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);
exit(1);
}
- $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);
+ /******* 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();
/* check if all necessary indices exist */
$this->checkDbIndices();
*
* 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)
{
* 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 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)
{
* 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);
*
* this function provides all the necessary information
* for the single photo template.
+ * @param integer photo
*/
public function showPhoto($photo)
{
return;
}
- $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+ $orig_path = $this->translate_path($this->parse_uri($details['uri']));
$thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
if(!file_exists($orig_path)) {
$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];
}
return;
}
- $info = getimagesize($thumb_path);
+ $info_thumb = getimagesize($thumb_path);
$this->tmpl->assign('description', $details['description']);
$this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename'));
- $this->tmpl->assign('width', $info[0]);
- $this->tmpl->assign('height', $info[1]);
+ $this->tmpl->assign('width', $info_thumb[0]);
+ $this->tmpl->assign('height', $info_thumb[1]);
$this->tmpl->assign('ExifMadeOn', $meta_date);
$this->tmpl->assign('ExifMadeWith', $meta_make);
$this->tmpl->assign('ExifOrigResolution', $meta_res);
$this->tmpl->assign('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));
$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));
// 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) {
// 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.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%;\">". $this->tags[$key] ."</a>, ";
+ $output.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
}
}
* 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()
{
* 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)
{
*
* this function removes the specified tag from
* users current tag selection
+ * @param string $tag
+ * @return string
*/
public function delTag($tag)
{
/**
* returns the value for the autocomplet tag-search
+ * @return string
*/
public function get_xml_tag_list()
{
if(!isset($_GET['search']) || !is_string($_GET['search']))
$_GET['search'] = '';
- if(!isset($_GET['length']) || !is_numeric($_GET['length']))
- $_GET['length'] = 5;
-
+ $length = 15;
+ $i = 1;
/* retrive tags from database */
$this->get_tags();
$matched_tags = Array();
+ header("Content-Type: text/xml");
+
+ $string = "<?xml version=\"1.0\" encoding=\"utf-8\" ?>\n";
+ $string.= "<results>\n";
+
foreach($this->avail_tags as $tag)
{
if(!empty($_GET['search']) &&
preg_match("/". $_GET['search'] ."/i", $this->tags[$tag]) &&
- count($matched_tags) < $_GET['length']) {
+ count($matched_tags) < $length) {
+
+ $count = $this->get_num_photos($tag);
+
+ if($count == 1) {
+ $string.= " <rs id=\"". $i ."\" info=\"". $count ." photo\">". $this->tags[$tag] ."</rs>\n";
+ }
+ else {
+ $string.= " <rs id=\"". $i ."\" info=\"". $count ." photos\">". $this->tags[$tag] ."</rs>\n";
- array_push($matched_tags, $this->tags[$tag] .",". $this->tags[$tag]);
+ }
+ $i++;
}
/* if we have collected enough items, break out */
- if(count($matched_tags) >= $_GET['length'])
+ if(count($matched_tags) >= $length)
break;
}
- if(empty($matched_tags))
- return;
+ $string.= "</results>\n";
- return implode('|', $matched_tags);
+ return $string;
} // get_xml_tag_list()
* 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()
{
* 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)
{
if(!$this->checkifImageSupported($details['mime']))
return false;
- $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;
- }
-
- $src_img = @imagecreatefromjpeg($orig_image);
+ switch($details['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;
+ }
+
+ $src_img = @imagecreatefromjpeg($orig_image);
+ break;
+
+ case 'image/png':
+
+ $src_img = @imagecreatefrompng($orig_image);
+ break;
+
+ }
if(!$src_img) {
print "Can't load image from ". $orig_image ."\n";
/**
* return all exif meta data from the file
+ * @param string $file
+ * @return array
*/
public function get_meta_informations($file)
{
* 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)
{
$details = $this->get_photo_details($idx);
/* calculate file MD5 sum */
- $full_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+ $full_path = $this->translate_path($this->parse_uri($details['uri']));
if(!file_exists($full_path)) {
$this->_error("File ". $full_path ." does not exist\n");
*
* 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)
{
/**
* set MD5 sum for the specific photo
+ * @param integer $idx
+ * @param string $md5
*/
private function setMD5($idx, $md5)
{
*
* this function stores the current tag condition
* (AND or OR) in the users session variables
+ * @param string $mode
+ * @return string
*/
public function setTagCondition($mode)
{
* it also handles the date search.
* getPhotoSelection() will then only return the matching
* photos.
+ * @return string
*/
public function startSearch()
{
*
* 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)
{
*
* this function rotates the image according the
* specified angel.
+ * @param string $img
+ * @param integer $degress
+ * @return image
*/
private function rotateImage($img, $degrees)
{
*
* 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)
{
/**
* return all assigned tags for the specified photo
+ * @param integer $idx
+ * @return array
*/
private function get_photo_tags($idx)
{
/**
* 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)
{
/**
* 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<br />\n";
print "PEAR Console_Getopt package is missing<br />\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<br />\n";
+ $missing = true;
+ }
ini_restore('track_errors');
if(isset($missing))
return true;
- } // checkRequirements()
+ } // check_requirements()
private function _debug($text)
{
/**
* check if specified MIME type is supported
+ * @param string $mime
+ * @return boolean
*/
public function checkifImageSupported($mime)
{
- if(in_array($mime, Array("image/jpeg")))
+ if(in_array($mime, Array("image/jpeg", "image/png")))
return true;
return false;
} // checkifImageSupported()
+ /**
+ * output error text
+ * @param string $text
+ */
public function _error($text)
{
switch($this->cfg->logging) {
/**
* output calendard input fields
+ * @param string $mode
+ * @return string
*/
private function get_calendar($mode)
{
/**
* output calendar matrix
+ * @param integer $year
+ * @param integer $month
+ * @param integer $day
*/
public function get_calendar_matrix($year = 0, $month = 0, $day = 0)
{
/**
* output export page
+ * @param string $mode
*/
public function getExport($mode)
{
<br>
". $details['description']);
- $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
- $meta = $this->get_meta_informations($orig_path);
+ $orig_path = $this->translate_path($this->parse_uri($details['uri']));
+
+ /* 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);
?>
/**
* return all selected tags as one string
+ * @return array
*/
private function getCurrentTags()
{
* 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()
{
/**
* return the current process-user
+ * @return string
*/
private function getuid()
{
/**
* 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)
{
/**
* returns the currently selected sort order
+ * @return string
*/
private function get_sort_order()
{
} // 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();
} // 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();
} // 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();
* 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)
{
/**
* 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) {
/**
* returns the full path to a thumbnail
+ * @param integer $width
+ * @param integer $photo
+ * @return string
*/
public function get_thumb_path($width, $photo)
{
/**
* returns server's virtual host name
+ * @return string
*/
private function get_server_name()
{
} // 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()
{
/**
* 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
* 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)
{
*
* 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()
{
} // 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)
{
*
* this function checks if all necessary configuration options are
* specified and set.
+ * @return boolean
*/
private function check_config_options()
{
* 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)
{
projects / phpfspot.git / blobdiff