issue117, auto-scroll photo-index if thumbnails are out of sight after a page-refresh
[phpfspot.git] / phpfspot.class.php
index 03fe9d487b79112e5e0c91877c892a2ced2ca0ec..bae4ae74dbc40ce34899bb4270397a3860000abf 100644 (file)
@@ -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
 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,101 @@ 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();
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();
@@ -107,10 +212,10 @@ 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 thumbs_per_page is now 0, unset it
       if(isset($_SESSION['begin_with']) && $this->cfg->thumbs_per_page == 0)
@@ -134,7 +239,7 @@ 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);
@@ -284,6 +389,8 @@ class PHPFSPOT {
     * 
     * retrieve all available details from f-spot's
     * database and return them as object
+    * @param integer $idx
+    * @return object|null
     */
    public function get_photo_details($idx)
    {
@@ -340,6 +447,9 @@ class PHPFSPOT {
     * this function returns aligned (length) names for
     * an specific photo. If the length of the name exceeds
     * $limit the name will be shrinked (...)
+    * @param integer $idx
+    * @param integer $limit
+    * @return string|null
     */
    public function getPhotoName($idx, $limit = 0)
    {
@@ -360,6 +470,9 @@ class PHPFSPOT {
     * If the length of the name exceeds $limit the
     * text will be shortend and some content in between
     * will be replaced with "..." 
+    * @param string $ext
+    * @param integer $limit
+    * @return string
     */
    private function shrink_text($text, $limit)
    {
@@ -377,8 +490,10 @@ class PHPFSPOT {
     * as the full-qualified path recorded in the f-spot database
     * is usally not the same as on the webserver, this function
     * will replace the path with that one specified in the cfg
+    * @param string $path
+    * @return string
     */
-   public function translate_path($path, $width = 0)
+   public function translate_path($path)
    {  
       return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
 
@@ -389,6 +504,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
+    * @param integer photo
     */
    public function showPhoto($photo)
    {
@@ -446,14 +562,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]; 
       }
 
@@ -477,13 +597,13 @@ class PHPFSPOT {
          return;
       }
 
-      $info = getimagesize($thumb_path);
+      $info_thumb = getimagesize($thumb_path);
 
       $this->tmpl->assign('description', $details['description']);
       $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename'));
 
-      $this->tmpl->assign('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);
@@ -494,7 +614,8 @@ class PHPFSPOT {
       $this->tmpl->assign('image_filename', $this->parse_uri($details['uri'], 'filename'));
 
       $this->tmpl->assign('tags', $this->get_photo_tags($photo));
-      $this->tmpl->assign('current', $current);
+      $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 .");");
@@ -506,6 +627,7 @@ 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));
 
@@ -546,6 +668,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));
@@ -559,6 +685,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) {
@@ -574,8 +701,14 @@ 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.= "<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>, ";
          }
 
       }
@@ -591,6 +724,7 @@ class PHPFSPOT {
     * this function output all tags which have been selected
     * by the user. the selected tags are stored in the 
     * session-variable $_SESSION['selected_tags']
+    * @return string
     */
    public function getSelectedTags()
    {
@@ -623,17 +757,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()
 
@@ -642,11 +785,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']);
@@ -654,6 +799,8 @@ class PHPFSPOT {
          sort($_SESSION['selected_tags']);
       }
 
+      return "ok";
+
    } // delTag()
 
    /**
@@ -669,6 +816,58 @@ class PHPFSPOT {
 
    } // resetTags()
 
+   /**
+    * 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'] = '';
+      
+      $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) < $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";
+
+            }
+            $i++;
+         }
+
+         /* if we have collected enough items, break out */
+         if(count($matched_tags) >= $length)
+            break;
+      }
+
+      $string.= "</results>\n";
+
+      return $string;
+
+   } // get_xml_tag_list()
+
+
    /**
     * reset single photo
     *
@@ -685,17 +884,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
@@ -717,41 +927,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)) {
@@ -788,7 +1021,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)) {
@@ -844,7 +1077,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)) {
@@ -865,7 +1098,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
@@ -873,14 +1106,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)) {
-        if(isset($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($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))
@@ -906,15 +1139,12 @@ class PHPFSPOT {
 
       $count = count($photos);
 
-      if(isset($_SESSION['begin_with']) && $_SESSION['begin_with'] != "")
-         $anchor = $_SESSION['begin_with'];
-
+      /* 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;
-
       }
+      /* thumbnails should be splitted up in several pages */
       elseif($this->cfg->thumbs_per_page > 0) {
 
          if(!isset($_SESSION['begin_with']) || $_SESSION['begin_with'] == 0) {
@@ -933,6 +1163,7 @@ class PHPFSPOT {
       $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++) {
@@ -942,6 +1173,7 @@ class PHPFSPOT {
             $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]);
@@ -958,8 +1190,8 @@ class PHPFSPOT {
       // +1 for for smarty's selection iteration
       $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']));
@@ -1072,6 +1304,7 @@ 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('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);
@@ -1079,13 +1312,20 @@ class PHPFSPOT {
       $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('thumbs', $thumbs);
 
       $this->tmpl->show("photo_index.tpl");
 
-      if(isset($anchor))
-         print "<script language=\"JavaScript\">self.location.hash = '#image". $anchor ."';</script>\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'])) {
+         print "<script language=\"JavaScript\">moveToThumb(". $_SESSION['last_photo'] .");</script>\n";
+         unset($_SESSION['last_photo']);
+      }
 
    } // showPhotoIndex()
 
@@ -1102,12 +1342,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)
    {  
@@ -1115,56 +1359,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;
+            }
+
+            $src_img = @imagecreatefromjpeg($orig_image);
+            $handler = "gd";
+            break;
 
-      $rotate = 0;
-      $flip = false;
+         case 'image/png':
 
-      switch($meta['Orientation']) {
+            $src_img = @imagecreatefrompng($orig_image);
+            $handler = "gd";
+            break;
 
-         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;
-      }
+         case 'image/x-portable-pixmap':
+
+            $src_img = new Imagick($orig_image);
+            $handler = "imagick";
+            break;
 
-      $src_img = @imagecreatefromjpeg($orig_image);
+      }
 
-      if(!$src_img) {
+      if(!isset($src_img) || empty($src_img)) {
          print "Can't load image from ". $orig_image ."\n";
          return false;
       }
 
-      /* grabs the height and width */
-      $cur_width = imagesx($src_img);
-      $cur_height = imagesy($src_img);
+      switch($handler) {
+
+         case 'gd':
+
+            /* grabs the height and width */
+            $cur_width = imagesx($src_img);
+            $cur_height = imagesy($src_img);
+
+            // If requested width is more then the actual image width,
+            // do not generate a thumbnail, instead safe the original
+            // as thumbnail but with lower quality. But if the image
+            // is to heigh too, then we still have to resize it.
+            if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) {
+               $result = imagejpeg($src_img, $thumb_image, 75);
+               imagedestroy($src_img);
+               return true;
+            }
+            break;
+
+         case 'imagick':
+
+            $cur_width = $src_img->getImageWidth();
+            $cur_height = $src_img->getImageHeight();
+
+            // If requested width is more then the actual image width,
+            // do not generate a thumbnail, instead safe the original
+            // as thumbnail but with lower quality. But if the image
+            // is to heigh too, then we still have to resize it.
+            if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) {
+               $src_img->setCompressionQuality(75);
+               $src_img->setImageFormat('jpeg');
+               $src_img->writeImage($thumb_image);
+               $src_img->clear();
+               $src_img->destroy();
+               return true;
+            }
+            break;
 
-      // If requested width is more then the actual image width,
-      // do not generate a thumbnail, instead safe the original
-      // as thumbnail but with lower quality. But if the image
-      // is to heigh too, then we still have to resize it.
-      if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) {
-         $result = imagejpeg($src_img, $thumb_image, 75);
-         imagedestroy($src_img);
-         return true;
       }
 
       // If the image will be rotate because EXIF orientation said so
@@ -1206,46 +1496,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)
    {
@@ -1284,6 +1622,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)
    {
@@ -1311,10 +1652,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) {
@@ -1324,6 +1682,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);
          }
@@ -1365,6 +1724,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)
    {
@@ -1384,6 +1745,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
+    * @param integer $idx
+    * @param string $md5
     */
    private function setMD5($idx, $md5)
    {
@@ -1399,11 +1762,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()
 
    /** 
@@ -1414,32 +1781,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()
    {
-      $this->get_tags();
+      if(isset($_POST['from']) && $this->isValidDate($_POST['from'])) {
+         $from = $_POST['from'];
+      }
+      if(isset($_POST['to']) && $this->isValidDate($_POST['to'])) {
+         $to = $_POST['to'];
+      }
 
-      $_SESSION['searchfor'] = $searchfor;
+      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'];
+      }
 
-      if($from != 0)
+      $this->get_tags();
+
+      if(isset($from) && !empty($from))
          $_SESSION['from_date'] = strtotime($from ." 00:00:00");
       else
          unset($_SESSION['from_date']);
 
-      if($to != 0)
+      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()
 
    /**
@@ -1447,6 +1832,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)
    {
@@ -1464,6 +1851,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)
    {
@@ -1536,8 +1926,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)
    {
@@ -1551,8 +1975,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;
 
@@ -1560,6 +1987,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)
    {
@@ -1589,8 +2021,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<br />\n";
@@ -1619,6 +2052,11 @@ class PHPFSPOT {
          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))
@@ -1626,7 +2064,7 @@ class PHPFSPOT {
 
       return true;
 
-   } // checkRequirements()
+   } // check_requirements()
 
    private function _debug($text)
    {
@@ -1638,22 +2076,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 "<img src=\"resources/green_info.png\" alt=\"warning\" />\n";
-            print $text;
+            print $text ."<br />\n";
             break;
          case 'errorlog':  
             error_log($text);
@@ -1663,10 +2115,14 @@ class PHPFSPOT {
             break;
       }
 
+      $this->runtime_error = true;
+
    } // _error()
 
    /**
     * output calendard input fields
+    * @param string $mode
+    * @return string
     */
    private function get_calendar($mode)
    {
@@ -1693,6 +2149,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)
    {
@@ -1771,6 +2230,7 @@ class PHPFSPOT {
 
    /**
     * output export page
+    * @param string $mode
     */
    public function getExport($mode)
    {
@@ -1853,7 +2313,12 @@ class PHPFSPOT {
 ". $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);
 
 ?>
@@ -1881,6 +2346,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
+    * @return array
     */
    private function getCurrentTags()
    {
@@ -1912,6 +2378,7 @@ class PHPFSPOT {
     * to do next. This is necessary for directly jumping
     * into photo index or single photo view when the are
     * requested with specific URLs
+    * @return string
     */
    public function whatToDo()
    {
@@ -1931,6 +2398,7 @@ class PHPFSPOT {
 
    /**
     * return the current process-user
+    * @return string
     */
    private function getuid()
    {
@@ -1946,6 +2414,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)
    {
@@ -1965,6 +2436,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
+    * @return string
     */ 
    private function get_sort_order()
    {
@@ -1991,16 +2463,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();
@@ -2014,12 +2493,13 @@ class PHPFSPOT {
 
    } // getNextSlideShowImage()
 
-   /***
-     * return the previous to be shown slide show image
-     *
-     * this function returns the URL of the previous image
-     * in the slideshow sequence.
-     */
+   /**
+    * return the previous to be shown slide show image
+    *
+    * this function returns the URL of the previous image
+    * in the slideshow sequence.
+    * @return string
+    */
    public function getPrevSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();
@@ -2037,27 +2517,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']);
       }
@@ -2072,6 +2569,8 @@ class PHPFSPOT {
     * this function validates if the provided date
     * contains a valid date and will return true 
     * if it is.
+    * @param string $date_str
+    * @return boolean
     */
    public function isValidDate($date_str)
    {
@@ -2086,15 +2585,22 @@ class PHPFSPOT {
 
    /**
     * timestamp to string conversion
+    * @param integer $timestamp
+    * @return string
     */
    private function ts2str($timestamp)
    {
       return strftime("%Y-%m-%d", $timestamp);
    } // ts2str()
 
+   /**
+    * extract tag-names from $_GET['tags']
+    * @param string $tags_str
+    * @return string
+    */
    private function extractTags($tags_str)
    {
-      $not_validated = split(',', $_GET['tags']);
+      $not_validated = split(',', $tags_str);
       $validated = array();
 
       foreach($not_validated as $tag) {
@@ -2108,6 +2614,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)
    {
@@ -2125,6 +2634,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
+    * @return string
     */
    private function get_server_name()
    {
@@ -2132,8 +2642,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()
    {
@@ -2145,11 +2655,33 @@ 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
@@ -2157,6 +2689,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)
    {
@@ -2201,6 +2736,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()
    {
@@ -2217,8 +2753,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)
    {
@@ -2241,6 +2779,198 @@ 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!");
+
+      }
+
+      /* check for pending slash on web_path */
+      if(!preg_match("/\/$/", $this->cfg->web_path))
+         $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($orig_image);
+
+      /* 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()
+
 } // class PHPFSPOT
 
 ?>