Merge commit 'origin/master' into nefformat
[phpfspot.git] / phpfspot.class.php
index 3f7f7b299289fa3747006e4c3a3b5fc5a29ad40f..eb2312bf709a9b5ff0302d4538fa18480e6c2a1b 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,
@@ -45,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 */
@@ -66,23 +134,31 @@ class PHPFSPOT {
       );
 
       /* 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);
@@ -93,22 +169,37 @@ class PHPFSPOT {
          exit(1);
       }
 
-      $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);
+      /******* Opening phpfspot's sqlite database *********/
+
+      /* Check if directory where the database file is stored is writeable  */
+      if(!is_writeable(dirname($this->cfg->phpfspot_db))) {
+         print dirname($this->cfg->phpfspot_db) .": directory is not writeable for user ". $this->getuid() ."\n";
+         exit(1);
+      }
+
+      /* Check if database file is writeable */
       if(!is_writeable($this->cfg->phpfspot_db)) {
          print $this->cfg->phpfspot_db ." is not writeable for user ". $this->getuid() ."\n";
          exit(1);
       }
 
-      $this->check_config_table();
+      /* open the database */
+      $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);
 
-      /* include Smarty template engine */
-      if(!$this->check_readable($this->cfg->smarty_path .'/libs/Smarty.class.php')) {
-         exit(1);
+      /* change sqlite temp directory, if requested */
+      if(isset($this->cfg->sqlite_temp_dir)) {
+         $this->cfg_db->db_exec("
+            PRAGMA
+               temp_store_directory = '". $this->cfg->sqlite_temp_dir ."'
+         ");
       }
-      require $this->cfg->smarty_path .'/libs/Smarty.class.php';
-      /* overload Smarty class if our own template handler */
+
+      /* Check if some tables need to be created */
+      $this->check_config_table();
+
+      /* overload Smarty class with our own template handler */
       require_once "phpfspot_tmpl.php";
-      $this->tmpl = new PHPFSPOT_TMPL($this);
+      $this->tmpl = new PHPFSPOT_TMPL();
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();
@@ -298,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)
    {
@@ -354,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)
    {
@@ -374,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)
    {
@@ -391,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);
 
@@ -403,6 +504,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
+    * @param integer photo
     */
    public function showPhoto($photo)
    {
@@ -460,8 +562,11 @@ class PHPFSPOT {
          $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 */
-      if($details['mime'] == "image/jpeg") {
+      if($info['mime'] == "image/jpeg") {
          $meta = $this->get_meta_informations($orig_path);
       }
 
@@ -469,7 +574,6 @@ class PHPFSPOT {
       if(isset($meta['ExifImageWidth'])) {
          $meta_res = $meta['ExifImageWidth'] ."x". $meta['ExifImageLength'];
       } else {
-         $info = getimagesize($orig_path);
          $meta_res = $info[0] ."x". $info[1]; 
       }
 
@@ -493,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);
@@ -523,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));
 
@@ -563,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));
@@ -576,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) {
@@ -591,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>, ";
          }
 
       }
@@ -608,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()
    {
@@ -640,6 +757,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)
    {
@@ -662,6 +780,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
+    * @param string $tag
+    * @return string
     */
    public function delTag($tag)
    {
@@ -693,6 +813,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
+    * @return string
     */
    public function get_xml_tag_list()
    {
@@ -801,6 +922,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()
    {  
@@ -1221,6 +1343,10 @@ class PHPFSPOT {
     * 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)
    {  
@@ -1397,6 +1523,8 @@ class PHPFSPOT {
 
    /**
     * return all exif meta data from the file
+    * @param string $file
+    * @return array
     */
    public function get_meta_informations($file)
    {
@@ -1435,6 +1563,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)
    {
@@ -1517,6 +1648,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)
    {
@@ -1536,6 +1669,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
+    * @param integer $idx
+    * @param string $md5
     */
    private function setMD5($idx, $md5)
    {
@@ -1551,6 +1686,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)
    {
@@ -1568,6 +1705,7 @@ class PHPFSPOT {
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.
+    * @return string
     */
    public function startSearch()
    {
@@ -1618,6 +1756,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)
    {
@@ -1635,6 +1775,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)
    {
@@ -1712,6 +1855,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)
    {
@@ -1738,6 +1884,8 @@ class PHPFSPOT {
 
    /**
     * return all assigned tags for the specified photo
+    * @param integer $idx
+    * @return array
     */
    private function get_photo_tags($idx)
    {
@@ -1760,6 +1908,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)
    {
@@ -1789,8 +1942,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";
@@ -1819,6 +1973,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))
@@ -1826,7 +1985,7 @@ class PHPFSPOT {
 
       return true;
 
-   } // checkRequirements()
+   } // check_requirements()
 
    private function _debug($text)
    {
@@ -1838,6 +1997,8 @@ class PHPFSPOT {
 
    /**
     * check if specified MIME type is supported
+    * @param string $mime
+    * @return boolean
     */
    public function checkifImageSupported($mime)
    {
@@ -1848,6 +2009,10 @@ class PHPFSPOT {
 
    } // checkifImageSupported()
 
+   /**
+    * output error text
+    * @param string $text
+    */
    public function _error($text)
    {
       switch($this->cfg->logging) {
@@ -1870,6 +2035,8 @@ class PHPFSPOT {
 
    /**
     * output calendard input fields
+    * @param string $mode
+    * @return string
     */
    private function get_calendar($mode)
    {
@@ -1896,6 +2063,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)
    {
@@ -1974,6 +2144,7 @@ class PHPFSPOT {
 
    /**
     * output export page
+    * @param string $mode
     */
    public function getExport($mode)
    {
@@ -2089,6 +2260,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
+    * @return array
     */
    private function getCurrentTags()
    {
@@ -2120,6 +2292,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()
    {
@@ -2139,6 +2312,7 @@ class PHPFSPOT {
 
    /**
     * return the current process-user
+    * @return string
     */
    private function getuid()
    {
@@ -2154,6 +2328,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)
    {
@@ -2173,6 +2350,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
+    * @return string
     */ 
    private function get_sort_order()
    {
@@ -2209,12 +2387,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();
@@ -2228,12 +2407,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();
@@ -2254,16 +2434,17 @@ 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();
@@ -2287,6 +2468,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)
    {
@@ -2301,15 +2484,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) {
@@ -2323,6 +2513,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)
    {
@@ -2340,6 +2533,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
+    * @return string
     */
    private function get_server_name()
    {
@@ -2347,8 +2541,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()
    {
@@ -2360,6 +2554,7 @@ class PHPFSPOT {
 
    /**
     * return url to this phpfspot installation
+    * @return string
     */
    private function get_phpfspot_url()
    {
@@ -2368,6 +2563,8 @@ class PHPFSPOT {
 
    /**
     * returns the number of photos which are tagged with $tag_id
+    * @param integer $tag_id
+    * @return integer
     */
    public function get_num_photos($tag_id)
    {
@@ -2391,6 +2588,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)
    {
@@ -2435,6 +2635,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()
    {
@@ -2451,8 +2652,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)
    {
@@ -2480,6 +2683,7 @@ class PHPFSPOT {
     *
     * this function checks if all necessary configuration options are
     * specified and set.
+    * @return boolean
     */
    private function check_config_options()
    {
@@ -2599,6 +2803,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)
    {