added 'location' field for log entries; closes #304

Author: following5

okapi/services/logs/entries/WebService.php

@@ -21,7 +21,7 @@ public static function options()
     private static $valid_field_names = array(
         'uuid', 'cache_code', 'date', 'user', 'type', 'was_recommended', 'comment',
         'images', 'internal_id', 'oc_team_entry', 'needs_maintenance2',
-        'listing_is_outdated',
+        'listing_is_outdated', 'location',
     );
 
     public static function call(OkapiRequest $request)
@@ -53,13 +53,17 @@ public static function call(OkapiRequest $request)
             $ratingdate_condition = 'and cr.rating_date=cl.date';
             $needs_maintenance_SQL = 'cl.needs_maintenance';
             $listing_is_outdated_SQL = 'cl.listing_outdated';
+            $join_SQL = '';
+            $latlong_SQL = ', null as latitude, null as longitude';
         }
         else
         {
             $teamentry_field = '(cl.type=12)';
             $ratingdate_condition = '';
             $needs_maintenance_SQL = 'IF(cl.type=5, 2, IF(cl.type=6, 1, 0))';
             $listing_is_outdated_SQL = '0';
+            $join_SQL = 'left join cache_moved cm on cm.log_id=cl.id';
+            $latlong_SQL = ', cm.latitude, cm.longitude';
         }
         $rs = Db::query("
             select
@@ -70,6 +74,7 @@ public static function call(OkapiRequest $request)
                 unix_timestamp(cl.date) as date, cl.text,
                 u.uuid as user_uuid, u.username, u.user_id,
                 if(cr.user_id is null, 0, 1) as was_recommended
+                ".$latlong_SQL."
             from
                 (cache_logs cl,
                 user u,
@@ -82,6 +87,7 @@ public static function call(OkapiRequest $request)
                         ".Okapi::logtypename2id("Found it").",
                         ".Okapi::logtypename2id("Attended")."
                     )
+                ".$join_SQL."
             where
                 cl.uuid in ('".implode("','", array_map('\okapi\Db::escape_string', $log_uuids))."')
                 and ".((Settings::get('OC_BRANCH') == 'oc.pl') ? "cl.deleted = 0" : "true")."
@@ -109,6 +115,7 @@ public static function call(OkapiRequest $request)
                 'listing_is_outdated' => $flag_options[$row['listing_is_outdated']],
                 'oc_team_entry' => $row['oc_team_entry'] ? true : false,
                 'comment' => Okapi::fix_oc_html($row['text'], Okapi::OBJECT_TYPE_CACHE_LOG),
+                'location' => $row['latitude'] === null ? null : round($row['latitude'], 6)."|".round($row['longitude'], 6),
                 'images' => array(),
                 'internal_id' => $row['id'],
             );

okapi/services/logs/entry/docs.xml

@@ -155,7 +155,19 @@
                 <p>Please note that OCPL-based installations will always return <b>null</b> here.</p>
             </li>
             <li><b>comment</b> - <a href='%OKAPI:docurl:html%'>HTML string</a>, text entered
-                with the log entry,</li>
+                with the log entry,
+            </li>
+            <li>
+                <p><b>location</b> - the location of the geocache that was provided
+                by the logger, in "lat|lon" format (<i>lat</i> and <i>lon</i> are
+                in full degrees with a dot as a decimal point); <b>null</b>
+                if no location was provided. For "Moved" logs this is the location
+                where the cache has been moved to, for all other types of log the
+                location where the cache has been found.</p>
+                <p>Note that currently no OC site allows to log a location for other
+                types than "Moved", so <em>currently</em> it is always <b>null</b>
+                for other logs than "Moved".</p>
+            </li>
             <li>
                 <p><b>images</b> - list of dictionaries, each dictionary represents one
                 image saved along with the log; each dictionary has the following