use smaller action icons

[phpfspot.git] / phpfspot.class.php

diff --git a/phpfspot.class.php b/phpfspot.class.php
index 3b4a62e9166abc2a420de0780bcd9b4fea7cb60f..badc728980262accbed01b66789e88c5b4b4aec8 100644 (file)
--- a/phpfspot.class.php
+++ b/phpfspot.class.php
@@ -2,8 +2,9 @@
 
 /***************************************************************************
  *
 
 /***************************************************************************
  *

- * Copyright (c) by Andreas Unterkircher, unki@netshadow.at
- * All rights reserved
+ * phpfspot, presents your F-Spot photo collection in Web browsers.
+ *
+ * Copyright (c) by Andreas Unterkircher

  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by


@@ -24,20 +25,79 @@
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 
 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 {
 
 class PHPFSPOT {
 

+   /**
+     * phpfspot configuration
+     * @access public
+     * @see PHPFSPOT_CFG()
+     * @var PHPFSPOT_CFG
+     */

    var $cfg;
    var $cfg;

+
+   /**
+     * SQLite database handle to f-spot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */

    var $db;
    var $db;

+
+   /**
+     * SQLite database handle to phpfspot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */

    var $cfg_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;
    var $tmpl;

+
+   /**
+    * full tag - list
+    * @access public
+    * @var array
+    */

    var $tags;
    var $tags;

+
+   /**
+    * list of available, not-selected, tags
+    * @access public
+    * @var array
+    */

    var $avail_tags;
 
    var $avail_tags;
 

+   /**
+    * true if runtime error occued
+    * @access private
+    * @var boolean
+    */

    private $runtime_error = false;
    private $runtime_error = false;

+
+   /**
+    * F-Spot database version
+    * @access private
+    * @var integer
+    */

    private $dbver;
 
    /**
    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,
     *
     * this function will be called on class construct
     * and will check requirements, loads configuration,


@@ -45,6 +105,14 @@ class PHPFSPOT {
     */
    public function __construct()
    {
     */
    public function __construct()
    {

+      /**
+       * register PHPFSPOT class global
+       *
+       * @global PHPFSPOT $GLOBALS['phpfspot']
+       * @name $phpfspot
+       */
+      $GLOBALS['phpfspot'] =& $this;
+

       $this->cfg = new PHPFSPOT_CFG;
 
       /* verify config settings */
       $this->cfg = new PHPFSPOT_CFG;
 
       /* verify config settings */


@@ -54,7 +122,7 @@ class PHPFSPOT {
 
       /* set application name and version information */
       $this->cfg->product = "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 ↑',
 
       $this->sort_orders= array(
          'date_asc' => 'Date ↑',


@@ -131,7 +199,7 @@ class PHPFSPOT {
 
       /* overload Smarty class with our own template handler */
       require_once "phpfspot_tmpl.php";
 
       /* 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();
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();


@@ -176,6 +244,11 @@ class PHPFSPOT {
       $this->tmpl->assign('current_condition', $_SESSION['tag_condition']);
       $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name);
 
       $this->tmpl->assign('current_condition', $_SESSION['tag_condition']);
       $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name);
 

+      /* parse URL */
+      if(isset($this->cfg->user_friendly_url) && $this->cfg->user_friendly_url) {
+         $content = $this->parse_user_friendly_url($_SERVER['REQUEST_URI']);
+      }
+

       if(isset($_GET['mode'])) {
 
          $_SESSION['start_action'] = $_GET['mode'];
       if(isset($_GET['mode'])) {
 
          $_SESSION['start_action'] = $_GET['mode'];


@@ -238,7 +311,12 @@ class PHPFSPOT {
       $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->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');
+
+      if(!isset($content))
+         $this->tmpl->assign('content_page', $this->tmpl->fetch('welcome.tpl'));
+      else
+         $this->tmpl->assign('content_page', $content);
+

       $this->tmpl->show("index.tpl");
 
    } // show()
       $this->tmpl->show("index.tpl");
 
    } // show()


@@ -321,6 +399,8 @@ class PHPFSPOT {
     * 
     * retrieve all available details from f-spot's
     * database and return them as object
     * 
     * 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)
    {
     */
    public function get_photo_details($idx)
    {


@@ -377,6 +457,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 (...)
     * 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)
    {
     */
    public function getPhotoName($idx, $limit = 0)
    {


@@ -397,6 +480,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 "..." 
     * 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)
    {
     */
    private function shrink_text($text, $limit)
    {


@@ -414,8 +500,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
     * 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);
 
    {  
       return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
 


@@ -426,6 +514,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
     *
     * this function provides all the necessary information
     * for the single photo template.

+    * @param integer photo

     */
    public function showPhoto($photo)
    {
     */
    public function showPhoto($photo)
    {


@@ -483,8 +572,11 @@ class PHPFSPOT {
          $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
       }
 
          $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
       }
 

+      /* get mime-type, height and width from the original photo */
+      $info = getimagesize($orig_path);
+

       /* get EXIF information if JPEG */
       /* get EXIF information if JPEG */

-      if($details['mime'] == "image/jpeg") {
+      if($info['mime'] == "image/jpeg") {

          $meta = $this->get_meta_informations($orig_path);
       }
 
          $meta = $this->get_meta_informations($orig_path);
       }
 


@@ -492,7 +584,6 @@ class PHPFSPOT {
       if(isset($meta['ExifImageWidth'])) {
          $meta_res = $meta['ExifImageWidth'] ."x". $meta['ExifImageLength'];
       } else {
       if(isset($meta['ExifImageWidth'])) {
          $meta_res = $meta['ExifImageWidth'] ."x". $meta['ExifImageLength'];
       } else {

-         $info = getimagesize($orig_path);

          $meta_res = $info[0] ."x". $info[1]; 
       }
 
          $meta_res = $info[0] ."x". $info[1]; 
       }
 


@@ -516,19 +607,23 @@ class PHPFSPOT {
          return;
       }
 
          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('description', $details['description']);
       $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename'));
 

-      $this->tmpl->assign('width', $info[0]);
-      $this->tmpl->assign('height', $info[1]);
+      $this->tmpl->assign('width', $info_thumb[0]);
+      $this->tmpl->assign('height', $info_thumb[1]);

       $this->tmpl->assign('ExifMadeOn', $meta_date);
       $this->tmpl->assign('ExifMadeWith', $meta_make);
       $this->tmpl->assign('ExifOrigResolution', $meta_res);
       $this->tmpl->assign('ExifFileSize', $meta_size);
  
       $this->tmpl->assign('ExifMadeOn', $meta_date);
       $this->tmpl->assign('ExifMadeWith', $meta_make);
       $this->tmpl->assign('ExifOrigResolution', $meta_res);
       $this->tmpl->assign('ExifFileSize', $meta_size);
  

-      $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width);
+      if(!isset($this->cfg->user_friendly_url) || !$this->cfg->user_friendly_url)
+         $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width);
+      else
+         $this->tmpl->assign('image_url', '/photo/'. $photo ."/". $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('image_url_full', 'phpfspot_img.php?idx='. $photo);
       $this->tmpl->assign('image_filename', $this->parse_uri($details['uri'], 'filename'));
 


@@ -550,7 +645,7 @@ class PHPFSPOT {
       $this->tmpl->assign('photo_number', $i);
       $this->tmpl->assign('photo_count', count($all_photos));
 
       $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()
 
 
    } // showPhoto()
 


@@ -643,8 +738,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']
     * 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();
    {
       /* retrive tags from database */
       $this->get_tags();


@@ -655,7 +751,29 @@ class PHPFSPOT {
       {
          // return all selected tags
          if(isset($_SESSION['selected_tags']) && in_array($tag, $_SESSION['selected_tags'])) {
       {
          // 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=\"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=\"resources/underbar.png\" />
+                    </a>
+                   </div>
+                  </div>
+                  ";
+                  break;
+            }

          }
       }
 
          }
       }
 


@@ -675,6 +793,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
     * 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)
    {
     */
    public function addTag($tag)
    {


@@ -684,10 +803,15 @@ class PHPFSPOT {
       if(isset($_SESSION['searchfor_tag']))
          unset($_SESSION['searchfor_tag']);
 
       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);
 
       if(!in_array($tag, $_SESSION['selected_tags']))
          array_push($_SESSION['selected_tags'], $tag);
 

-

       return "ok";
    
    } // addTag()
       return "ok";
    
    } // addTag()


@@ -697,6 +821,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
     *
     * this function removes the specified tag from
     * users current tag selection

+    * @param string $tag
+    * @return string

     */
    public function delTag($tag)
    {
     */
    public function delTag($tag)
    {


@@ -728,6 +854,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
 
    /**
     * returns the value for the autocomplet tag-search

+    * @return string

     */
    public function get_xml_tag_list()
    {
     */
    public function get_xml_tag_list()
    {


@@ -836,6 +963,7 @@ class PHPFSPOT {
     * the tag-selection, tag- or date-search.
     * the tag-search also has to take care of AND
     * and OR conjunctions
     * 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()
    {  
     */
    public function getPhotoSelection()
    {  


@@ -1223,6 +1351,7 @@ class PHPFSPOT {
       $this->tmpl->assign('img_fullname', $img_fullname);
       $this->tmpl->assign('img_title', $img_title);
       $this->tmpl->assign('thumbs', $thumbs);
       $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");
 
 
       $this->tmpl->show("photo_index.tpl");
 


@@ -1250,12 +1379,16 @@ class PHPFSPOT {
    } // showCredits()
 
    /**
    } // 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.
     *
     * 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)
    {  
     */
    public function create_thumbnail($orig_image, $thumb_image, $width)
    {  


@@ -1263,13 +1396,13 @@ class PHPFSPOT {
          return false;
       }
 
          return false;
       }
 

-      $details = getimagesize($orig_image);
-      
+      $mime = $this->get_mime_info($orig_image);
+

       /* check if original photo is a support image type */
       /* check if original photo is a support image type */

-      if(!$this->checkifImageSupported($details['mime']))
+      if(!$this->checkifImageSupported($mime))

          return false;
 
          return false;
 

-      switch($details['mime']) {
+      switch($mime) {

 
          case 'image/jpeg':
 
 
          case 'image/jpeg':
 


@@ -1299,32 +1432,66 @@ class PHPFSPOT {
             }
 
             $src_img = @imagecreatefromjpeg($orig_image);
             }
 
             $src_img = @imagecreatefromjpeg($orig_image);

+            $handler = "gd";

             break;
 
          case 'image/png':
 
             $src_img = @imagecreatefrompng($orig_image);
             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;
 
       }
 
             break;
 
       }
 

-      if(!$src_img) {
+      if(!isset($src_img) || empty($src_img)) {

          print "Can't load image from ". $orig_image ."\n";
          return false;
       }
 
          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
       }
 
       // If the image will be rotate because EXIF orientation said so


@@ -1366,48 +1533,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,&nb