New parameter in search methods: powertrail_only (BETA)

Author: wrygiel

okapi/core.php

@@ -805,12 +805,12 @@ public function print_body()
     public function get_body()
     {
         $this->zip->Flush(clsTbsZip::TBSZIP_STRING);
-        return $this->zip->OutputSrc; 
+        return $this->zip->OutputSrc;
     }
 
     public function get_length()
     {
-        # The _EstimateNewArchSize() method returns *false* if archive 
+        # The _EstimateNewArchSize() method returns *false* if archive
         # size can not be calculated *exactly*, which causes display()
         # method to skip Content-Length header, and triggers chunking
         return $this->zip->_EstimateNewArchSize();

okapi/facade.php

@@ -103,7 +103,7 @@ public static function import_search_set($temp_table, $min_store, $max_ref_age)
             'caches.status in (1,2,3)',
         );
         return \okapi\services\caches\search\save\WebService::get_set(
-            $tables, $where_conds, $min_store, $max_ref_age
+            $tables, array() /* joins */, $where_conds, $min_store, $max_ref_age
         );
     }
 

okapi/lib/tbszip.php

@@ -16,7 +16,7 @@ class clsTbsZip {
     const TBSZIP_NOHEADER = 4;   // option to use with DOWNLOAD: no header is sent
     const TBSZIP_FILE     = 8;   // output to file  , or add from file
     const TBSZIP_STRING   = 32;  // output to string, or add from string
-    
+
     function __construct() {
         $this->Meth8Ok = extension_loaded('zlib'); // check if Zlib extension is available. This is need for compress and uncompress with method 8.
         $this->DisplayError = true;
@@ -956,7 +956,7 @@ function _DataPrepare(&$Ref) {
             }
         }
     }
-    /** 
+    /**
      * Return the size of the new archive, or false if it cannot be calculated (because of external file that must be compressed before to be insered)
      */
     function _EstimateNewArchSize($Optim=true) {

okapi/services/caches/search/all.xml

@@ -160,6 +160,13 @@
         Boolean. If set to <b>true</b>, only caches which have not yet been
         found <b>by anyone</b> will be included.
     </opt>
+    <opt name='powertrail_only' default='false'>
+        BETA. Boolean. If set to <b>true</b>, only caches which belong to at least one
+        Power Trail will be included. Power Trails are sets of geocaches. Not all
+        Opencaching nodes implement the feature. If this node does not implement
+        Power Trails and you will set this parameter to <b>true</b>, then you
+        will <b>always</b> receive an empty result.
+    </opt>
     <opt name='set_and'>
         <p>ID of a set previously created with the <b>search/save</b> method.
         If given, the results are <a href='http://en.wikipedia.org/wiki/Logical_conjunction'>AND</a>ed

okapi/services/caches/search/save.php

@@ -74,24 +74,30 @@ public static function call(OkapiRequest $request)
             array('caches.wp_oc is not null'),
             $search_params['where_conds']
         );
+
+        if (isset($search_params['extra_joins']) && is_array($search_params['extra_joins']))
+            $joins = $search_params['extra_joins'];
+        else
+            $joins = array();
+
         unset($search_params);
 
         # Generate, or retrieve an existing set, and return the result.
         # All user-supplied data in $tables and $where_conds MUST be escaped!
 
-        $result = self::get_set($tables, $where_conds, $min_store, $ref_max_age);
+        $result = self::get_set($tables, $joins, $where_conds, $min_store, $ref_max_age);
         return Okapi::formatted_response($request, $result);
     }
 
     /**
      * Important: YOU HAVE TO make sure $tables and $where_conds don't contain
      * unescaped user-supplied data!
      */
-    public static function get_set($tables, $where_conds, $min_store, $ref_max_age)
+    public static function get_set($tables, $joins, $where_conds, $min_store, $ref_max_age)
     {
         # Compute the "params hash".
 
-        $params_hash = md5(serialize(array($tables, $where_conds)));
+        $params_hash = md5(serialize(array($tables, $joins, $where_conds)));
 
         # Check if there exists an entry for this hash, which also meets the
         # given freshness criteria.
@@ -133,7 +139,9 @@ public static function get_set($tables, $where_conds, $min_store, $ref_max_age)
                         select distinct
                             '".mysql_real_escape_string($set_id)."',
                             caches.cache_id
-                        from ".implode(", ", $tables)."
+                        from
+                            ".implode(", ", $tables)."
+                            ".implode(" ", $joins)."
                         where (".implode(") and (", $where_conds).")
                     ");
 

okapi/services/caches/search/searching.inc.php

@@ -514,13 +514,30 @@ public function prepare_common_search_params()
         if ($tmp = $this->request->get_parameter('ftf_hunter'))
         {
             if (!in_array($tmp, array('true', 'false'), 1))
-                throw new InvalidParam('not_yet_found_only', "'$tmp'");
+                throw new InvalidParam('ftf_hunter', "'$tmp'");
             if ($tmp == 'true')
             {
                 $where_conds[] = "$X_FOUNDS = 0";
             }
         }
 
+        #
+        # powertrail_only
+        #
+        if (!is_null($tmp = $this->request->get_parameter('powertrail_only')))
+        {
+            if (!in_array($tmp, array('true', 'false'), 1))
+                throw new InvalidParam('powertrail_only', "'$tmp'");
+            if ($tmp == 'true')
+            {
+                if (Settings::get('OC_BRANCH') == 'oc.pl') {
+                    $extra_joins[] = 'inner join powerTrail_caches on powerTrail_caches.cacheId = caches.cache_id';
+                } else {
+                    $where_conds[] = "0=1";
+                }
+            }
+        }
+
         #
         # set_and
         #