issue118, fix using variable name for search.tpl and photo_index.tpl twice
[phpfspot.git] / phpfspot.class.php
index 0615cff77a5d7742cc29461b42cf2cf4e8c54b13..00b3af4a08f402fedcaf6e1ba162adf6c30bce3c 100644 (file)
@@ -122,7 +122,7 @@ class PHPFSPOT {
 
       /* set application name and version information */
       $this->cfg->product = "phpfspot";
-      $this->cfg->version = "1.4";
+      $this->cfg->version = "1.5";
 
       $this->sort_orders= array(
          'date_asc' => 'Date ↑',
@@ -201,6 +201,8 @@ class PHPFSPOT {
       require_once "phpfspot_tmpl.php";
       $this->tmpl = new PHPFSPOT_TMPL();
 
+      $this->tmpl->assign('web_path', $this->cfg->web_path);
+
       /* check if all necessary indices exist */
       $this->checkDbIndices();
 
@@ -244,6 +246,11 @@ class PHPFSPOT {
       $this->tmpl->assign('current_condition', $_SESSION['tag_condition']);
       $this->tmpl->assign('template_path', 'themes/'. $this->cfg->theme_name);
 
+      /* parse URL */
+      if($this->is_user_friendly_url()) {
+         $content = $this->parse_user_friendly_url($_SERVER['REQUEST_URI']);
+      }
+
       if(isset($_GET['mode'])) {
 
          $_SESSION['start_action'] = $_GET['mode'];
@@ -304,9 +311,21 @@ class PHPFSPOT {
          $this->tmpl->assign('date_search_enabled', true);
 
       $this->tmpl->register_function("sort_select_list", array(&$this, "smarty_sort_select_list"), false);
-      $this->tmpl->assign('from_date', $this->get_calendar('from'));
-      $this->tmpl->assign('to_date', $this->get_calendar('to'));
-      $this->tmpl->assign('content_page', 'welcome.tpl');
+      $this->tmpl->assign('search_from_date', $this->get_calendar('from'));
+      $this->tmpl->assign('search_to_date', $this->get_calendar('to'));
+
+      $this->tmpl->assign('preset_selected_tags', $this->getSelectedTags());
+      $this->tmpl->assign('preset_available_tags', $this->getAvailableTags());
+
+      if(!isset($content)) {
+         if(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags']))
+            $this->tmpl->assign('initial_content', $this->showPhotoIndex());
+         else
+            $this->tmpl->assign('initial_content', $this->tmpl->fetch('welcome.tpl'));
+      }
+      else
+         $this->tmpl->assign('initial_content', $content);
+
       $this->tmpl->show("index.tpl");
 
    } // show()
@@ -609,8 +628,15 @@ class PHPFSPOT {
       $this->tmpl->assign('ExifOrigResolution', $meta_res);
       $this->tmpl->assign('ExifFileSize', $meta_size);
  
-      $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width);
-      $this->tmpl->assign('image_url_full', 'phpfspot_img.php?idx='. $photo);
+      if($this->is_user_friendly_url()) {
+         $this->tmpl->assign('image_url', '/photo/'. $photo ."/". $this->cfg->photo_width);
+         $this->tmpl->assign('image_url_full', '/photo/'. $photo);
+      }
+      else {
+         $this->tmpl->assign('image_url', 'phpfspot_img.php?idx='. $photo ."&width=". $this->cfg->photo_width);
+         $this->tmpl->assign('image_url_full', 'phpfspot_img.php?idx='. $photo);
+      }
+
       $this->tmpl->assign('image_filename', $this->parse_uri($details['uri'], 'filename'));
 
       $this->tmpl->assign('tags', $this->get_photo_tags($photo));
@@ -631,7 +657,7 @@ class PHPFSPOT {
       $this->tmpl->assign('photo_number', $i);
       $this->tmpl->assign('photo_count', count($all_photos));
 
-      $this->tmpl->show("single_photo.tpl");
+      return $this->tmpl->fetch("single_photo.tpl");
 
    } // showPhoto()
 
@@ -708,13 +734,15 @@ class PHPFSPOT {
          $b = '88';
 
          if(isset($this->tags[$key])) {
-            $output.= "<a href=\"javascript:Tags('add', ". $key .");\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
+            if($this->is_user_friendly_url())
+               $output.= "<a href=\"". $this->cfg->web_path ."/tag/". $key ."\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
+            else
+               $output.= "<a href=\"". $this->cfg->web_path ."/index.php?mode=showpi\" onclick=\"Tags('add', ". $key ."); return false;\" class=\"tag\" style=\"font-size: ". $size ."%; color: #". $r.$g.$b .";\">". $this->tags[$key] ."</a>, ";
          }
-
       }
 
       $output = substr($output, 0, strlen($output)-2);
-      print $output;
+      return $output;
 
    } // getAvailableTags()
 
@@ -726,7 +754,7 @@ class PHPFSPOT {
     * session-variable $_SESSION['selected_tags']
     * @return string
     */
-   public function getSelectedTags()
+   public function getSelectedTags($type = 'link')
    {
       /* retrive tags from database */
       $this->get_tags();
@@ -737,7 +765,29 @@ class PHPFSPOT {
       {
          // return all selected tags
          if(isset($_SESSION['selected_tags']) && in_array($tag, $_SESSION['selected_tags'])) {
-            $output.= "<a href=\"javascript:Tags('del', ". $tag .");\" class=\"tag\">". $this->tags[$tag] ."</a>, ";
+
+            switch($type) {
+               default:
+               case 'link':
+                  $output.= "<a href=\"javascript:Tags('del', ". $tag .");\" class=\"tag\">". $this->tags[$tag] ."</a>, ";
+                  break;
+               case 'img':
+                  $output.= "
+                  <div style=\"display: table-cell;\">
+                   <div style=\"display: table-row; text-align: center;\">
+                    <a href=\"javascript:Tags('del', ". $tag .");\" title=\"". $this->tags[$tag] ."\">
+                     <img src=\"". $this->cfg->web_path ."/phpfspot_img.php?tagidx=". $tag ."\" />
+                    </a>
+                   </div>
+                   <div style=\"display: table-row; text-align: center;\">
+                    <a href=\"javascript:Tags('del', ". $tag .");\" title=\"". $this->tags[$tag] ."\">
+                     <img src=\"". $this->cfg->web_path ."/resources/underbar.png\" />
+                    </a>
+                   </div>
+                  </div>
+                  ";
+                  break;
+            }
          }
       }
 
@@ -767,10 +817,15 @@ class PHPFSPOT {
       if(isset($_SESSION['searchfor_tag']))
          unset($_SESSION['searchfor_tag']);
 
+      // has the user requested to hide this tag, and still someone,
+      // somehow tries to add it, don't allow this.
+      if(!isset($this->cfg->hide_tags) &&
+         in_array($this->get_tag_name($tag), $this->cfg->hide_tags))
+         return "ok";
+
       if(!in_array($tag, $_SESSION['selected_tags']))
          array_push($_SESSION['selected_tags'], $tag);
 
-
       return "ok";
    
    } // addTag()
@@ -1127,6 +1182,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the photo index template.
+    * @return string
     */
    public function showPhotoIndex()
    {
@@ -1276,7 +1332,6 @@ class PHPFSPOT {
          if($last_page > 1)
             $this->tmpl->assign('page_selector', $page_select);
       }
-
       
       $current_tags = $this->getCurrentTags();
       $extern_link = "index.php?mode=showpi";
@@ -1310,18 +1365,21 @@ class PHPFSPOT {
       $this->tmpl->assign('img_fullname', $img_fullname);
       $this->tmpl->assign('img_title', $img_title);
       $this->tmpl->assign('thumbs', $thumbs);
+      $this->tmpl->assign('selected_tags', $this->getSelectedTags('img'));
 
-      $this->tmpl->show("photo_index.tpl");
+      $result = $this->tmpl->fetch("photo_index.tpl");
 
       /* if we are returning to photo index from an photo-view,
          scroll the window to the last shown photo-thumbnail.
          after this, unset the last_photo session variable.
       */
       if(isset($_SESSION['last_photo'])) {
-         print "<script language=\"JavaScript\">moveToThumb(". $_SESSION['last_photo'] .");</script>\n";
+         $result.= "<script language=\"JavaScript\">moveToThumb(". $_SESSION['last_photo'] .");</script>\n";
          unset($_SESSION['last_photo']);
       }
 
+      return $result;
+
    } // showPhotoIndex()
 
    /**
@@ -1629,6 +1687,7 @@ class PHPFSPOT {
          $this->cfg->thumb_width,
          $this->cfg->photo_width,
          $this->cfg->mini_width,
+         30,
       );
 
       /* get details from F-Spot's database */
@@ -1970,8 +2029,11 @@ class PHPFSPOT {
 
       $tags = Array();
 
-      while($row = $this->db->db_fetch_object($result))
+      while($row = $this->db->db_fetch_object($result)) {
+         if(isset($this->cfg->hide_tags) && in_array($row['name'], $this->cfg->hide_tags))
+            continue;
          $tags[$row['id']] = $row['name'];
+      }
 
       return $tags;
 
@@ -2231,7 +2293,7 @@ class PHPFSPOT {
 
       foreach($pictures as $picture) {
 
-         $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture;
+         $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture;
          if($current_tags != "") {
             $orig_url.= "&tags=". $current_tags;
          } 
@@ -2239,7 +2301,12 @@ class PHPFSPOT {
             $orig_url.= "&from_date=". $_SESSION['from_date'] ."&to_date=". $_SESSION['to_date'];
          }
 
-         $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         if($this->is_user_friendly_url()) {
+            $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width;
+         }
+         else {
+            $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         }
 
          switch($mode) {
 
@@ -2288,7 +2355,7 @@ class PHPFSPOT {
 
       foreach($pictures as $picture) {
 
-         $orig_url = $this->get_phpfspot_url() ."index.php?mode=showp&id=". $picture;
+         $orig_url = $this->get_phpfspot_url() ."/index.php?mode=showp&id=". $picture;
          if($current_tags != "") {
             $orig_url.= "&tags=". $current_tags;
          } 
@@ -2298,7 +2365,13 @@ class PHPFSPOT {
 
          $details = $this->get_photo_details($picture);
 
-         $thumb_url = $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         if($this->is_user_friendly_url()) {
+            $thumb_url = $this->get_phpfspot_url() ."/photo/". $picture ."/". $this->cfg->thumb_width;
+         }
+         else {
+            $thumb_url = $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $picture ."&width=". $this->cfg->thumb_width;
+         }
+
          $thumb_html = htmlspecialchars("
 <a href=\"". $orig_url ."\"><img src=\"". $thumb_url ."\" /></a>
 <br>
@@ -2375,7 +2448,6 @@ class PHPFSPOT {
    public function whatToDo()
    {
       if(isset($_SESSION['current_photo']) && $_SESSION['start_action'] == 'showp') {
-         return "show_photo";
       }
       elseif(isset($_SESSION['selected_tags']) && !empty($_SESSION['selected_tags'])) {
          return "showpi_tags";
@@ -2384,8 +2456,6 @@ class PHPFSPOT {
          return "showpi";
       }
 
-      return "nothing special";
-
    } // whatToDo()
 
    /**
@@ -2481,7 +2551,11 @@ class PHPFSPOT {
       else
          $_SESSION['slideshow_img']++;
 
-      return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
+      if($this->is_user_friendly_url()) {
+         return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width;
+      }
+
+      return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
 
    } // getNextSlideShowImage()
 
@@ -2501,7 +2575,11 @@ class PHPFSPOT {
       else
          $_SESSION['slideshow_img']--;
 
-      return $this->get_phpfspot_url() ."phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
+      if($this->is_user_friendly_url()) {
+         return $this->get_phpfspot_url() ."/photo/". $all_photos[$_SESSION['slideshow_img']] ."/". $this->cfg->photo_width;
+      }
+
+      return $this->get_phpfspot_url() ."/phpfspot_img.php?idx=". $all_photos[$_SESSION['slideshow_img']] ."&width=". $this->cfg->photo_width;
 
    } // getPrevSlideShowImage()
 
@@ -2527,11 +2605,26 @@ class PHPFSPOT {
    {
       $all = Array();
 
-      $result = $this->db->db_query("
-         SELECT id
-         FROM photos
-      ");
-      
+      $query_str = "
+         SELECT p.id
+         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
+               t.name IN ('".implode("','",$this->cfg->show_tags)."')";
+      }
+
+      $result = $this->db->db_query($query_str);
+
       while($row = $this->db->db_fetch_object($result)) {
          array_push($all, $row['id']);
       }
@@ -2540,6 +2633,56 @@ class PHPFSPOT {
 
    } // get_random_photo()
 
+   /**
+    * get random photo tag photo
+    *
+    * this function will get all photos tagged with the requested
+    * tag from the fspot database and randomly return ONE entry
+    *
+    * saddly there is yet no sqlite3 function which returns
+    * the bulk result in array, so we have to fill up our
+    * own here.
+    * @return array
+    */
+   public function get_random_tag_photo($tagidx)
+   {
+      $all = Array();
+
+      $query_str = "
+         SELECT p.id
+         FROM photos p
+         INNER JOIN photo_tags pt
+            ON p.id=pt.photo_id
+      ";
+
+      if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+         $query_str.= "
+            INNER JOIN tags t
+               ON pt.tag_id=t.id
+         ";
+      }
+      $query_str.= "
+         WHERE
+            pt.tag_id LIKE '". $tagidx ."'
+      ";
+
+      /*if(isset($this->cfg->show_tags) && !empty($this->cfg->show_tags)) {
+         $query_str.= "
+           AND
+               t.name IN ('".implode("','",$this->cfg->show_tags)."')
+         ";
+      }*/
+
+      $result = $this->db->db_query($query_str);
+
+      while($row = $this->db->db_fetch_object($result)) {
+         array_push($all, $row['id']);
+      }
+
+      return $all[array_rand($all)];
+
+   } // get_random_tag_photo()
+
    /**
     * validates provided date
     *
@@ -2567,7 +2710,9 @@ class PHPFSPOT {
     */
    private function ts2str($timestamp)
    {
-      return strftime("%Y-%m-%d", $timestamp);
+      if(!empty($timestamp) && is_numeric($timestamp))
+         return strftime("%Y-%m-%d", $timestamp);
+
    } // ts2str()
 
    /**
@@ -2637,6 +2782,7 @@ class PHPFSPOT {
    private function get_phpfspot_url()
    {
       return $this->get_web_protocol() ."://". $this->get_server_name() . $this->cfg->web_path;
+
    } // get_phpfspot_url()
 
    /**
@@ -2829,9 +2975,11 @@ class PHPFSPOT {
 
       }
 
-      /* check for pending slash on web_path */
-      if(!preg_match("/\/$/", $this->cfg->web_path))
-         $this->cfg->web_path.= "/";
+      /* remove trailing slash, if set */
+      if($this->cfg->web_path == "/")
+         $this->cfg->web_path = "";
+      elseif(preg_match('/\/$/', $this->cfg->web_path))
+         $this->cfg->web_path = preg_replace('/\/$/', '', $this->cfg->web_path);
 
       return $this->runtime_error;
 
@@ -2907,7 +3055,7 @@ class PHPFSPOT {
     */
    public function get_mime_info($file)
    {
-      $details = getimagesize($orig_image);
+      $details = getimagesize($file);
 
       /* if getimagesize() returns empty, try at least to find out the
          mime type.
@@ -2924,6 +3072,107 @@ class PHPFSPOT {
 
    } // get_mime_info()
 
+   /**
+    * return tag-name by tag-idx
+    *
+    * this function returns the tag-name for the requested
+    * tag specified by tag-idx.
+    * @param integer $idx
+    * @return string
+    */
+   public function get_tag_name($idx)
+   {
+       if($result = $this->db->db_fetchSingleRow("
+         SELECT name
+         FROM tags
+         WHERE
+            id LIKE '". $idx ."'")) {
+
+         return $result['name'];
+
+      }
+
+      return 0;
+      
+   } // get_tag_name()
+
+   /**
+    * parse user friendly url which got rewritten by the websever
+    * @param string $request_uri
+    * @return string
+    */
+   private function parse_user_friendly_url($request_uri)
+   {
+      if(preg_match('/\/photoview\/|\/photo\/|\/tag\//', $request_uri)) {
+
+         unset($_SESSION['start_action']);
+         unset($_SESSION['selected_tags']);
+
+         $options = explode('/', $request_uri);
+
+         switch($options[1]) {
+            case 'photoview':
+               if(is_numeric($options[2])) {
+                  $_GET['mode'] = 'showp';
+                  return $this->showPhoto($options[2]);
+               }
+               break;
+            case 'photo':
+               if(is_numeric($options[2])) {
+                  require_once "phpfspot_img.php";
+                  $img = new PHPFSPOT_IMG;
+                  if(isset($options[3]) && is_numeric($options[3]))
+                     $img->showImg($options[2], $options[3]);
+                  else
+                     $img->showImg($options[2]);
+               }
+               exit;
+               break;
+            case 'tag':
+               if(is_numeric($options[2])) {
+                  $this->session_cleanup();
+                  $_GET['tags'] = $options[2];
+                  $_SESSION['selected_tags'] = Array($options[2]);
+                  return $this->showPhotoIndex();
+               }
+               break;
+         }
+      }
+
+   } // parse_user_friendly_url()
+
+   /**
+    * check if user-friendly-urls are enabled
+    *
+    * this function will return true, if the config option
+    * $user_friendly_url has been set. Otherwise false.
+    * @return boolean
+    */
+   private function is_user_friendly_url()
+   {
+      if(isset($this->cfg->user_friendly_url) && $this->cfg->user_friendly_url)
+         return true;
+
+      return false;
+
+   } // is_user_friendly_url()
+
+   /**
+    * session cleanup
+    *
+    * this function will cleanup user's session information
+    */
+   private function session_cleanup()
+   {
+      unset($_SESSION['begin_with']);
+      $this->resetDateSearch();
+      $this->resetPhotoView();
+      $this->resetTagSearch();
+      $this->resetNameSearch();
+      $this->resetDateSearch();
+
+   } // session_cleanup()
+
 } // class PHPFSPOT
 
 ?>