* add option to control photo path-substituion, resolves #180
[phpfspot.git] / phpfspot_cfg.php.dist
index f002aebc14984c334d25fe31fc56222305cc153e..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
@@ -48,7 +49,10 @@ class PHPFSPOT_CFG {
    */
    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
@@ -56,6 +60,15 @@ 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";
@@ -69,7 +82,12 @@ class PHPFSPOT_CFG {
    /* 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).
+
+      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/phpfspot/Photos";
 
@@ -103,6 +121,28 @@ class PHPFSPOT_CFG {
    /* no need to modified anything below this line */
    var $error_found = 0;
 
+   /* path to dcraw to decode Nikon's NEF format */
+   // var $dcraw_bin = "/usr/bin/dcraw";
+
+   /* user friendly URLs */
+   var $user_friendly_url = false;
+
+   /* default sort order - possible values are:
+
+        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)
+
+      Attention: Rate value is available beginning with F-Spot version 0.4.1
+
+   */
+   var $sort_order = "tags_asc";
+
    public function __construct()
    {