add .gitignore to docs directory to ignore errors.html file

[phpfspot.git] / phpfspot.class.php

diff --git a/phpfspot.class.php b/phpfspot.class.php
index ffd7e7e3d9a4855542ffb98ea3594217956c4012..2b5e180d4a985fa077c61e1bbefe759cee01523a 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,17 +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;
 
    /**

-    * class constructor
+    * 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,
     *
     * this function will be called on class construct
     * and will check requirements, loads configuration,


@@ -42,58 +105,143 @@ 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;
 
       $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";
       /* set application name and version information */
       $this->cfg->product = "phpfspot";

-      $this->cfg->version = "1.2";
+      $this->cfg->version = "1.5";
+
+      $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 */
 
       /* Check necessary requirements */

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

          exit(1);
       }
 
          exit(1);
       }
 

+      /******* Opening F-Spot's sqlite database *********/
+
+      /* 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);
       $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))) {
       if(!is_writeable(dirname($this->cfg->phpfspot_db))) {

-         print dirname($this->cfg->phpfspot_db) .": directory is not writeable!";
+         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);
       }
          exit(1);
       }

-         
-      $this->cfg_db = new PHPFSPOT_DB($this, $this->cfg->phpfspot_db);
+
+      /* Check if database file is writeable */

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

-         print $this->cfg->phpfspot_db ." is not writeable for user ". $this->getuid() ."\n";
+         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);
       }
          exit(1);
       }

-      $this->check_config_table();

 
 

-      /* include Smarty template engine */
-      if(!$this->check_readable($this->cfg->smarty_path .'/libs/Smarty.class.php')) {
-         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 ."'
+         ");

       }
       }

-      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";
       require_once "phpfspot_tmpl.php";

-      $this->tmpl = new PHPFSPOT_TMPL($this);
+      $this->tmpl = new PHPFSPOT_TMPL();
+
+      $this->tmpl->assign('web_path', $this->cfg->web_path);
+
+      /* 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();
 
 
       /* check if all necessary indices exist */
       $this->checkDbIndices();
 

-      session_start();
+      /* if session is not yet started, do it now */
+      if(session_id() == "")
+         session_start();

 
       if(!isset($_SESSION['tag_condition']))
          $_SESSION['tag_condition'] = 'or';
 
       if(!isset($_SESSION['sort_order']))
 
       if(!isset($_SESSION['tag_condition']))
          $_SESSION['tag_condition'] = 'or';
 
       if(!isset($_SESSION['sort_order']))

-         $_SESSION['sort_order'] = 'date_asc';
+         $_SESSION['sort_order'] = 'date_desc';

 
 

-      if(!isset($_SESSION['searchfor']))
-         $_SESSION['searchfor'] = '';
+      if(!isset($_SESSION['searchfor_tag']))
+         $_SESSION['searchfor_tag'] = '';

 
 

-      // if begin_with is still set but rows_per_page is now 0, unset it
-      if(isset($_SESSION['begin_with']) && $this->cfg->rows_per_page == 0)
+      // 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']);
 
          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()
    } // __construct()
 
    public function __destruct()


@@ -112,71 +260,117 @@ class PHPFSPOT {
     */
    public function show()
    {
     */
    public function show()
    {

-      $this->tmpl->assign('searchfor', $_SESSION['searchfor']);
+      $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);
 
       $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);
 

-      $_SESSION['start_action'] = $_GET['mode'];
+      /* parse URL */
+      if($this->is_user_friendly_url()) {
+         $content = $this->parse_user_friendly_url($_SERVER['REQUEST_URI']);
+      }

 
 

-      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'])) {
-               $_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']);
-            }
-            if(isset($_GET['to_date']) && $this->isValidDate($_GET['to_date'])) {
-               $_SESSION['to_date'] = strtotime($_GET['to_date']);
-            }
-            break;
-         case 'export':
-            $this->tmpl->show("export.tpl");
-            return;
-            break;
-         case 'slideshow':
-            $this->tmpl->show("slideshow.tpl");
-            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(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'])) {
+                  $_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(isset($_SESSION['from_date']) && isset($_SESSION['to_date']))
          $this->tmpl->assign('date_search_enabled', true);
 

-      $this->tmpl->assign('from_date', $this->get_calendar('from'));
-      $this->tmpl->assign('to_date', $this->get_calendar('to'));
-      $this->tmpl->assign('sort_field', $this->get_sort_field());
-      $this->tmpl->assign('content_page', 'welcome.tpl');
+      /* 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());
+         el