issue82, switch picture handling to URI which is necessary for newer f-spot version's.
[phpfspot.git] / phpfspot.class.php
index 9ec2254d9184887b3b20eb770b150bb82699cd2e..ea91b011ce3f2ae67bc4a1fc81ea41b700f52c26 100644 (file)
@@ -32,6 +32,7 @@ class PHPFSPOT {
    var $tmpl;
    var $tags;
    var $avail_tags;
+   private $dbver;
 
    /**
     * class constructor
@@ -44,13 +45,23 @@ class PHPFSPOT {
    {
       $this->cfg = new PHPFSPOT_CFG;
 
+      /* set application name and version information */
+      $this->cfg->product = "phpfspot";
+      $this->cfg->version = "1.2";
+
       /* Check necessary requirements */
       if(!$this->checkRequirements()) {
          exit(1);
       }
 
       $this->db  = new PHPFSPOT_DB($this, $this->cfg->fspot_db);
-      
+      if(!is_writeable($this->cfg->fspot_db)) {
+         print $this->cfg->fspot_db ." is not writeable for user ". $this->getuid() ."\n";
+         exit(1);
+      }
+
+      $this->dbver = $this->getFspotDBVersion();
+
       if(!is_writeable(dirname($this->cfg->phpfspot_db))) {
          print dirname($this->cfg->phpfspot_db) .": directory is not writeable!";
          exit(1);
@@ -72,7 +83,8 @@ class PHPFSPOT {
       require_once "phpfspot_tmpl.php";
       $this->tmpl = new PHPFSPOT_TMPL($this);
 
-      $this->get_tags();
+      /* check if all necessary indices exist */
+      $this->checkDbIndices();
 
       session_start();
 
@@ -181,7 +193,7 @@ class PHPFSPOT {
     *
     * this function will get all available tags from
     * the f-spot database and store them within two
-    * arrays within this clase for later usage. in
+    * arrays within this class for later usage. in
     * fact, if the user requests (hide_tags) it will
     * opt-out some of them.
     *
@@ -192,24 +204,57 @@ class PHPFSPOT {
       $this->avail_tags = Array();
       $count = 0;
    
-      $result = $this->db->db_query("
-         SELECT id,name
-         FROM tags
-         ORDER BY sort_priority ASC
-      ");
+      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,name
+            FROM tags
+            ORDER BY sort_priority ASC
+         ");
+      }
       
       while($row = $this->db->db_fetch_object($result)) {
 
          $tag_id = $row['id'];
          $tag_name = $row['name'];
 
-         /* check if config requests to ignore this tag */
+         /* 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++;
 
       }
@@ -224,12 +269,43 @@ class PHPFSPOT {
     */
    public function get_photo_details($idx)
    {
-      $result = $this->db->db_query("
-         SELECT *
-         FROM photos
-         WHERE id='". $idx ."'
-      ");
-      
+      if($this->dbver < 9) {
+         $query_str = "
+            SELECT p.id, p.name, p.time, p.directory_path, p.description
+            FROM photos p
+         ";
+      }
+      else {
+         $query_str = "
+            SELECT p.id, p.uri, p.time, p.description
+            FROM photos p
+         ";
+      }
+
+      /* if show_tags is set, only return details for photos which
+         are 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 ."'
+         ";
+      }
+
+      $result = $this->db->db_query($query_str);
+
+      if($this->dbver < 9) {
+         $result['uri'] = "file://". $result['directory_path'] ."/". $result['name'];
+      }
+
       return $this->db->db_fetch_object($result);
 
    } // get_photo_details
@@ -244,10 +320,14 @@ class PHPFSPOT {
    public function getPhotoName($idx, $limit = 0)
    {
       if($details = $this->get_photo_details($idx)) {
-         $name = $this->shrink_text($details['name'], $limit);
-         return $name;
+         if($long_name = $this->parse_uri($details['uri'], 'filename')) {
+            $name = $this->shrink_text($long_name, $limit);
+            return $name;
+         }
       }
 
+      return null;
+
    } // getPhotoName()
 
    /**
@@ -323,7 +403,7 @@ class PHPFSPOT {
          return;
       }
 
-      $orig_path = $this->translate_path($details['directory_path']) ."/". $details['name'];
+      $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
       $thumb_path = $this->get_thumb_path($this->cfg->photo_width, $photo);
 
       if(!file_exists($orig_path)) {
@@ -371,7 +451,7 @@ class PHPFSPOT {
          $info = getimagesize($thumb_path);
 
          $this->tmpl->assign('description', $details['description']);
-         $this->tmpl->assign('image_name', $details['name']);
+         $this->tmpl->assign('image_name', $this->parse_uri($details['uri'], 'filename'));
 
          $this->tmpl->assign('width', $info[0]);
          $this->tmpl->assign('height', $info[1]);
@@ -417,6 +497,8 @@ class PHPFSPOT {
     */
    public function getAvailableTags()
    {
+      $this->get_tags();
+
       $output = "";
 
       $result = $this->db->db_query("
@@ -466,7 +548,9 @@ class PHPFSPOT {
           // uncomment if you want sizes in whole %:
          $size = ceil($size);
 
-         $output.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%;\">". $this->tags[$key] ."</a>, ";
+         if(isset($this->tags[$key])) {
+            $output.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%;\">". $this->tags[$key] ."</a>, ";
+         }
 
       }
 
@@ -484,6 +568,8 @@ class PHPFSPOT {
     */
    public function getSelectedTags()
    {
+      $this->get_tags();
+
       $output = "";
       foreach($this->avail_tags as $tag)
       {
@@ -614,16 +700,25 @@ class PHPFSPOT {
       /* return a search result */
       if(isset($_SESSION['searchfor']) && $_SESSION['searchfor'] != '') {
          $query_str = "
-            SELECT DISTINCT photo_id
-               FROM photo_tags pt
+            SELECT DISTINCT pt1.photo_id
+               FROM photo_tags pt1
+            INNER JOIN photo_tags pt2
+               ON pt1.photo_id=pt2.photo_id
+            INNER JOIN tags t1
+               ON pt1.tag_id=t1.id
             INNER JOIN photos p
-               ON p.id=pt.photo_id
-            INNER JOIN tags t
-               ON pt.tag_id=t.id
-            WHERE t.name LIKE '%". $_SESSION['searchfor'] ."%'";
+               ON pt1.photo_id=p.id
+            INNER JOIN tags t2
+               ON pt2.tag_id=t2.id
+            WHERE t1.name LIKE '%". $_SESSION['searchfor'] ."%' ";
 
          if(isset($additional_where_cond))
             $query_str.= "AND ". $additional_where_cond ." ";
+
+         if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+            $query_str.= "AND t2.name IN ('".implode("','",$this->cfg->show_tags)."')";
+         }
+         
          if(isset($order_str))
             $query_str.= $order_str;
 
@@ -641,19 +736,30 @@ class PHPFSPOT {
             $selected.= $tag .",";
          $selected = substr($selected, 0, strlen($selected)-1);
 
+         /* photo has to match at least on of the selected tags */
          if($_SESSION['tag_condition'] == 'or') {
             $query_str = "
-               SELECT DISTINCT photo_id
-                  FROM photo_tags pt
+               SELECT DISTINCT pt1.photo_id
+                  FROM photo_tags pt1
+               INNER JOIN photo_tags pt2
+                  ON pt1.photo_id=pt2.photo_id
+               INNER JOIN tags t
+                  ON pt2.tag_id=t.id
                INNER JOIN photos p
-                  ON p.id=pt.photo_id
-               WHERE pt.tag_id IN (". $selected .")
+                  ON pt1.photo_id=p.id
+               WHERE pt1.tag_id IN (". $selected .")
             ";
             if(isset($additional_where_cond)) 
                $query_str.= "AND ". $additional_where_cond ." ";
+
+            if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+               $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags)."')";
+            }
+
             if(isset($order_str))
                $query_str.= $order_str;
          }
+         /* photo has to match all selected tags */
          elseif($_SESSION['tag_condition'] == 'and') {
 
             if(count($_SESSION['selected_tags']) >= 32) {
@@ -676,6 +782,13 @@ class PHPFSPOT {
                   FROM photo_tags pt1
             ";
 
+            if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+               $query_str.= "
+                  INNER JOIN tags t
+                     ON pt1.tag_id=t.id
+               ";
+            }
+
             for($i = 0; $i < count($_SESSION['selected_tags']); $i++) {
                $query_str.= "
                   INNER JOIN photo_tags pt". ($i+2) ."
@@ -686,16 +799,22 @@ class PHPFSPOT {
                INNER JOIN photos p
                   ON pt1.photo_id=p.id
             ";
-            $query_str.= "WHERE pt1.tag_id=". $_SESSION['selected_tags'][0];
+            $query_str.= "WHERE pt2.tag_id=". $_SESSION['selected_tags'][0]." ";
             for($i = 1; $i < count($_SESSION['selected_tags']); $i++) {
                $query_str.= "
-                  AND pt". ($i+1) .".tag_id=". $_SESSION['selected_tags'][$i] ."
+                  AND pt". ($i+2) .".tag_id=". $_SESSION['selected_tags'][$i] ."
                "; 
             }
             if(isset($additional_where_cond)) 
                $query_str.= "AND ". $additional_where_cond;
+
+            if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+               $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')";
+            }
+
             if(isset($order_str))
                $query_str.= $order_str;
+
          }
 
          $result = $this->db->db_query($query_str);
@@ -711,9 +830,16 @@ class PHPFSPOT {
             FROM photo_tags pt
          INNER JOIN photos p
             ON p.id=pt.photo_id
+         INNER JOIN tags t
+            ON pt.tag_id=t.id
       ";
       if(isset($additional_where_cond)) 
          $query_str.= "WHERE ". $additional_where_cond ." ";
+
+      if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+         $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')";
+      }
       if(isset($order_str))
          $query_str.= $order_str;
 
@@ -945,6 +1071,7 @@ class PHPFSPOT {
    {
       $this->tmpl->assign('version', $this->cfg->version);
       $this->tmpl->assign('product', $this->cfg->product);
+      $this->tmpl->assign('db_version', $this->dbver);
       $this->tmpl->show("credits.tpl");
 
    } // showCredits()
@@ -1147,7 +1274,7 @@ class PHPFSPOT {
       $details = $this->get_photo_details($idx);
 
       /* calculate file MD5 sum */
-      $full_path = $this->translate_path($details['directory_path'])  ."/". $details['name'];
+      $full_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
 
       if(!file_exists($full_path)) {
          $this->_error("File ". $full_path ." does not exist\n");
@@ -1161,7 +1288,7 @@ class PHPFSPOT {
 
       $file_md5 = md5_file($full_path);
 
-      $this->_debug("Image [". $idx ."] ". $this->shrink_text($details['name'], 20) ." Thumbnails:");
+      $this->_debug("Image [". $idx ."] ". $this->shrink_text($this->parse_uri($details['uri'], 'filename'), 20) ." Thumbnails:");
 
       foreach($resolutions as $resolution) {
 
@@ -1255,6 +1382,8 @@ class PHPFSPOT {
     */
    public function startSearch($searchfor, $sort_order, $from = 0, $to = 0)
    {
+      $this->get_tags();
+
       $_SESSION['searchfor'] = $searchfor;
       $_SESSION['sort_order'] = $sort_order;
       if($from != 0)
@@ -1661,13 +1790,13 @@ class PHPFSPOT {
 <br>
 ". $details['description']);
 
-         $orig_path = $this->translate_path($details['directory_path']) ."/". $details['name'];
+         $orig_path = $this->translate_path($this->parse_uri($details['uri'], 'fullpath'));
          $meta = $this->get_meta_informations($orig_path);
          $meta_date = isset($meta['FileDateTime']) ? $meta['FileDateTime'] : filemtime($orig_path);
 
 ?>
   <item>
-   <title><?php print htmlspecialchars($details['name']); ?></title>
+   <title><?php print htmlspecialchars($this->parse_uri($details['uri'], 'filename')); ?></title>
    <link><?php print htmlspecialchars($orig_url); ?></link>
    <guid><?php print htmlspecialchars($orig_url); ?></guid>
    <dc:date.Taken><?php print strftime("%Y-%m-%dT%H:%M:%S+00:00", $meta_date); ?></dc:date.Taken>
@@ -1909,14 +2038,15 @@ class PHPFSPOT {
     */
    public function get_thumb_path($width, $photo)
    {
-      $sub_path = substr($this->getMD5($photo), 0, 2);
+      $md5 = $this->getMD5($photo);
+      $sub_path = substr($md5, 0, 2);
       return $this->cfg->thumb_path
          . "/"
          . $sub_path
          . "/"
          . $width
          . "_"
-         . $this->getMD5($photo);
+         . $md5;
 
    } // get_thumb_path()
 
@@ -1973,6 +2103,71 @@ class PHPFSPOT {
 
    } // check_readable()
 
-}
+   /**
+    * check if all needed indices are present
+    *
+    * this function checks, if some needed indices are already
+    * present, or if not, create them on the fly. they are
+    * necessary to speed up some queries like that one look for
+    * all tags, when show_tags is specified in the configuration.
+    */
+   private function checkDbIndices()
+   {
+      $result = $this->db->db_exec("
+         CREATE INDEX IF NOT EXISTS
+            phototag
+         ON
+            photo_tags
+               (photo_id, tag_id)
+      ");
+
+   } // checkDbIndices()
+
+   /**
+    * retrive F-Spot database version
+    *
+    * this function will return the F-Spot database version number
+    * It is stored within the sqlite3 database in the table meta
+    */
+   public function getFspotDBVersion()
+   {
+      if($result = $this->db->db_fetchSingleRow("
+         SELECT data as version
+         FROM meta
+         WHERE
+            name LIKE 'F-Spot Database Version'
+      "))
+         return $result['version'];
+
+      return null;
+
+   } // getFspotDBVersion()
+
+   /**
+    * parse the provided URI and will returned the
+    * requested chunk
+    */
+   public function parse_uri($uri, $mode)
+   {
+      if(($components = parse_url($uri)) !== false) {
+
+         switch($mode) {
+            case 'filename':
+               return basename($components['path']);
+               break;
+            case 'dirname':
+               return dirname($components['path']);
+               break;
+            case 'fullpath':
+               return $components['path'];
+               break;
+         }
+      }
+
+      return $uri;
+
+   } // parse_uri()
+
+} // class PHPFSPOT
 
 ?>