issue99, search for filename and photo description
[phpfspot.git] / phpfspot.class.php
index c06ef241d97f20c9d936e4b52df805aeb8203924..9a74a9a078a2484f09978f9eb5b891b7464cd8f3 100644 (file)
@@ -32,6 +32,8 @@ class PHPFSPOT {
    var $tmpl;
    var $tags;
    var $avail_tags;
+
+   private $runtime_error = false;
    private $dbver;
 
    /**
@@ -45,6 +47,11 @@ class PHPFSPOT {
    {
       $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.3";
@@ -53,7 +60,9 @@ class PHPFSPOT {
          'date_asc' => 'Date ↑',
          'date_desc' => 'Date ↓',
          'name_asc' => 'Name ↑',
-         'name_desc' => 'Name ↓'
+         'name_desc' => 'Name ↓',
+         'tags_asc' => 'Tags ↑',
+         'tags_desc' => 'Tags ↓',
       );
 
       /* Check necessary requirements */
@@ -109,8 +118,8 @@ class PHPFSPOT {
       if(!isset($_SESSION['sort_order']))
          $_SESSION['sort_order'] = 'date_asc';
 
-      if(!isset($_SESSION['searchfor']))
-         $_SESSION['searchfor'] = '';
+      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)
@@ -134,7 +143,7 @@ class PHPFSPOT {
     */
    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);
@@ -629,8 +638,8 @@ class PHPFSPOT {
       if(!isset($_SESSION['selected_tags']))
          $_SESSION['selected_tags'] = Array();
 
-      if(isset($_SESSION['searchfor']))
-         unset($_SESSION['searchfor']);
+      if(isset($_SESSION['searchfor_tag']))
+         unset($_SESSION['searchfor_tag']);
 
       if(!in_array($tag, $_SESSION['selected_tags']))
          array_push($_SESSION['selected_tags'], $tag);
@@ -645,8 +654,8 @@ class PHPFSPOT {
     */
    public function delTag($tag)
    {
-      if(isset($_SESSION['searchfor']))
-         unset($_SESSION['searchfor']);
+      if(isset($_SESSION['searchfor_tag']))
+         unset($_SESSION['searchfor_tag']);
 
       if(isset($_SESSION['selected_tags'])) {
          $key = array_search($tag, $_SESSION['selected_tags']);
@@ -685,17 +694,28 @@ class PHPFSPOT {
    /**
     * reset tag search
     *
-    * if any tag search has taken place, reset
-    * it now
+    * if any tag search has taken place, reset it now
     */
    public function resetTagSearch()
    {
-      if(isset($_SESSION['searchfor']))
-         unset($_SESSION['searchfor']);
+      if(isset($_SESSION['searchfor_tag']))
+         unset($_SESSION['searchfor_tag']);
 
    } // resetTagSearch()
 
-    /**
+   /**
+    * reset name search
+    *
+    * if any name search has taken place, reset it now
+    */
+   public function resetNameSearch()
+   {
+      if(isset($_SESSION['searchfor_name']))
+         unset($_SESSION['searchfor_name']);
+
+   } // resetNameSearch()
+
+   /**
     * reset date search
     *
     * if any date search has taken place, reset
@@ -732,24 +752,45 @@ class PHPFSPOT {
          ";
       } 
 
+      if(isset($_SESSION['searchfor_name'])) {
+         if($this->dbver < 9) {
+            $additional_where_cond.= "
+                  (
+                        p.name LIKE '%". $_SESSION['searchfor_name'] ."%'
+                     OR
+                        p.description LIKE '%". $_SESSION['searchfor_name'] ."%'
+                  )
+            ";
+         }
+         else {
+            $additional_where_cond.= "
+                  (
+                        basename(p.uri) LIKE '%". $_SESSION['searchfor_name'] ."%'
+                     OR
+                        p.description LIKE '%". $_SESSION['searchfor_name'] ."%'
+                  )
+            ";
+         }
+      }
+
       if(isset($_SESSION['sort_order'])) {
          $order_str = $this->get_sort_order();
       }
 
       /* return a search result */
-      if(isset($_SESSION['searchfor']) && $_SESSION['searchfor'] != '') {
+      if(isset($_SESSION['searchfor_tag']) && $_SESSION['searchfor_tag'] != '') {
          $query_str = "
             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 tags t
+               ON pt1.tag_id=t.id
             INNER JOIN photos p
                ON pt1.photo_id=p.id
             INNER JOIN tags t2
                ON pt2.tag_id=t2.id
-            WHERE t1.name LIKE '%". $_SESSION['searchfor'] ."%' ";
+            WHERE t.name LIKE '%". $_SESSION['searchfor_tag'] ."%' ";
 
          if(isset($additional_where_cond))
             $query_str.= "AND ". $additional_where_cond ." ";
@@ -865,7 +906,7 @@ class PHPFSPOT {
 
       /* return all available photos */
       $query_str = "
-         SELECT p.id
+         SELECT DISTINCT p.id
          FROM photos p
          LEFT JOIN photo_tags pt
             ON p.id=pt.photo_id
@@ -877,10 +918,10 @@ class PHPFSPOT {
          $query_str.= "WHERE ". $additional_where_cond ." ";
 
       if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
-        if(isset($additional_where_cond))
-           $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')";
-        else
-           $query_str.= "WHERE t.name IN ('".implode("','",$this->cfg->show_tags). "')";
+         if(isset($additional_where_cond))
+            $query_str.= "AND t.name IN ('".implode("','",$this->cfg->show_tags). "')";
+         else
+            $query_str.= "WHERE t.name IN ('".implode("','",$this->cfg->show_tags). "')";
       }
  
       if(isset($order_str))
@@ -958,8 +999,8 @@ class PHPFSPOT {
       // +1 for for smarty's selection iteration
       $thumbs++;
 
-      if(isset($_SESSION['searchfor']) && $_SESSION['searchfor'] != '')
-         $this->tmpl->assign('searchfor', $_SESSION['searchfor']);
+      if(isset($_SESSION['searchfor_tag']) && $_SESSION['searchfor_tag'] != '')
+         $this->tmpl->assign('searchfor_tag', $_SESSION['searchfor_tag']);
 
       if(isset($_SESSION['from_date']) && isset($_SESSION['to_date'])) {
          $this->tmpl->assign('from_date', $this->ts2str($_SESSION['from_date']));
@@ -1417,11 +1458,27 @@ class PHPFSPOT {
     * getPhotoSelection() will then only return the matching
     * photos.
     */
-   public function startSearch($searchfor, $from = 0, $to = 0)
+   public function startSearch($searchfor_tag, $from = 0, $to = 0)
    {
+      if(isset($_GET['from']) && $fspot->isValidDate($_GET['from'])) {
+         $from = $_GET['from'];
+      }
+      if(isset($_GET['to']) && $fspot->isValidDate($_GET['to'])) {
+         $to = $_GET['to'];
+      }
+
+      if(isset($_GET['for_tag']) && is_string($_GET['for_tag'])) {
+         $searchfor_tag = $_GET['for_tag'];
+      }
+
+      if(isset($_GET['for_name']) && is_string($_GET['for_name'])) {
+         $searchfor_name = $_GET['for_name'];
+      }
+
       $this->get_tags();
 
-      $_SESSION['searchfor'] = $searchfor;
+      $_SESSION['searchfor_tag'] = $searchfor_tag;
+      $_SESSION['searchfor_name'] = $searchfor_name;
 
       if($from != 0)
          $_SESSION['from_date'] = strtotime($from ." 00:00:00");
@@ -1433,11 +1490,11 @@ class PHPFSPOT {
       else
          unset($_SESSION['to_date']);
 
-      if($searchfor != "") {
+      if($searchfor_tag != "") {
          /* new search, reset the current selected tags */
          $_SESSION['selected_tags'] = Array();
          foreach($this->avail_tags as $tag) {
-            if(preg_match('/'. $searchfor .'/i', $this->tags[$tag]))
+            if(preg_match('/'. $searchfor_tag .'/i', $this->tags[$tag]))
                array_push($_SESSION['selected_tags'], $tag);
          }
       }
@@ -1682,9 +1739,10 @@ class PHPFSPOT {
    public function _error($text)
    {
       switch($this->cfg->logging) {
+         default:
          case 'display':
             print "<img src=\"resources/green_info.png\" alt=\"warning\" />\n";
-            print $text;
+            print $text ."<br />\n";
             break;
          case 'errorlog':  
             error_log($text);
@@ -1694,6 +1752,8 @@ class PHPFSPOT {
             break;
       }
 
+      $this->runtime_error = true;
+
    } // _error()
 
    /**
@@ -2022,6 +2082,12 @@ class PHPFSPOT {
                return " ORDER BY basename(p.uri) DESC";
             }
             break;
+         case 'tags_asc':
+            return " ORDER BY t.name ASC ,p.time ASC";
+            break;
+         case 'tags_desc':
+            return " ORDER BY t.name DESC ,p.time ASC";
+            break;
       }
 
    } // get_sort_order()
@@ -2068,6 +2134,7 @@ class PHPFSPOT {
    {
       if(isset($_SESSION['slideshow_img']))
          unset($_SESSION['slideshow_img']);
+
    } // resetSlideShow()
    
    /***
@@ -2272,6 +2339,122 @@ class PHPFSPOT {
 
    } // parse_uri()
 
+   /**
+    * validate config options
+    *
+    * this function checks if all necessary configuration options are
+    * specified and set.
+    */
+   private function check_config_options()
+   {
+      if(!isset($this->cfg->page_title) || $this->cfg->page_title == "")
+         $this->_error("Please set \$page_title in phpfspot_cfg");
+
+      if(!isset($this->cfg->base_path) || $this->cfg->base_path == "")
+         $this->_error("Please set \$base_path in phpfspot_cfg");
+
+      if(!isset($this->cfg->web_path) || $this->cfg->web_path == "")
+         $this->_error("Please set \$web_path in phpfspot_cfg");
+
+      if(!isset($this->cfg->thumb_path) || $this->cfg->thumb_path == "")
+         $this->_error("Please set \$thumb_path in phpfspot_cfg");
+
+      if(!isset($this->cfg->smarty_path) || $this->cfg->smarty_path == "")
+         $this->_error("Please set \$smarty_path in phpfspot_cfg");
+
+      if(!isset($this->cfg->fspot_db) || $this->cfg->fspot_db == "")
+         $this->_error("Please set \$fspot_db in phpfspot_cfg");
+
+      if(!isset($this->cfg->db_access) || $this->cfg->db_access == "")
+         $this->_error("Please set \$db_access in phpfspot_cfg");
+
+      if(!isset($this->cfg->phpfspot_db) || $this->cfg->phpfspot_db == "")
+         $this->_error("Please set \$phpfspot_db in phpfspot_cfg");
+
+      if(!isset($this->cfg->thumb_width) || $this->cfg->thumb_width == "")
+         $this->_error("Please set \$thumb_width in phpfspot_cfg");
+
+      if(!isset($this->cfg->thumb_height) || $this->cfg->thumb_height == "")
+         $this->_error("Please set \$thumb_height in phpfspot_cfg");
+
+      if(!isset($this->cfg->photo_width) || $this->cfg->photo_width == "")
+         $this->_error("Please set \$photo_width in phpfspot_cfg");
+
+      if(!isset($this->cfg->mini_width) || $this->cfg->mini_width == "")
+         $this->_error("Please set \$mini_width in phpfspot_cfg");
+
+      if(!isset($this->cfg->thumbs_per_page))
+         $this->_error("Please set \$thumbs_per_page in phpfspot_cfg");
+
+      if(!isset($this->cfg->path_replace_from) || $this->cfg->path_replace_from == "")
+         $this->_error("Please set \$path_replace_from in phpfspot_cfg");
+
+      if(!isset($this->cfg->path_replace_to) || $this->cfg->path_replace_to == "")
+         $this->_error("Please set \$path_replace_to in phpfspot_cfg");
+
+      if(!isset($this->cfg->hide_tags))
+         $this->_error("Please set \$hide_tags in phpfspot_cfg");
+
+      if(!isset($this->cfg->theme_name))
+         $this->_error("Please set \$theme_name in phpfspot_cfg");
+
+      if(!isset($this->cfg->logging))
+         $this->_error("Please set \$logging in phpfspot_cfg");
+
+      if(isset($this->cfg->logging) && $this->cfg->logging == 'logfile') {
+
+         if(!isset($this->cfg->log_file))
+            $this->_error("Please set \$log_file because you set logging = log_file in phpfspot_cfg");
+
+         if(!is_writeable($this->cfg->log_file))
+            $this->_error("The specified \$log_file ". $log_file ." is not writeable!");
+
+      }
+
+      /* check for pending slash on web_path */
+      if(!preg_match("/\/$/", $this->web_path))
+         $this->web_path.= "/";
+
+      return $this->runtime_error;
+
+   } // check_config_options()
+
+   /**
+    * cleanup phpfspot own database
+    *
+    * When photos are getting delete from F-Spot, there will remain
+    * remain some residues in phpfspot own database. This function
+    * will try to wipe them out.
+    */
+   public function cleanup_phpfspot_db()
+   {
+      $to_delete = Array();
+
+      $result = $this->cfg_db->db_query("
+         SELECT img_idx
+         FROM images
+         ORDER BY img_idx ASC
+      ");
+
+      while($row = $this->cfg_db->db_fetch_object($result)) {
+         if(!$this->db->db_fetchSingleRow("
+            SELECT id
+            FROM photos
+            WHERE id='". $row['img_idx'] ."'")) {
+
+            array_push($to_delete, $row['img_idx'], ',');
+         }
+      }
+
+      print count($to_delete) ." unnecessary objects will be removed from phpfspot's database.\n";
+
+      $this->cfg_db->db_exec("
+         DELETE FROM images
+         WHERE img_idx IN (". implode($to_delete) .")
+      ");
+
+   } // cleanup_phpfspot_db()
+
 } // class PHPFSPOT
 
 ?>