X-Git-Url: https://git.nubati.net/cgi-bin/gitweb.cgi?p=phpfspot.git;a=blobdiff_plain;f=phpfspot.class.php;h=b8f45a898e2bdb5a10264226fe8f15e59e362e03;hp=3b4a62e9166abc2a420de0780bcd9b4fea7cb60f;hb=b583a04ebad60d02349b78f8c38353e0cb3eb9ea;hpb=072aed3d53445a6b09edabf1551706de4c3f1cb1

diff --git a/phpfspot.class.php b/phpfspot.class.php
index 3b4a62e..b8f45a8 100644
--- 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
@@ -24,20 +25,76 @@
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 
+/**
+ * PHPFSPOT main class
+ *
+ * @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 +102,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 */
@@ -131,7 +196,7 @@ 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();
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();
@@ -321,6 +386,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)
    {
@@ -377,6 +444,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)
    {
@@ -397,6 +467,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)
    {
@@ -414,8 +487,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);
 
@@ -426,6 +501,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
+    * @param integer photo
     */
    public function showPhoto($photo)
    {
@@ -464,7 +540,7 @@ class PHPFSPOT {
          return;
       }
 
-      $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+      $orig_path = $this->translate_path($this->parse_uri($details['uri']));
       $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
 
       if(!file_exists($orig_path)) {
@@ -483,8 +559,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);
       }
 
@@ -492,7 +571,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]; 
       }
 
@@ -516,13 +594,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);
@@ -643,6 +721,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()
    {
@@ -675,6 +754,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)
    {
@@ -697,6 +777,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
+    * @param string $tag
+    * @return string
     */
    public function delTag($tag)
    {
@@ -728,6 +810,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
+    * @return string
     */
    public function get_xml_tag_list()
    {
@@ -836,6 +919,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()
    {  
@@ -1256,6 +1340,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)
    {  
@@ -1408,6 +1496,8 @@ class PHPFSPOT {
 
    /**
     * return all exif meta data from the file
+    * @param string $file
+    * @return array
     */
    public function get_meta_informations($file)
    {
@@ -1446,6 +1536,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)
    {
@@ -1461,7 +1554,7 @@ class PHPFSPOT {
       $details = $this->get_photo_details($idx);
 
       /* calculate file MD5 sum */
-      $full_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+      $full_path = $this->translate_path($this->parse_uri($details['uri']));
 
       if(!file_exists($full_path)) {
          $this->_error("File ". $full_path ." does not exist\n");
@@ -1528,6 +1621,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)
    {
@@ -1547,6 +1642,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
+    * @param integer $idx
+    * @param string $md5
     */
    private function setMD5($idx, $md5)
    {
@@ -1562,6 +1659,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)
    {
@@ -1579,6 +1678,7 @@ class PHPFSPOT {
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.
+    * @return string
     */
    public function startSearch()
    {
@@ -1629,6 +1729,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)
    {
@@ -1646,6 +1748,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)
    {
@@ -1723,6 +1828,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)
    {
@@ -1749,6 +1857,8 @@ class PHPFSPOT {
 
    /**
     * return all assigned tags for the specified photo
+    * @param integer $idx
+    * @return array
     */
    private function get_photo_tags($idx)
    {
@@ -1771,6 +1881,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)
    {
@@ -1800,6 +1915,7 @@ class PHPFSPOT {
 
    /**
     * check if all requirements are met
+    * @return boolean
     */
    private function check_requirements()
    {
@@ -1854,6 +1970,8 @@ class PHPFSPOT {
 
    /**
     * check if specified MIME type is supported
+    * @param string $mime
+    * @return boolean
     */
    public function checkifImageSupported($mime)
    {
@@ -1864,6 +1982,10 @@ class PHPFSPOT {
 
    } // checkifImageSupported()
 
+   /**
+    * output error text
+    * @param string $text
+    */
    public function _error($text)
    {
       switch($this->cfg->logging) {
@@ -1886,6 +2008,8 @@ class PHPFSPOT {
 
    /**
     * output calendard input fields
+    * @param string $mode
+    * @return string
     */
    private function get_calendar($mode)
    {
@@ -1912,6 +2036,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)
    {
@@ -1990,6 +2117,7 @@ class PHPFSPOT {
 
    /**
     * output export page
+    * @param string $mode
     */
    public function getExport($mode)
    {
@@ -2071,7 +2199,7 @@ class PHPFSPOT {
 <br>
 ". $details['description']);
 
-         $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
+         $orig_path = $this->translate_path($this->parse_uri($details['uri']));
 
          /* get EXIF information if JPEG */
          if($details['mime'] == "image/jpeg") {
@@ -2105,6 +2233,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
+    * @return array
     */
    private function getCurrentTags()
    {
@@ -2136,6 +2265,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()
    {
@@ -2155,6 +2285,7 @@ class PHPFSPOT {
 
    /**
     * return the current process-user
+    * @return string
     */
    private function getuid()
    {
@@ -2170,6 +2301,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)
    {
@@ -2189,6 +2323,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
+    * @return string
     */ 
    private function get_sort_order()
    {
@@ -2225,12 +2360,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();
@@ -2244,12 +2380,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();
@@ -2270,16 +2407,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();
@@ -2303,6 +2441,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)
    {
@@ -2317,15 +2457,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) {
@@ -2339,6 +2486,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)
    {
@@ -2356,6 +2506,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
+    * @return string
     */
    private function get_server_name()
    {
@@ -2363,8 +2514,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()
    {
@@ -2376,6 +2527,7 @@ class PHPFSPOT {
 
    /**
     * return url to this phpfspot installation
+    * @return string
     */
    private function get_phpfspot_url()
    {
@@ -2384,6 +2536,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)
    {
@@ -2407,6 +2561,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
+    * @retrun boolean
     */
    private function check_readable($file, $silent = null)
    {
@@ -2451,6 +2608,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()
    {
@@ -2467,8 +2625,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)
    {
@@ -2496,6 +2656,7 @@ class PHPFSPOT {
     *
     * this function checks if all necessary configuration options are
     * specified and set.
+    * @return boolean
     */
    private function check_config_options()
    {
@@ -2615,6 +2776,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)
    {