update INSTALL and UPGRADE file
[phpfspot.git] / phpfspot_cfg.php.dist
index 93d1d00a6974003b43a1ead8997a6b9d6f1432a9..375eab99ae5fd6ebeb7ac6bf1c1d9641c305f5ff 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
@@ -25,13 +26,16 @@ class PHPFSPOT_CFG {
 
    var $page_title = "phpfspot - dynamic PHP gallery for F-Spot";
 
-   var $product = "phpfspot";
-   var $version = "1.0";
-
-   var $base_path = "/var/www/htdocs";
+   var $base_path = "/var/www/phpfspot";
 
    var $web_path = "/phpfspot";
 
+   /* path to the directory to store the generated thumbnails.
+      this path needs not do be directly reachable via the webserver
+      Default it points to a subdirectory of $base_path.
+   */
+   var $thumb_path = "/var/www/phpfspot/thumbs";
+
    var $theme_name = "default";
  
    /* database access via "native" sqlite3 support or via "pdo" */
@@ -40,12 +44,15 @@ class PHPFSPOT_CFG {
    /* path to Smarty (http://smarty.php.net) installation. this option
       should directly point to the Smarty main directory containing the
       sub directories 'libs', 'misc', 'unit_test', ...
-      the default value 'smarty' is enough for Debian-systems where
-      Smarty is installed through as dpkg.
+      the default value '/usr/share/php/smarty' is for Debian GNU/Linux
+      where Smarty is installed through as dpkg.
    */
-   var $smarty_path = "smarty";
+   var $smarty_path = "/usr/share/php/smarty";
 
-   /* it's enough if this database is readonly for the webserver */
+   /* path to the F-Spot sqlite database. This one must be writeable by
+      the webserver too, to create a necessary index to speed up some
+      operations.
+   */
    var $fspot_db = "/var/www/f-spot-dbs/photos.db";
 
    /* this database MUST be writeable for the webserver. Set the directory
@@ -53,30 +60,58 @@ class PHPFSPOT_CFG {
    */
    var $phpfspot_db = "/var/www/f-spot-dbs/phpfspot.db";
 
+   /* sqlite temp dir. per default sqlite tries /var/tmp, /usr/tmp, /tmp
+      and the current working directory for creating temporary files.
+      If you still get error messages when phpfspot tries to create the
+      indecies in $fspot_db, set this option to another writeable
+      directory. For example $phpfspot_db directory, which must be
+      writeable anyway.
+   */
+   // var $sqlite_temp_dir = "/var/www/f-spot-dbs";
+
    /* don't touch if you haven't changed the base templates */
    var $thumb_width = "150";
+   var $thumb_height = "145";
    var $photo_width = "640";
    var $mini_width = "100";
 
-   /* how many columns in the photo index view */
-   var $thumbs_per_row = 4;
-
-   /* how many rows should be displayed on the photo index view */
-   /* use 0 to display all matching photos on one page */
-   var $rows_per_page = 4;
+   /* how many thumbnails should be displayed on the photo index view */
+   /* use 0 to display all matching photos on one page                */
+   var $thumbs_per_page = 50;
 
    /* Usually the photo directory differs between your local F-Spot installation
       and your webserver. With this you can advice phpfspot to replace all paths
-      (they are stored in F-Spot's sqlite3 database
+      (they are stored in F-Spot's sqlite3 database).
+
+      disable this feature by setting the next variable to false;
    */
+   var $enable_replace_path = true;
+
+   // substitute all "from" matches with "to"
    var $path_replace_from = "/home/unki";
-   var $path_replace_to = "/var/www/images.netshadow.at";
+   var $path_replace_to = "/var/www/phpfspot/Photos";
 
    /* This is not really a security option - it only hides some present F-Spot
       tags from the available-tags-list
    */
    var $hide_tags = Array("Favorites", "Hidden", "People", "Places", "Events");
 
+   /* Show only pictures which are tagged with the following tags.
+      Comment out this option with // if you want to show all tags &
+      pictures.
+   */
+   //var $show_tags = Array("Friends", "Holidays");
+
+   /* Use lightbox2 for photo preview (adds the little eye symbol into the
+      photo index.
+   */
+   var $use_lightbox = true;
+
+   /* Use Ajax Auto Completion for tag search. Maybe, if you have a slow
+      connectivity for the server, it's a good idea to turn it off.
+   */
+   var $use_autocomplete = true;
+
    /* logging = display || errorlog || logfile */
    var $logging = "display";
 
@@ -86,88 +121,33 @@ class PHPFSPOT_CFG {
    /* no need to modified anything below this line */
    var $error_found = 0;
 
-   public function __construct()
-   {
-      if(!isset($this->page_title) || $this->page_title == "")
-         $this->showError("Please set \$page_title in phpfspot_cfg");
-   
-      if(!isset($this->product) || $this->product == "")
-         $this->showError("Please set \$product in phpfspot_cfg");
-
-      if(!isset($this->version) || $this->version == "")
-         $this->showError("Please set \$version in phpfspot_cfg");
-
-      if(!isset($this->base_path) || $this->base_path == "")
-         $this->showError("Please set \$base_path in phpfspot_cfg");
+   /* path to dcraw to decode Nikon's NEF format */
+   // var $dcraw_bin = "/usr/bin/dcraw";
 
-      if(!isset($this->web_path) || $this->web_path == "")
-         $this->showError("Please set \$web_path in phpfspot_cfg");
+   /* user friendly URLs */
+   var $user_friendly_url = false;
 
-      if(!isset($this->fspot_db) || $this->fspot_db == "")
-         $this->showError("Please set \$fspot_db in phpfspot_cfg");
+   /* default sort order - possible values are:
 
-      if(!isset($this->db_access) || $this->db_access == "")
-         $this->showError("Please set \$db_access in phpfspot_cfg");
+        date_asc  => sort by date ascending (17.1, 18.1, 19.1, ...)
+        date_desc => sort by date descending (19.1, 18.1, 17.1, ...)
+        name_asc  => sort by name ascending (alphabetical)
+        name_desc => sort by name descending (alphabetical)
+        tags_asc  => sort by tag ascending (alphabetical)
+        tags_desc => sort by tag descending (alphabetical)
+        rate_asc  => sort by rate value ascending (1, 2, 3, 4, 5)
+        rate_desc => sort by rate value descending (5, 4, 3, 2, 1)
 
-      if(!isset($this->phpfspot_db) || $this->phpfspot_db == "")
-         $this->showError("Please set \$phpfspot_db in phpfspot_cfg");
+      Attention: Rate value is available beginning with F-Spot version 0.4.1
 
-      if(!isset($this->thumb_width) || $this->thumb_width == "")
-         $this->showError("Please set \$thumb_width in phpfspot_cfg");
-
-      if(!isset($this->photo_width) || $this->photo_width == "")
-         $this->showError("Please set \$photo_width in phpfspot_cfg");
-
-      if(!isset($this->mini_width) || $this->mini_width == "")
-         $this->showError("Please set \$mini_width in phpfspot_cfg");
-
-      if(!isset($this->thumbs_per_row) || $this->thumbs_per_row == "")
-         $this->showError("Please set \$thumbs_per_row in phpfspot_cfg");
-
-      if(!isset($this->rows_per_page) || $this->rows_per_page == "")
-         $this->showError("Please set \$rows_per_page in phpfspot_cfg");
-
-      if(!isset($this->path_replace_from) || $this->path_replace_from == "")
-         $this->showError("Please set \$path_replace_from in phpfspot_cfg");
-
-      if(!isset($this->path_replace_to) || $this->path_replace_to == "")
-         $this->showError("Please set \$path_replace_to in phpfspot_cfg");
-
-      if(!isset($this->hide_tags))
-         $this->showError("Please set \$hide_tags in phpfspot_cfg");
-
-      if(!isset($this->theme_name))
-         $this->showError("Please set \$theme_name in phpfspot_cfg");
-
-      if(!isset($this->logging))
-         $this->showError("Please set \$logging in phpfspot_cfg");
-
-      if(isset($this->logging) && $this->logging == 'logfile') {
-
-         if(!isset($this->log_file))
-            $this->showError("Please set \$log_file because you set logging = log_file in phpfspot_cfg");
-
-         if(!is_writeable($this->log_file))
-            $this->showError("The specified \$log_file ". $log_file ." is not writeable!");
-
-      }
-
-      if(isset($this->error_found) && $this->error_found)
-         exit(1);
-
-      /* check for pending slash on web_path */
-      if(!preg_match("/\/$/", $this->web_path))
-         $this->web_path.= "/";
-
-   } // __construct()
+   */
+   var $sort_order = "tags_asc";
 
-   private function showError($text)
+   public function __construct()
    {
-      print $text ."<br />\n";
-      $this->error_found = 1;
 
-   } // showError()
+   } // __construct()
 
-}
+} // class PHPFSPOT_CFG
 
 ?>