phpfspot

 <?php

 /***************************************************************************

  *

  * 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

  *  the Free Software Foundation; either version 2 of the License, or

  *  any later version.

  *

  *  This program is distributed in the hope that it will be useful,

  *  but WITHOUT ANY WARRANTY; without even the implied warranty of

  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  *  GNU General Public License for more details.

  *

  *  You should have received a copy of the GNU General Public License

  *  along with this program; if not, write to the Free Software

  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

  *

  ***************************************************************************/

 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 ($cfg, $db, $cfg_db, $tmpl, $db_ver)

     *

     * this function will be called on class construct

     * and will check requirements, loads configuration,

     * open databases and start the user session

     */

    public function __construct()

    {

       /**

        * register PHPFSPOT class global

        *

        * @global PHPFSPOT $GLOBALS['phpfspot']

        * @name $phpfspot

        */

       $GLOBALS['phpfspot'] =& $this;

       $this->cfg = new PHPFSPOT_CFG;

       /* verify config settings */

       if($this->check_config_options()) {

          exit(1);

       }

       /* set application name and version information */

       $this->cfg->product = "phpfspot";

       $this->cfg->version = "1.7";

       $this->cfg->db_version = 2;

       $this->sort_orders= array(

          'date_asc' => 'Date ↑',

          'date_desc' => 'Date ↓',

          'name_asc' => 'Name ↑',

          'name_desc' => 'Name ↓',

          'tags_asc' => 'Tags ↑',

          'tags_desc' => 'Tags ↓',

       );

       /* Check necessary requirements */

       if(!$this->check_requirements()) {

          exit(1);

       }

       /******* Opening F-Spot's sqlite database *********/

       /* Check if database file exists and is readable */

       if(!file_exists($this->cfg->fspot_db) || !is_readable($this->cfg->fspot_db)) {

          print "Error: ". $this->cfg->fspot_db ." does not exist or is not readable for user ". $this->getuid() .".\n";

          exit(1);

       }

       /* Check if database file is writeable */

       if(!is_writeable($this->cfg->fspot_db)) {

          print "Error: ". $this->cfg->fspot_db ." is not writeable for user ". $this->getuid() .".\n";

          print "Please fix permissions so phpfspot can create indices within the F-Spot database to"

             ." speed up some database operations.\n";

          exit(1);

       }

       /* open the database */

       $this->db  = new PHPFSPOT_DB($this, $this->cfg->fspot_db);

       /* 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 ."'

          ");

       }

       /* get F-Spot database version */

       $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);

       }

       if(!is_writeable($this->cfg->thumb_path)) {

          print $this->cfg->thumb_path .": directory is not writeable for user ". $this->getuid() ."\n";

          exit(1);

       }

       /******* Opening phpfspot's sqlite database *********/

       /* Check if directory where the database file is stored is writeable  */

       if(!is_writeable(dirname($this->cfg->phpfspot_db))) {

          print "Error: ". dirname($this->cfg->phpfspot_db) .": directory is not writeable for user ". $this->getuid() .".\n";

          print "Please fix permissions so phpfspot can create its own sqlite database to store some settings.\n";

          exit(1);

       }

       /* Check if database file is writeable */

       if(file_exists($this->cfg->phpfspot_db) && !is_writeable($this->cfg->phpfspot_db)) {

          print "Error: ". $this->cfg->phpfspot_db ." is not writeable for user ". $this->getuid() .".\n";

          print "Please fix permissions so phpfspot can create its own sqlite database to store some settings.\n";

          exit(1);

       }

       /* open the database */

       $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);

       /* 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 ."'

          ");

       }

       /* Check if some tables need to be created */

       $this->check_phpfspot_db();

       /* overload Smarty class with our own template handler */

       require_once "phpfspot_tmpl.php";

       $this->tmpl = new PHPFSPOT_TMPL();

       /* pre-set some template variables */

       $this->tmpl->assign('web_path', $this->cfg->web_path);

       /* Starting with F-Spot 0.4.2, the rating-feature was available */

       if($this->dbver > 10) {

          $this->tmpl->assign('has_rating', true);

          $this->sort_orders = array_merge($this->sort_orders, array(

             'rate_asc' => 'Rate ↑',

             'rate_desc' => 'Rate ↓',

          ));

       }

       /* check if all necessary indices exist */

       $this->checkDbIndices();

       /* if session is not yet started, do it now */

       if(session_id() == "")

          session_start();

       if(!isset($_SESSION['tag_condition']))

          $_SESSION['tag_condition'] = 'or';

       /* if sort-order has not been set yet, get the one specified in the config */

       if(!isset($_SESSION['sort_order']))

          $_SESSION['sort_order'] = $this->cfg->sort_order;

       if(!isset($_SESSION['searchfor_tag']))

          $_SESSION['searchfor_tag'] = '';

       // if begin_with is still set but thumbs_per_page is now 0, unset it

       if(isset($_SESSION['begin_with']) && $this->cfg->thumbs_per_page == 0)

          unset($_SESSION['begin_with']);

       // if user-friendly-url's are enabled, set also a flag for the template handler

       if($this->is_user_friendly_url()) {

          $this->tmpl->assign('user_friendly_url', 'true');

       }

    } // __construct()

    public function __destruct()

    {

    } // __destruct()

    /**

     * show - generate html output

     *

     * this function can be called after the constructor has

     * prepared everyhing. it will load the index.tpl smarty

     * template. if necessary it will registere pre-selects

     * (photo index, photo, tag search, date search) into

     * users session.

     */

    public function show()

    {

       $this->tmpl->assign('searchfor_tag', $_SESSION['searchfor_tag']);

       $this->tmpl->assign('page_title', $this->cfg->page_title);

       $this->tmpl->assign('current_condition', $_SESSION['tag_condition']);

       $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name);

       /* 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'];

          switch($_GET['mode']) {

             case 'showpi':

                if(isset($_GET['tags'])) {

                   $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);

                }

                if(isset($_GET['from_date']) && $this->isValidDate($_GET['from_date'])) {

                   $_SESSION['from_date'] = strtotime($_GET['from_date'] ." 00:00:00");

                }

                if(isset($_GET['to_date']) && $this->isValidDate($_GET['to_date'])) {

                   $_SESSION['to_date'] = strtotime($_GET['to_date'] ." 23:59:59");

                }

                break;

             case 'showp':

                if(isset($_GET['tags'])) {

                   $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);

                   $_SESSION['start_action'] = 'showp';

                }

                if(isset($_GET['id']) && is_numeric($_GET['id'])) {

                   if($_SESSION['current_photo'] != $_GET['id'])

                      unset($_SESSION['current_version']);

                   $_SESSION['current_photo'] = $_GET['id'];

                   $_SESSION['start_action'] = 'showp';

                }

                if(isset($_GET['from_date']) && $this->isValidDate($_GET['from_date'])) {

                   $_SESSION['from_date'] = strtotime($_GET['from_date'] ." 00:00:00");

                }

                if(isset($_GET['to_date']) && $this->isValidDate($_GET['to_date'])) {

                   $_SESSION['to_date'] = strtotime($_GET['to_date'] ." 23:59:59");

                }

                break;

             case 'export':

                /* fetch export template */

                print $this->tmpl->fetch("export.tpl");

                /* no further execution necessary. */

                return;

                break;

             case 'slideshow':

                /* fetch slideshow template */

                print $this->tmpl->show("slideshow.tpl");

                /* no further execution necessary. */

                return;

                break;

             case 'rss':

                if(isset($_GET['tags'])) {

                   $_SESSION['selected_tags'] = $this->extractTags($_GET['tags']);

                }

                if(isset($_GET['from_date']) && $this->isValidDate($_GET['from_date'])) {

                   $_SESSION['from_date'] = strtotime($_GET['from_date'] ." 00:00:00");

                }

                if(isset($_GET['to_date']) && $this->isValidDate($_GET['to_date'])) {

                   $_SESSION['to_date'] = strtotime($_GET['to_date'] ." 23:59:59");

                }

                $this->getRSSFeed();

                return;

                break;

          }

       }

       /* if date-search variables are registered in the session, set the check

          for "consider date-range" in the html output

       */

       if(isset($_SESSION['from_date']) && isset($_SESSION['to_date']))

          $this->tmpl->assign('date_search_enabled', true);

       /* if rate-search variables are registered in the session, set the check

          for "consider rate-range" in the html output

       */

       if(isset($_SESSION['rate_from']) && isset($_SESSION['rate_to'])) {

          $this->tmpl->assign('rate_search_enabled', true);

       }

       $this->tmpl->register_function("sort_select_list", array(&$this, "smarty_sort_select_list"), false);

       $this->tmpl->assign('search_from_date', $this->get_date_text_field('from'));

       $this->tmpl->assign('search_to_date', $this->get_date_text_field('to'));

       $this->tmpl->assign('preset_selected_tags', $this->getSelectedTags());

       $this->tmpl->assign('preset_available_tags', $this->getAvailableTags());

       $this->tmpl->assign('rate_search', $this->get_rate_search());

       /* if no site-content has been set yet... */

       if(!isset($content)) {

          /* if tags are already selected, we can immediately display photo-index */

          if((isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags']) &&

              isset($_SESSION['start_action']) && $_SESSION['start_action'] != 'showp') ||

             (isset($_SESSION['start_action']) && $_SESSION['start_action'] == 'showpi'))

             $this->tmpl->assign('initial_content', $this->showPhotoIndex());

          else {

             /* if a photo is already selected, we can immediately display single-photo */

             if(isset($_SESSION['current_photo']) && !empty($_SESSION['current_photo']))

                $this->tmpl->assign('initial_content', $this->showPhoto($_SESSION['current_photo']));

             else {

                /* ok, then let us show the welcome page... */

                $this->tmpl->assign('initial_content', $this->tmpl->fetch('welcome.tpl'));

             }

          }

       }

       else

          $this->tmpl->assign('initial_content', $content);

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

    } // show()

    /**

     * get_tags - grab all tags of f-spot's database

     *

     * this function will get all available tags from

     * the f-spot database and store them within two

     * arrays within this class for later usage. in

     * fact, if the user requests (hide_tags) it will

     * opt-out some of them.

     *

     * this function is getting called once by show()

     */

    private function get_tags()

    {

       $this->avail_tags = Array();

       $count = 0;

       /* if show_tags has been set in the configuration (only show photos

          which are tagged by these tags) they following will take care,

          that only these other tags are displayed where the photo is also

          tagged with one of show_tags.

       */

       if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {

          $query_str="

             SELECT

                DISTINCT t1.id as id, t1.name as name

             FROM

                photo_tags pt1

             INNER JOIN photo_tags

                pt2 ON pt1.photo_id=pt2.photo_id

             INNER JOIN tags t1

                ON t1.id=pt1.tag_id

             INNER JOIN tags t2

                ON t2.id=pt2.tag_id

             WHERE

                t2.name IN  ('".implode("','",$this->cfg->show_tags)."')

             ORDER BY

                t1.sort_priority ASC";

          $result = $this->db->db_query($query_str);

       }

       else

       {

          $result = $this->db->db_query("

             SELECT id as id,name as name

             FROM tags

             ORDER BY sort_priority ASC

          ");

       }

       while($row = $this->db->db_fetch_object($result)) {

          $tag_id = $row['id'];

          $tag_name = $row['name'];

          /* if the user has specified to ignore this tag in phpfspot's

             configuration, ignore it here so it does not get added to

             the tag list.

          */

          if(in_array($row['name'], $this->cfg->hide_tags))

             continue;

          /* if you include the following if-clause and the user has specified

             to only show certain tags which are specified in phpfspot's

             configuration, ignore all others so they will not be added to the

             tag list.

          if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags) &&

             !in_array($row['name'], $this->cfg->show_tags))

             continue;

          */

          $this->tags[$tag_id] = $tag_name;

          $this->avail_tags[$count] = $tag_id;

          $count++;

       }

    } // get_tags()

    /**

     * get all photo details from F-Spot database

     *

     * this function queries the F-Spot database for all available

     * details of the requested photo. It returns them as a object.

     *

     * Furthermore it takes care of the photo version to be requested.

     * If photo version is not yet, it queries information for the

     * original photo.

     *

     * @param integer $idx

     * @return object|null

     */

    public function get_photo_details($idx, $version_idx = NULL)

    {

       /* ~ F-Spot version 0.3.x */

       if($this->dbver < 9) {

          $query_str = "

             SELECT

                p.id as id,

                p.name as name,

                p.time as time,

                p.directory_path as directory_path,

                p.description as description

             FROM

                photos p

          ";

       }

       else {

          /* till F-Spot version 0.4.1 */

          if($this->dbver < 11) {

             $query_str = "

                SELECT

                   p.id as id,

                   p.uri as uri,

                   p.time as time,

                   p.description as description

                FROM

                   photos p

             ";

          }

          elseif($this->dbver < 17) {

              /* rating value got introduced */

             $query_str = "

                SELECT

                   p.id as id,

                   p.uri as uri,

                   p.time as time,

                   p.description as description,

                   p.rating as rating

                FROM

                   photos p

             ";

          }

          else {

             /* path & filename now splited in base_uri & filename */

             $query_str = "

                SELECT

                   p.id as id,

                   p.base_uri || p.filename as uri,

                   p.time as time,

                   p.description as description,

                   p.rating as rating

                FROM

                   photos p

             ";

          }

       }

       /* if show_tags is set, only return details of photos which are

          tagged with a tag that has been 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 p.id='". $idx ."'

             AND t.name IN ('".implode("','",$this->cfg->show_tags)."')";

       }

       else {

          $query_str.= "

             WHERE p.id='". $idx ."'

          ";

       }

       if(!$row = $this->db->db_fetchSingleRow($query_str))

          return null;

       /* before F-Spot db version 9 there was no uri column but

          seperated fields for directory_path and name (= filename).

       */

       if($this->dbver < 9) {

          $row['uri'] = "file://". $row['directory_path'] ."/". $row['name'];

       }

       /* starting with dbversion >= 17 we need to rawurldecode() uri */

       elseif($this->dbver >= 17) {

          $row['uri'] = rawurldecode($row['uri']);

       }

       /* if version-idx has not yet been set, get the latest photo version */

       if(!isset($version_idx) || !$this->is_valid_version($idx, $version_idx))

          $version_idx = $this->get_latest_version($idx);

       /* if an alternative version has been requested. But we

          support this only for F-Spot database versions from

          v9.

       */

       if($version_idx > 0 && $this->dbver >= 9) {

          if ($this->dbver < 17) {

             /* check for alternative versions */

             if($version = $this->db->db_fetchSingleRow("

                SELECT

                   version_id, name, uri

                FROM

                   photo_versions

                WHERE

                   photo_id LIKE '". $idx ."'

                AND

                   version_id LIKE '". $version_idx ."'")) {

                $row['name'] = $version['name'];

                $row['uri'] = $version['uri'];

             }

          }

          else {

             /* path & filename now splited in base_uri & filename */

             if($version = $this->db->db_fetchSingleRow("

                SELECT

                   version_id,

                   name,

                   base_uri || filename as uri

                FROM

                   photo_versions

                WHERE

                   photo_id LIKE '". $idx ."'

                AND

                   version_id LIKE '". $version_idx ."'")) {

                $row['name'] = $version['name'];

                $row['uri'] = rawurldecode($version['uri']);

             }

          }

       }

       return $row;

    } // get_photo_details()

    /**

     * returns aligned photo names

     *

     * this function returns aligned (length) names for a specific photo.

     * If the length of the name exceeds $limit the name will bei

     * shrinked (...).

     *

     * @param integer $idx

     * @param integer $limit

     * @return string|null

     */

    public function getPhotoName($idx, $limit = 0)

    {

       if($details = $this->get_photo_details($idx)) {

          if($long_name = $this->parse_uri($details['uri'], 'filename')) {

             $name = $this->shrink_text($long_name, $limit);

             return $name;

          }

       }

       return null;

    } // getPhotoName()

    /**

     * get photo rating level

     *

     * this function will return the integer-based rating level of a

     * photo. This can only be done, if the F-Spot database is at a

     * specific version. If rating value can not be found, zero will

     * be returned indicating no rating value is available.

     *

     * @param integer idx

     * @return integer

     */

    public function get_photo_rating($idx)

    {

       if($detail = $this->get_photo_details($idx)) {

          if(isset($detail['rating']))

             return $detail['rating'];

       }

       return 0;

    } // get_photo_rating()

    /**

     * get rate-search bars

     *

     * this function will return the rating-bars for the search field.

     *

     * @return string

     */

    public function get_rate_search()

    {

       $bar = "";

       for($i = 1; $i <= 5; $i++) {

          $bar.= "<img id=\"rate_from_". $i ."\" src=\"";

          if(isset($_SESSION['rate_from']) && $i <= $_SESSION['rate_from'])

             $bar.= $this->cfg->web_path ."/resources/star.png";

          else

             $bar.= $this->cfg->web_path ."/resources/empty_rate.png";

          $bar.= "\"

             onmouseover=\"show_rate('from', ". $i .");\"

             onmouseout=\"reset_rate('from');\"

             onclick=\"set_rate('from', ". $i .")\" />";

       }

       $bar.= "<br />\n";

        for($i = 1; $i <= 5; $i++) {

          $bar.= "<img id=\"rate_to_". $i ."\" src=\"";

          if(isset($_SESSION['rate_to']) && $i <= $_SESSION['rate_to'])

             $bar.= $this->cfg->web_path ."/resources/star.png";

          else

             $bar.= $this->cfg->web_path ."/resources/empty_rate.png";

          $bar.= "\"

             onmouseover=\"show_rate('to', ". $i .");\"

             onmouseout=\"reset_rate('to');\"

             onclick=\"set_rate('to', ". $i .");\" />";

       }

       return $bar;

    } // get_rate_search()

    /**

     * shrink text according provided limit

     *

     * If the length of the name exceeds $limit, text will be shortend

     * and inner content will be replaced with "...".

     *

     * @param string $ext

     * @param integer $limit

     * @return string

     */

    private function shrink_text($text, $limit)

    {

       if($limit != 0 && strlen($text) > $limit) {

          $text = substr($text, 0, $limit-5) ."...". substr($text, -($limit-5));

       }

       return $text;

    } // shrink_text();

    /**

     * translate f-spoth photo path

     *

     * 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)

    {

       if($this->cfg->enable_replace_path == true)

          return str_replace(

             $this->cfg->path_replace_from,

             $this->cfg->path_replace_to, $path);

       return $path;

    } // translate_path

    /**

     * control HTML ouput for a single photo

     *

     * this function provides all the necessary information

     * for the single photo template.

     * @param integer photo

     */

    public function showPhoto($photo)

    {

       /* get all photos from the current photo selection */

       $all_photos = $this->getPhotoSelection();

       $count = count($all_photos);

       for($i = 0; $i < $count; $i++) {

          // $get_next will be set, when the photo which has to

          // be displayed has been found - this means that the

          // next available is in fact the NEXT image (for the

          // navigation icons)

          if(isset($get_next)) {

             $next_img = $all_photos[$i];

             break;

          }

          /* the next photo is our NEXT photo */

          if($all_photos[$i] == $photo) {

             $get_next = 1;

          }

          else {

             $previous_img = $all_photos[$i];

          }

          if($photo == $all_photos[$i]) {

                $current = $i;

          }

       }

       $details = $this->get_photo_details($photo);

       if(!$details) {

          print "error";

          return;

       }

       $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));

       /* if current version is already set, use it */

       if($this->get_current_version() !== false)

          $version = $this->get_current_version();

       /* if version not set yet, we assume to display the latest version */

       if(!isset($version) || !$this->is_valid_version($photo, $version))

          $version = $this->get_latest_version($photo);

       $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo, $version);

       if(!file_exists($orig_path)) {

          $this->_error("Photo ". $orig_path ." does not exist!<br />\n");