issue118, fix using variable name for search.tpl and photo_index.tpl twice
[phpfspot.git] / phpfspot.class.php
index d192d0d6445acee4f4a5f3ab69d03ca73e215329..00b3af4a08f402fedcaf6e1ba162adf6c30bce3c 100644 (file)
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 
+/**
+ * PHPFSPOT main class
+ *
+ * this class contains the most functions which will to the major
+ * work for phpfspot.
+ *
+ * @package phpfspot
+ */
 class PHPFSPOT {
 
+   /**
+     * phpfspot configuration
+     * @access public
+     * @see PHPFSPOT_CFG()
+     * @var PHPFSPOT_CFG
+     */
    var $cfg;
+
+   /**
+     * SQLite database handle to f-spot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */
    var $db;
+
+   /**
+     * SQLite database handle to phpfspot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */
    var $cfg_db;
+
+   /**
+    * Smarty template engine
+    * @link http://smarty.php.net smarty.php.net
+    * @see PHPFSPOT_TMPL()
+    * @access public
+    * @var PHPFSPOT_TMPL
+    */
    var $tmpl;
+
+   /**
+    * full tag - list
+    * @access public
+    * @var array
+    */
    var $tags;
+
+   /**
+    * list of available, not-selected, tags
+    * @access public
+    * @var array
+    */
    var $avail_tags;
 
+   /**
+    * true if runtime error occued
+    * @access private
+    * @var boolean
+    */
    private $runtime_error = false;
+
+   /**
+    * F-Spot database version
+    * @access private
+    * @var integer
+    */
    private $dbver;
 
    /**
-    * class constructor
+    * class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)
     *
     * this function will be called on class construct
     * and will check requirements, loads configuration,
@@ -46,6 +105,14 @@ class PHPFSPOT {
     */
    public function __construct()
    {
+      /**
+       * register PHPFSPOT class global
+       *
+       * @global PHPFSPOT $GLOBALS['phpfspot']
+       * @name $phpfspot
+       */
+      $GLOBALS['phpfspot'] =& $this;
+
       $this->cfg = new PHPFSPOT_CFG;
 
       /* verify config settings */
@@ -55,7 +122,7 @@ class PHPFSPOT {
 
       /* set application name and version information */
       $this->cfg->product = "phpfspot";
-      $this->cfg->version = "1.4";
+      $this->cfg->version = "1.5";
 
       $this->sort_orders= array(
          'date_asc' => 'Date ↑',
@@ -132,7 +199,9 @@ class PHPFSPOT {
 
       /* overload Smarty class with our own template handler */
       require_once "phpfspot_tmpl.php";
-      $this->tmpl = new PHPFSPOT_TMPL($this);
+      $this->tmpl = new PHPFSPOT_TMPL();
+
+      $this->tmpl->assign('web_path', $this->cfg->web_path);
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();
@@ -177,6 +246,11 @@ class PHPFSPOT {
       $this->tmpl->assign('current_condition', $_SESSION['tag_condition']);
       $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name);
 
+      /* parse URL */
+      if($this->is_user_friendly_url()) {
+         $content = $this->parse_user_friendly_url($_SERVER['REQUEST_URI']);
+      }
+
       if(isset($_GET['mode'])) {
 
          $_SESSION['start_action'] = $_GET['mode'];
@@ -237,9 +311,21 @@ class PHPFSPOT {
          $this->tmpl->assign('date_search_enabled', true);
 
       $this->tmpl->register_function("sort_select_list", array(&$this, "smarty_sort_select_list"), false);
-      $this->tmpl->assign('from_date', $this->get_calendar('from'));
-      $this->tmpl->assign('to_date', $this->get_calendar('to'));
-      $this->tmpl->assign('content_page', 'welcome.tpl');
+      $this->tmpl->assign('search_from_date', $this->get_calendar('from'));
+      $this->tmpl->assign('search_to_date', $this->get_calendar('to'));
+
+      $this->tmpl->assign('preset_selected_tags', $this->getSelectedTags());
+      $this->tmpl->assign('preset_available_tags', $this->getAvailableTags());
+
+      if(!isset($content)) {
+         if(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags']))
+            $this->tmpl->assign('initial_content', $this->showPhotoIndex());
+         else
+            $this->tmpl->assign('initial_content', $this->tmpl->fetch('welcome.tpl'));
+      }
+      else
+         $this->tmpl->assign('initial_content', $content);
+
       $this->tmpl->show("index.tpl");
 
    } // show()
@@ -322,6 +408,8 @@ class PHPFSPOT {
     * 
     * retrieve all available details from f-spot's
     * database and return them as object
+    * @param integer $idx
+    * @return object|null
     */
    public function get_photo_details($idx)
    {
@@ -378,6 +466,9 @@ class PHPFSPOT {
     * this function returns aligned (length) names for
     * an specific photo. If the length of the name exceeds
     * $limit the name will be shrinked (...)
+    * @param integer $idx
+    * @param integer $limit
+    * @return string|null
     */
    public function getPhotoName($idx, $limit = 0)
    {
@@ -398,6 +489,9 @@ class PHPFSPOT {
     * If the length of the name exceeds $limit the
     * text will be shortend and some content in between
     * will be replaced with "..." 
+    * @param string $ext
+    * @param integer $limit
+    * @return string
     */
    private function shrink_text($text, $limit)
    {
@@ -415,8 +509,10 @@ class PHPFSPOT {
     * as the full-qualified path recorded in the f-spot database
     * is usally not the same as on the webserver, this function
     * will replace the path with that one specified in the cfg
+    * @param string $path
+    * @return string
     */
-   public function translate_path($path, $width = 0)
+   public function translate_path($path)
    {  
       return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
 
@@ -427,6 +523,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
+    * @param integer photo
     */
    public function showPhoto($photo)
    {
@@ -531,8 +628,15 @@ class PHPFSPOT {
       $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);
+      if($this->is_user_friendly_url()) {
+         $this->tmpl->assign('image_url', '/photo/'. $photo ."/". $this->cfg->photo_width);
+         $this->tmpl->assign('image_url_full', '/photo/'. $photo);
+      }
+      else {
+         $this->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));
@@ -553,7 +657,7 @@ class PHPFSPOT {
       $this->tmpl->assign('photo_number', $i);
       $this->tmpl->assign('photo_count', count($all_photos));
 
-      $this->tmpl->show("single_photo.tpl");
+      return $this->tmpl->fetch("single_photo.tpl");
 
    } // showPhoto()
 
@@ -630,13 +734,15 @@ class PHPFSPOT {
          $b = '88';
 
          if(isset($this->tags[$key])) {
-            $output.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
+            if($this->is_user_friendly_url())
+               $output.= "<a href=\"". $this->cfg->web_path ."/tag/". $key ."\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
+            else
+               $output.= "<a href=\"". $this->cfg->web_path ."/index.php?mode=showpi\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
          }
-
       }
 
       $output = substr($output, 0, strlen($output)-2);
-      print $output;
+      return $output;
 
    } // getAvailableTags()
 
@@ -646,8 +752,9 @@ class PHPFSPOT {
     * this function output all tags which have been selected
     * by the user. the selected tags are stored in the 
     * session-variable $_SESSION['selected_tags']
+    * @return string
     */
-   public function getSelectedTags()
+   public function getSelectedTags($type = 'link')
    {
       /* retrive tags from database */
       $this->get_tags();
@@ -658,7 +765,29 @@ class PHPFSPOT {
       {
          // return all selected tags
          if(isset($_SESSION['selected_tags']) && in_array($tag, $_SESSION['selected_tags'])) {
-            $output.= "<a href=\"javascript:Tags('del', ". $tag .");\" class=\"tag\">". $this->tags[$tag] ."</a>, ";
+
+            switch($type) {
+               default:
+               case 'link':
+                  $output.= "<a href=\"javascript:Tags('del', ". $tag .");\" class=\"tag\">". $this->tags[$tag] ."</a>, ";
+                  break;
+               case 'img':
+                  $output.= "
+                  <div style=\"display: table-cell;\">
+                   <div style=\"display: table-row; text-align: center;\">
+                    <a href=\"javascript:Tags('del', ". $tag .");\" title=\"". $this->tags[$tag] ."\">
+                     <img src=\"". $this->cfg->web_path ."/phpfspot_img.php?tagidx=". $tag ."\" />
+                    </a>
+                   </div>
+                   <div style=\"display: table-row; text-align: center;\">
+                    <a href=\"javascript:Tags('del', ". $tag .");\" title=\"". $this->tags[$tag] ."\">
+                     <img src=\"". $this->cfg->web_path ."/resources/underbar.png\" />
+                    </a>
+                   </div>
+                  </div>
+                  ";
+                  break;
+            }
          }
       }
 
@@ -678,6 +807,7 @@ class PHPFSPOT {
     * this function will add the specified to users current
     * tag selection. if a date search has been made before
     * it will be now cleared
+    * @return string
     */
    public function addTag($tag)
    {
@@ -687,10 +817,15 @@ class PHPFSPOT {
       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()
@@ -700,6 +835,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
+    * @param string $tag
+    * @return string
     */
    public function delTag($tag)
    {
@@ -731,6 +868,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
+    * @return string
     */
    public function get_xml_tag_list()
    {
@@ -839,6 +977,7 @@ class PHPFSPOT {
     * the tag-selection, tag- or date-search.
     * the tag-search also has to take care of AND
     * and OR conjunctions
+    * @return array
     */
    public function getPhotoSelection()
    {  
@@ -1043,6 +1182,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the photo index template.
+    * @return string
     */
    public function showPhotoIndex()
    {
@@ -1192,7 +1332,6 @@ class PHPFSPOT {
          if($last_page > 1)
             $this->tmpl->assign('page_selector', $page_select);
       }
-
       
       $current_tags = $this->getCurrentTags();
       $extern_link = "index.php?mode=showpi";
@@ -1226,18 +1365,21 @@ class PHPFSPOT {
       $this->tmpl->assign('img_fullname', $img_fullname);
       $this->tmpl->assign('img_title', $img_title);
       $this->tmpl->assign('thumbs', $thumbs);
+      $this->tmpl->assign('selected_tags', $this->getSelectedTags('img'));
 
-      $this->tmpl->show("photo_index.tpl");
+      $result = $this->tmpl->fetch("photo_index.tpl");
 
       /* if 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";
+         $result.= "<script language=\"JavaScript\">moveToThumb(". $_SESSION['last_photo'] .");</script>\n";
          unset($_SESSION['last_photo']);
       }
 
+      return $result;
+
    } // showPhotoIndex()
 
    /**
@@ -1253,12 +1395,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)
    {  
@@ -1266,13 +1412,13 @@ 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;
 
-      switch($details['mime']) {
+      switch($mime) {
 
          case 'image/jpeg':
 
@@ -1302,32 +1448,66 @@ class PHPFSPOT {
             }
 
             $src_img = @imagecreatefromjpeg($orig_image);
+            $handler = "gd";
             break;
 
          case 'image/png':
 
             $src_img = @imagecreatefrompng($orig_image);
+            $handler = "gd";
+            break;
+
+         case 'image/x-portable-pixmap':
+
+            $src_img = new Imagick($orig_image);
+            $handler = "imagick";
             break;
 
       }
 
-      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
@@ -1369,48 +1549,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_hori) {
-         $this->_debug("(FLIP)");
-         $dst_img = $this->flipImage($dst_img, 'hori');
-      }
-      /* needs the image to be flipped vertical? */
-      if($flip_vert) {
-         $this->_debug("(FLIP)");
-         $dst_img = $this->flipImage($dst_img, 'vert');
-      }
+            imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255));
 
-      if($rotate) {
-         $this->_debug("(ROTATE)");
-         $dst_img = $this->rotateImage($dst_img, $rotate);
-      }
+            /* copies resized portion of original image into new image */
+            imagecopyresampled($dst_img, $src_img, 0, 0, 0, 0, $new_w, $new_h, imagesx($src_img), imagesy($src_img));
+
+            /* needs the image to be flipped horizontal? */
+            if($flip_hori) {
+               $this->_debug("(FLIP)");
+               $dst_img = $this->flipImage($dst_img, 'hori');
+            }
+            /* needs the image to be flipped vertical? */
+            if($flip_vert) {
+               $this->_debug("(FLIP)");
+               $dst_img = $this->flipImage($dst_img, 'vert');
+            }
 
-      /* write down new generated file */
-      $result = imagejpeg($dst_img, $thumb_image, 75);
+            if($rotate) {
+               $this->_debug("(ROTATE)");
+               $dst_img = $this->rotateImage($dst_img, $rotate);
+            }
 
-      /* free your mind */
-      imagedestroy($dst_img);
-      imagedestroy($src_img);
+            /* write down new generated file */
+            $result = imagejpeg($dst_img, $thumb_image, 75);
 
-      if($result === false) {
-         print "Can't write thumbnail ". $thumb_image ."\n";
-         return false;
-      }
+            /* free your mind */
+            imagedestroy($dst_img);
+            imagedestroy($src_img);
 
-      return true;
+            if($result === false) {
+               print "Can't write thumbnail ". $thumb_image ."\n";
+               return false;
+            }
+
+            return true;
+
+            break;
+
+         case 'imagick':
+
+            $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)
    {
@@ -1449,6 +1675,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)
    {
@@ -1458,6 +1687,7 @@ class PHPFSPOT {
          $this->cfg->thumb_width,
          $this->cfg->photo_width,
          $this->cfg->mini_width,
+         30,
       );
 
       /* get details from F-Spot's database */
@@ -1476,10 +1706,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) {
@@ -1531,6 +1778,8 @@ class PHPFSPOT {
     *
     * this function queries the phpfspot database for a
     * stored MD5 checksum of the specified photo
+    * @param integer $idx
+    * @return string|null
     */
    public function getMD5($idx)
    {
@@ -1550,6 +1799,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
+    * @param integer $idx
+    * @param string $md5
     */
    private function setMD5($idx, $md5)
    {
@@ -1565,6 +1816,8 @@ class PHPFSPOT {
     *
     * this function stores the current tag condition
     * (AND or OR) in the users session variables
+    * @param string $mode
+    * @return string
     */
    public function setTagCondition($mode)
    {
@@ -1582,6 +1835,7 @@ class PHPFSPOT {
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.
+    * @return string
     */
    public function startSearch()
    {
@@ -1632,6 +1886,8 @@ class PHPFSPOT {
     *
     * this function is invoked by RPC and will sort the requested
     * sort order in the session variable.
+    * @param string $sort_order
+    * @return string
     */
    public function updateSortOrder($order)
    {
@@ -1649,6 +1905,9 @@ class PHPFSPOT {
     *
     * this function rotates the image according the
     * specified angel.
+    * @param string $img
+    * @param integer $degress
+    * @return image
     */
    private function rotateImage($img, $degrees)
    {
@@ -1726,6 +1985,9 @@ class PHPFSPOT {
     *
     * this function will return an either horizontal or
     * vertical flipped truecolor image.
+    * @param string $image
+    * @param string $mode 
+    * @return image
     */
    private function flipImage($image, $mode)
    {
@@ -1752,6 +2014,8 @@ class PHPFSPOT {
 
    /**
     * return all assigned tags for the specified photo
+    * @param integer $idx
+    * @return array
     */
    private function get_photo_tags($idx)
    {
@@ -1765,8 +2029,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;
 
@@ -1774,6 +2041,11 @@ class PHPFSPOT {
 
    /**
     * create on-the-fly images with text within
+    * @param string $txt
+    * @param string $color
+    * @param integer $space
+    * @param integer $font
+    * @param integer $w
     */
    public function showTextImage($txt, $color=000000, $space=4, $font=4, $w=300)
    {
@@ -1803,6 +2075,7 @@ class PHPFSPOT {
 
    /**
     * check if all requirements are met
+    * @return boolean
     */
    private function check_requirements()
    {
@@ -1857,16 +2130,29 @@ class PHPFSPOT {
 
    /**
     * check if specified MIME type is supported
+    * @param string $mime
+    * @return boolean
     */
    public function checkifImageSupported($mime)
    {
-      if(in_array($mime, Array("image/jpeg", "image/png")))
+      $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) {
@@ -1889,6 +2175,8 @@ class PHPFSPOT {
 
    /**
     * output calendard input fields
+    * @param string $mode
+    * @return string
     */
    private function get_calendar($mode)
    {
@@ -1915,6 +2203,9 @@ class PHPFSPOT {
 
    /**
     * output calendar matrix
+    * @param integer $year
+    * @param integer $month
+    * @param integer $day
     */
    public function get_calendar_matrix($year = 0, $month = 0, $day = 0)
    {
@@ -1993,6 +2284,7 @@ class PHPFSPOT {
 
    /**
     * output export page
+    * @param string $mode
     */
    public function getExport($mode)
    {
@@ -2001,7 +2293,7 @@ class PHPFSPOT {
 
       foreach($pictures as $picture) {
 
-         $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture;
+         $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture;
          if($current_tags != "") {
             $orig_url.= "&tags=". $current_tags;
          } 
@@ -2009,7 +2301,12 @@ class PHPFSPOT {
             $orig_url.= "&from_date=". $_SESSION['from_date'] ."&to_date=". $_SESSION['to_date'];
          }
 
-         $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         if($this->is_user_friendly_url()) {
+            $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width;
+         }
+         else {
+            $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         }
 
          switch($mode) {
 
@@ -2058,7 +2355,7 @@ class PHPFSPOT {
 
       foreach($pictures as $picture) {
 
-         $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture;
+         $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture;
          if($current_tags != "") {
             $orig_url.= "&tags=". $current_tags;
          } 
@@ -2068,7 +2365,13 @@ class PHPFSPOT {
 
          $details = $this->get_photo_details($picture);
 
-         $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         if($this->is_user_friendly_url()) {
+            $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width;
+         }
+         else {
+            $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         }
+
          $thumb_html = htmlspecialchars("
 <a href=\"". $orig_url ."\"><img src=\"". $thumb_url ."\" /></a>
 <br>
@@ -2108,6 +2411,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
+    * @return array
     */
    private function getCurrentTags()
    {
@@ -2139,11 +2443,11 @@ class PHPFSPOT {
     * to do next. This is necessary for directly jumping
     * into photo index or single photo view when the are
     * requested with specific URLs
+    * @return string
     */
    public function whatToDo()
    {
       if(isset($_SESSION['current_photo']) && $_SESSION['start_action'] == 'showp') {
-         return "show_photo";
       }
       elseif(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags'])) {
          return "showpi_tags";
@@ -2152,12 +2456,11 @@ class PHPFSPOT {
          return "showpi";
       }
 
-      return "nothing special";
-
    } // whatToDo()
 
    /**
     * return the current process-user
+    * @return string
     */
    private function getuid()
    {
@@ -2173,6 +2476,9 @@ class PHPFSPOT {
 
    /**
     * returns a select-dropdown box to select photo index sort parameters
+    * @param array $params
+    * @param smarty $smarty
+    * @return string
     */
    public function smarty_sort_select_list($params, &$smarty)
    {
@@ -2192,6 +2498,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
+    * @return string
     */ 
    private function get_sort_order()
    {
@@ -2228,12 +2535,13 @@ class PHPFSPOT {
 
    } // get_sort_order()
 
-   /***
-     * return the next to be shown slide show image
-     *
-     * this function returns the URL of the next image
-     * in the slideshow sequence.
-     */
+   /**
+    * return the next to be shown slide show image
+    *
+    * this function returns the URL of the next image
+    * in the slideshow sequence.
+    * @return string
+    */
    public function getNextSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();
@@ -2243,16 +2551,21 @@ class PHPFSPOT {
       else
          $_SESSION['slideshow_img']++;
 
-      return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
+      if($this->is_user_friendly_url()) {
+         return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width;
+      }
+
+      return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
 
    } // getNextSlideShowImage()
 
-   /***
-     * return the previous to be shown slide show image
-     *
-     * this function returns the URL of the previous image
-     * in the slideshow sequence.
-     */
+   /**
+    * return the previous to be shown slide show image
+    *
+    * this function returns the URL of the previous image
+    * in the slideshow sequence.
+    * @return string
+    */
    public function getPrevSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();
@@ -2262,7 +2575,11 @@ class PHPFSPOT {
       else
          $_SESSION['slideshow_img']--;
 
-      return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
+      if($this->is_user_friendly_url()) {
+         return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width;
+      }
+
+      return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
 
    } // getPrevSlideShowImage()
 
@@ -2273,25 +2590,41 @@ class PHPFSPOT {
 
    } // resetSlideShow()
    
-   /***
-     * get random photo
-     *
-     * this function will get all photos from the fspot
-     * database and randomly return ONE entry
-     *
-     * saddly there is yet no sqlite3 function which returns
-     * the bulk result in array, so we have to fill up our
-     * own here.
-     */ 
+   /**
+    * get random photo
+    *
+    * this function will get all photos from the fspot
+    * database and randomly return ONE entry
+    *
+    * saddly there is yet no sqlite3 function which returns
+    * the bulk result in array, so we have to fill up our
+    * own here.
+    * @return array
+    */
    public function get_random_photo()
    {
       $all = Array();
 
-      $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']);
       }
@@ -2300,12 +2633,64 @@ class PHPFSPOT {
 
    } // get_random_photo()
 
+   /**
+    * get random photo tag photo
+    *
+    * this function will get all photos tagged with the requested
+    * tag from the fspot database and randomly return ONE entry
+    *
+    * saddly there is yet no sqlite3 function which returns
+    * the bulk result in array, so we have to fill up our
+    * own here.
+    * @return array
+    */
+   public function get_random_tag_photo($tagidx)
+   {
+      $all = Array();
+
+      $query_str = "
+         SELECT p.id
+         FROM photos p
+         INNER JOIN photo_tags pt
+            ON p.id=pt.photo_id
+      ";
+
+      if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+         $query_str.= "
+            INNER JOIN tags t
+               ON pt.tag_id=t.id
+         ";
+      }
+      $query_str.= "
+         WHERE
+            pt.tag_id LIKE '". $tagidx ."'
+      ";
+
+      /*if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+         $query_str.= "
+           AND
+               t.name IN ('".implode("','",$this->cfg->show_tags)."')
+         ";
+      }*/
+
+      $result = $this->db->db_query($query_str);
+
+      while($row = $this->db->db_fetch_object($result)) {
+         array_push($all, $row['id']);
+      }
+
+      return $all[array_rand($all)];
+
+   } // get_random_tag_photo()
+
    /**
     * validates provided date
     *
     * this function validates if the provided date
     * contains a valid date and will return true 
     * if it is.
+    * @param string $date_str
+    * @return boolean
     */
    public function isValidDate($date_str)
    {
@@ -2320,15 +2705,24 @@ class PHPFSPOT {
 
    /**
     * timestamp to string conversion
+    * @param integer $timestamp
+    * @return string
     */
    private function ts2str($timestamp)
    {
-      return strftime("%Y-%m-%d", $timestamp);
+      if(!empty($timestamp) && is_numeric($timestamp))
+         return strftime("%Y-%m-%d", $timestamp);
+
    } // ts2str()
 
+   /**
+    * extract tag-names from $_GET['tags']
+    * @param string $tags_str
+    * @return string
+    */
    private function extractTags($tags_str)
    {
-      $not_validated = split(',', $_GET['tags']);
+      $not_validated = split(',', $tags_str);
       $validated = array();
 
       foreach($not_validated as $tag) {
@@ -2342,6 +2736,9 @@ class PHPFSPOT {
 
    /**
     * returns the full path to a thumbnail
+    * @param integer $width
+    * @param integer $photo
+    * @return string
     */
    public function get_thumb_path($width, $photo)
    {
@@ -2359,6 +2756,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
+    * @return string
     */
    private function get_server_name()
    {
@@ -2366,8 +2764,8 @@ class PHPFSPOT {
    } // get_server_name()
 
    /**
-    * returns type of webprotocol which is
-    * currently used
+    * returns type of webprotocol which is currently used
+    * @return string
     */
    private function get_web_protocol()
    {
@@ -2379,14 +2777,18 @@ 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)
    {
@@ -2410,6 +2812,9 @@ class PHPFSPOT {
     * returns true, if everything is ok, otherwise false
     * if $silent is not set, this function will output and
     * error message
+    * @param string $file
+    * @param boolean $silent
+    * @return boolean
     */
    private function check_readable($file, $silent = null)
    {
@@ -2454,6 +2859,7 @@ class PHPFSPOT {
     *
     * this function will return the F-Spot database version number
     * It is stored within the sqlite3 database in the table meta
+    * @return string|null
     */
    public function getFspotDBVersion()
    {
@@ -2470,8 +2876,10 @@ class PHPFSPOT {
    } // getFspotDBVersion()
 
    /**
-    * parse the provided URI and will returned the
-    * requested chunk
+    * parse the provided URI and will returned the requested chunk
+    * @param string $uri
+    * @param string $mode
+    * @return string
     */
    public function parse_uri($uri, $mode)
    {
@@ -2499,6 +2907,7 @@ class PHPFSPOT {
     *
     * this function checks if all necessary configuration options are
     * specified and set.
+    * @return boolean
     */
    private function check_config_options()
    {
@@ -2566,9 +2975,11 @@ class PHPFSPOT {
 
       }
 
-      /* check for pending slash on web_path */
-      if(!preg_match("/\/$/", $this->cfg->web_path))
-         $this->cfg->web_path.= "/";
+      /* remove trailing slash, if set */
+      if($this->cfg->web_path == "/")
+         $this->cfg->web_path = "";
+      elseif(preg_match('/\/$/', $this->cfg->web_path))
+         $this->cfg->web_path = preg_replace('/\/$/', '', $this->cfg->web_path);
 
       return $this->runtime_error;
 
@@ -2618,6 +3029,9 @@ class PHPFSPOT {
     * current page, in which the $current photo lies. this is
     * used to display the correct photo, when calling showPhotoIndex()
     * from showImage()
+    * @param integer $current
+    * @param integer $max
+    * @return integer
     */
    private function getCurrentPage($current, $max)
    {
@@ -2631,6 +3045,134 @@ class PHPFSPOT {
 
    } // getCurrentPage()
 
+   /**
+    * return mime info
+    *
+    * this function tries to find out the correct mime-type
+    * for the provided file.
+    * @param string $file
+    * @return string
+    */
+   public function get_mime_info($file)
+   {
+      $details = getimagesize($file);
+
+      /* if getimagesize() returns empty, try at least to find out the
+         mime type.
+      */
+      if(empty($details) && function_exists('mime_content_type')) {
+
+         // mime_content_type is marked as deprecated in the documentation,
+         // but is it really necessary to force users to install a PECL
+         // extension?
+         $details['mime'] = mime_content_type($file);
+      }
+
+      return $details['mime'];
+
+   } // get_mime_info()
+
+   /**
+    * return tag-name by tag-idx
+    *
+    * this function returns the tag-name for the requested
+    * tag specified by tag-idx.
+    * @param integer $idx
+    * @return string
+    */
+   public function get_tag_name($idx)
+   {
+       if($result = $this->db->db_fetchSingleRow("
+         SELECT name
+         FROM tags
+         WHERE
+            id LIKE '". $idx ."'")) {
+
+         return $result['name'];
+
+      }
+
+      return 0;
+      
+   } // get_tag_name()
+
+   /**
+    * parse user friendly url which got rewritten by the websever
+    * @param string $request_uri
+    * @return string
+    */
+   private function parse_user_friendly_url($request_uri)
+   {
+      if(preg_match('/\/photoview\/|\/photo\/|\/tag\//', $request_uri)) {
+
+         unset($_SESSION['start_action']);
+         unset($_SESSION['selected_tags']);
+
+         $options = explode('/', $request_uri);
+
+         switch($options[1]) {
+            case 'photoview':
+               if(is_numeric($options[2])) {
+                  $_GET['mode'] = 'showp';
+                  return $this->showPhoto($options[2]);
+               }
+               break;
+            case 'photo':
+               if(is_numeric($options[2])) {
+                  require_once "phpfspot_img.php";
+                  $img = new PHPFSPOT_IMG;
+                  if(isset($options[3]) && is_numeric($options[3]))
+                     $img->showImg($options[2], $options[3]);
+                  else
+                     $img->showImg($options[2]);
+               }
+               exit;
+               break;
+            case 'tag':
+               if(is_numeric($options[2])) {
+                  $this->session_cleanup();
+                  $_GET['tags'] = $options[2];
+                  $_SESSION['selected_tags'] = Array($options[2]);
+                  return $this->showPhotoIndex();
+               }
+               break;
+         }
+      }
+
+   } // parse_user_friendly_url()
+
+   /**
+    * check if user-friendly-urls are enabled
+    *
+    * this function will return true, if the config option
+    * $user_friendly_url has been set. Otherwise false.
+    * @return boolean
+    */
+   private function is_user_friendly_url()
+   {
+      if(isset($this->cfg->user_friendly_url) && $this->cfg->user_friendly_url)
+         return true;
+
+      return false;
+
+   } // is_user_friendly_url()
+
+   /**
+    * session cleanup
+    *
+    * this function will cleanup user's session information
+    */
+   private function session_cleanup()
+   {
+      unset($_SESSION['begin_with']);
+      $this->resetDateSearch();
+      $this->resetPhotoView();
+      $this->resetTagSearch();
+      $this->resetNameSearch();
+      $this->resetDateSearch();
+
+   } // session_cleanup()
+
 } // class PHPFSPOT
 
 ?>