added "only user's logs" option to geocache retrieval methods

Author: following5

okapi/services/caches/formatters/gpx/WebService.php

@@ -95,15 +95,19 @@ public static function create_gpx(OkapiRequest $request, $flags = null)
         $langpref = $request->get_parameter('langpref');
         if (!$langpref) $langpref = "en";
         $langprefs = explode("|", $langpref);
-        foreach (array('ns_ground', 'ns_gsak', 'ns_ox', 'ns_oc', 'latest_logs', 'alt_wpts', 'mark_found') as $param)
+        foreach (array('ns_ground', 'ns_gsak', 'ns_ox', 'ns_oc', 'alt_wpts', 'mark_found') as $param)
         {
             $val = $request->get_parameter($param);
-            if (!$val) $val = "false";
-            elseif (!in_array($val, array("true", "false")))
+            if (!$val) $val = 'false';
+            elseif (!in_array($val, array('true', 'false')))
                 throw new InvalidParam($param);
-            $vars[$param] = ($val == "true");
+            $vars[$param] = ($val == 'true');
         }
-        if ($vars['latest_logs'] && (!$vars['ns_ground']))
+
+        $vars['latest_logs'] = $request->get_parameter('latest_logs');
+        if (!in_array($vars['latest_logs'], array('true', 'user', 'false')))
+            throw new InvalidParam('latest_logs');
+        if ($vars['latest_logs'] !== 'false' && (!$vars['ns_ground']))
             throw new BadRequest("In order for 'latest_logs' to work you have to also include 'ns_ground' extensions.");
 
         $tmp = $request->get_parameter('my_notes');
@@ -220,7 +224,7 @@ public static function create_gpx(OkapiRequest $request, $flags = null)
             $fields .= "|recommendations|founds";
         if (count($vars['my_notes']) > 0)
             $fields .= "|my_notes";
-        if ($vars['latest_logs'])
+        if ($vars['latest_logs'] != 'false')
             $fields .= "|latest_logs";
         if ($vars['mark_found'])
             $fields .= "|is_found";
@@ -232,6 +236,7 @@ public static function create_gpx(OkapiRequest $request, $flags = null)
                     'langpref' => $langpref,
                     'fields' => $fields,
                     'lpc' => $lpc,
+                    'user_logs_only' => ($vars['latest_logs'] == 'user' ? 'true' : 'false'),
                     'user_uuid' => $user_uuid,
                     'log_fields' => 'uuid|date|user|type|comment|oc_team_entry|internal_id|was_recommended'
                 )

okapi/services/caches/formatters/gpx/docs.xml

@@ -181,8 +181,17 @@
         <p>Note: You need to use Level 3 Authentication in order to set it to anything else than "none".</p>
     </opt>
     <opt name='latest_logs' default='false'>
-        <p>Boolean. If <b>true</b> then the response will include a couple of
-        latest log entries for this cache (see also the <b>lpc</b> argument).</p>
+        <p>This argument controls if log entries are included. There are three options:</p>
+        <ul>
+            <li><b>true</b> - include the latest log entries for each cache; the <b>lpc</b>
+            argument controls the number of included entries,</li>
+            <li><b>user</b> - with Level 3 Authentication, include (only) the latest
+            log entries of your user for each cache. With Level 1 or 2 Authentication,
+            include (only) the latest log entries of the user given in the
+            <b>user_uuid</b> argument. The <b>lpc</b> argument controls the number of
+            included entries,</li>
+            <li><b>false</b> - do not include any log entries.</li>
+        </ul>
         <p>You <b>must</b> set <b>ns_ground</b> argument to <b>true</b> if you want to use this.</p>
     </opt>
     <opt name='lpc' default='10'>

okapi/services/caches/formatters/gpx/gpxfile.tpl.php

@@ -168,7 +168,7 @@
                     <?php if ((in_array('gc:personal_note', $vars['my_notes'])) && ($c['my_notes'] != null)) { /* Does user want us to include personal notes? -> Issue 294 */ ?>
                         <groundspeak:personal_note><?= Okapi::xmlescape($c['my_notes']) ?></groundspeak:personal_note>
                     <?php } ?>
-                    <?php if ($vars['latest_logs']) { /* Does user want us to include latest log entries? */ ?>
+                    <?php if ($vars['latest_logs'] !== 'false') { /* Does user want us to include latest log entries? */ ?>
                         <groundspeak:logs>
                             <?php foreach ($c['latest_logs'] as $log) { ?>
                                 <groundspeak:log id="<?= $log['internal_id'] ?>">
@@ -221,7 +221,7 @@
                     <?php if ($c['gc_code']) { ?>
                         <oc:other_code><?= $c['gc_code'] ?></oc:other_code>
                     <?php } ?>
-                    <?php if ($vars['latest_logs']) { /* Does user want us to include latest log entries? */ ?>
+                    <?php if ($vars['latest_logs'] !== 'false') { /* Does user want us to include latest log entries? */ ?>
                         <oc:logs>
                             <?php foreach ($c['latest_logs'] as $log) { ?>
                                 <oc:log id="<?= $log['internal_id'] ?>" uuid="<?= $log['uuid'] ?>">

okapi/services/caches/geocache/WebService.php

@@ -32,6 +32,8 @@ public static function call(OkapiRequest $request)
         if (!$log_fields) $log_fields = "uuid|date|user|type|comment";
         $lpc = $request->get_parameter('lpc');
         if (!$lpc) $lpc = 10;
+        $user_logs_only = $request->get_parameter('user_logs_only');
+        if ($user_logs_only === null) $user_logs_only = 'false';
         $attribution_append = $request->get_parameter('attribution_append');
         if (!$attribution_append) $attribution_append = 'full';
         $params = array(
@@ -40,7 +42,8 @@ public static function call(OkapiRequest $request)
             'fields' => $fields,
             'attribution_append' => $attribution_append,
             'lpc' => $lpc,
-            'log_fields' => $log_fields
+            'log_fields' => $log_fields,
+            'user_logs_only' => $user_logs_only,
         );
         $my_location = $request->get_parameter('my_location');
         if ($my_location)

okapi/services/caches/geocache/docs.xml

@@ -60,6 +60,15 @@
         Pipe-separated list of log fields to include in the <b>latest_logs</b> field.
         For valid field names, see <b>logs/entry</b> method.
     </opt>
+    <opt name='user_logs_only' default='false'>
+        <p>Boolean. If <b>true</b> with Level 3 Authentication, only logs
+        of your user will be included in the <b>latest_logs</b> field. If
+        <b>true</b> with Level 1 or 2 Authentication, then the parameter
+        <b>user_uuid</b> must be supplied, and only logs of that user will be
+        included in the <b>latest_logs</b> field. You must include the
+        <b>latest_logs</b> field in <b>fields</b> in order to see the log
+        entries.</p>
+    </opt>
     <opt name='my_location'>
         <p>The reference point for cache distance and bearing calculation (typically - the user's location),
         in the "lat|lon" format. This parameter is required when accessing <b>distance</b> and/or <b>bearing</b>

okapi/services/caches/geocaches/WebService.php

@@ -95,9 +95,6 @@ public static function call(OkapiRequest $request)
         if (!in_array($attribution_append, array('none', 'static', 'full')))
             throw new InvalidParam('attribution_append');
 
-        $log_fields = $request->get_parameter('log_fields');
-        if (!$log_fields) $log_fields = "uuid|date|user|type|comment";  // validation is done on call
-
         $user_uuid = $request->get_parameter('user_uuid');
         if ($user_uuid != null)
         {
@@ -112,6 +109,9 @@ public static function call(OkapiRequest $request)
         else
             $user_id = null;
 
+        $log_fields = $request->get_parameter('log_fields');
+        if (!$log_fields) $log_fields = "uuid|date|user|type|comment";  // validation is done on call
+
         $lpc = $request->get_parameter('lpc');
         if ($lpc === null) $lpc = 10;
         if ($lpc == 'all')
@@ -125,6 +125,10 @@ public static function call(OkapiRequest $request)
                 throw new InvalidParam('lpc', "Must be a positive value.");
         }
 
+        $user_logs_only = $request->get_parameter('user_logs_only');
+        if (!in_array($user_logs_only, array('true', 'false')))
+            throw new InvalidParam('user_logs_only', "Unknown option: '$user_logs_only'.");
+
         if (in_array('distance', $fields) || in_array('bearing', $fields) || in_array('bearing2', $fields)
             || in_array('bearing3', $fields))
         {
@@ -693,6 +697,19 @@ public static function call(OkapiRequest $request)
 
         if (in_array('latest_logs', $fields))
         {
+            if ($user_logs_only == 'true') {
+                if ($user_id == null) {
+                    # This error can also be triggered via caches/formatters/gpx, which has
+                    # the "latest_logs=user" option instead of "only_user_logs=true".
+                    # Therefore we avoid to mention "only_user_logs" in the error message.
+
+                    throw new BadRequest("Either 'user_uuid' parameter OR Level 3 Authentication is required to retrieve the user's logs.");
+                }
+                $add_where_sql = " and cache_logs.user_id = '".Db::escape_string($user_id)."'";
+            } else {
+                $add_where_sql = "";
+            }
+
             foreach ($results as &$result_ref)
                 $result_ref['latest_logs'] = array();
 
@@ -718,8 +735,9 @@ public static function call(OkapiRequest $request)
                 from cache_logs
                 where
                     cache_id in ('".implode("','", array_map('\okapi\core\Db::escape_string', array_keys($cacheid2wptcode)))."')
-                    and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true")."
-                order by cache_id, ".$logs_order_field_SQL." desc, date_created desc, id desc
+                    and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "deleted = 0" : "true").
+                    $add_where_sql."
+                order by cache_id, ".$logs_order_field_SQL." desc, cache_logs.date_created desc, cache_logs.id desc
             ");
 
             $loguuids = array();

okapi/services/caches/geocaches/docs.xml

@@ -35,6 +35,9 @@
     <opt name='log_fields' default='uuid|date|user|type|comment'>
         Same as in the services/caches/geocache method.
     </opt>
+    <opt name='user_logs_only' default='false'>
+        Same as in the services/caches/geocache method.
+    </opt>
     <opt name='my_location'>
         Same as in the services/caches/geocache method.
     </opt>