added log and geocache options to select user fields; updates #569

following5 · following5 · commit b21cc2d25d65 · 2018-12-04T14:59:13.000+01:00
diff --git a/okapi/services/caches/geocache/WebService.php b/okapi/services/caches/geocache/WebService.php
@@ -28,8 +28,12 @@ public static function call(OkapiRequest $request)
         if (!$langpref) $langpref = "en";
         $fields = $request->get_parameter('fields');
         if (!$fields) $fields = "code|name|location|type|status";
+        $owner_fields = $request->get_parameter('owner_fields');
+        if (!$owner_fields) $owner_fields = "uuid|username|profile_url";
         $log_fields = $request->get_parameter('log_fields');
         if (!$log_fields) $log_fields = "uuid|date|user|type|comment";
+        $log_user_fields = $request->get_parameter('log_user_fields');
+        if (!$log_user_fields) $log_user_fields = "uuid|username|profile_url";
         $lpc = $request->get_parameter('lpc');
         if (!$lpc) $lpc = 10;
         $user_logs_only = $request->get_parameter('user_logs_only');
@@ -42,10 +46,12 @@ public static function call(OkapiRequest $request)
             'cache_codes' => $cache_code,
             'langpref' => $langpref,
             'fields' => $fields,
+            'owner_fields' => $owner_fields,
             'attribution_append' => $attribution_append,
             'oc_team_annotation' => $oc_team_annotation,
             'lpc' => $lpc,
             'log_fields' => $log_fields,
+            'log_user_fields' => $log_user_fields,
             'user_logs_only' => $user_logs_only,
         );
         $my_location = $request->get_parameter('my_location');
diff --git a/okapi/services/caches/geocache/docs.xml b/okapi/services/caches/geocache/docs.xml
@@ -69,14 +69,25 @@
         <p>Note that some OC installations do not implement team annotations. They will
         ignore this parameter.</p>
     </opt>
+    <opt name='owner_fields' default='uuid|username|profile_url'>
+        Pipe-separated list of user fields to include in the <b>owner</b> field.
+        For valid field names, see
+        <a href='%OKAPI:methodargref:services/users/user%'>services/users/user</a> method.
+    </opt>
     <opt name='lpc' default='10'>
         Log-entries per cache - the number of logs returned in the <b>latest_logs</b> field.
         This should be an integer or a special "all" value. Please note, that you must include
         the <b>latest_logs</b> field in <b>fields</b> in order to see the log entries.
     </opt>
     <opt name='log_fields' default='uuid|date|user|type|comment'>
         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.
+        For valid field names, see the
+        <a href='%OKAPI:methodargref:services/logs/entry%'>logs/entry</a> method.
+    </opt>
+    <opt name='log_user_fields' default='uuid|username|profile_url'>
+        Pipe-separated list of user fields to include in the <b>user</b> subfield
+        of the <b>latest_logs</b> field. For valid field names, see the
+        <a href='%OKAPI:methodargref:services/users/user%'>services/users/user</a> method.
     </opt>
     <opt name='user_logs_only' default='false'>
         <p>Boolean. If <b>true</b> with Level 3 Authentication, only logs
@@ -97,7 +108,7 @@
         western hemispheres accordingly). These are full degrees with a dot
         as a decimal point (ex. "54.3|22.3").</p>
     </opt>
-    <opt name="user_uuid">
+    <opt name='user_uuid'>
         <p>User'd ID. Required to access fields like <b>is_found</b> using <b>Level 1</b> Authentication.</p>
 
         <p>Please note that if you want to access private fields (like <b>my_notes</b>), then
@@ -181,12 +192,8 @@
             </li>
             <li><b>url</b> - URL of the cache's web page,</li>
             <li>
-                <p><b>owner</b> - dictionary of:</p>
-                <ul>
-                    <li><b>uuid</b> - geocache owner's user ID,</li>
-                    <li><b>username</b> - name of the user,</li>
-                    <li><b>profile_url</b> - URL of the user profile page,</li>
-                </ul>
+                <p><b>owner</b> - dictionary of user fields that are selected by the
+                <b>owner_fields</b> option.</p>
             </li>
             <li>
                 <p><b>gc_code</b> - Geocaching.com code (GC code) of the geocache
@@ -463,7 +470,8 @@
                 <p><b>latest_logs</b> - a couple of latest log entries in the cache.
                 The format is the same as the one returned by the services/logs/logs method.</p>
 
-                <p>Note: The number of logs returned can be set with the <b>lpc</b> option.</p>
+                <p>Note: The number of logs returned can be set with the <b>lpc</b> option,
+                and the fields to return can be selected by the <b>log_fields</b> option.</p>
             </li>
             <li>
                 <p><b>my_notes</b> - user's notes on the cache, in plain-text, or <b>null</b>
diff --git a/okapi/services/caches/geocaches/WebService.php b/okapi/services/caches/geocaches/WebService.php
@@ -121,6 +121,10 @@ public static function call(OkapiRequest $request)
 
         $log_fields = $request->get_parameter('log_fields');
         if (!$log_fields) $log_fields = "uuid|date|user|type|comment";  // validation is done on call
+        $log_user_fields = $request->get_parameter('log_user_fields');
+        if (!$log_user_fields) $log_user_fields = "uuid|username|profile_url";  // validation is done on call
+        $owner_fields = $request->get_parameter('owner_fields');
+        if (!$owner_fields) $owner_fields = "uuid|username|profile_url";  // validation is done on call
 
         $lpc = $request->get_parameter('lpc');
         if ($lpc === null) $lpc = 10;
@@ -395,25 +399,77 @@ public static function call(OkapiRequest $request)
 
         # owner
 
-        if (in_array('owner', $fields) && (count($results) > 0))
+        if (in_array('owner', $fields) && count($results) > 0)
         {
-            $rs = Db::query("
-                select user_id, uuid, username
-                from user
-                where user_id in ('".implode("','", array_map('\okapi\core\Db::escape_string', array_values($owner_ids)))."')
-            ");
-            $tmp = array();
-            while ($row = Db::fetch_assoc($rs))
-                $tmp[$row['user_id']] = $row;
-            foreach ($results as $cache_code => &$result_ref)
+            # If the user only requests default fields or other "basic fields"
+            # which can easily be handled, we will directly serve the request.
+            # Otherwise we call the more expensive users/by_internal_ids method.
+
+            $basic_owner_fields = ['uuid', 'username', 'profile_url', 'internal_id'];
+            $owner_fields_exploded = explode('|', $owner_fields);
+
+            if (count(array_diff($owner_fields_exploded, $basic_owner_fields)) == 0)
             {
-                $row = $tmp[$owner_ids[$cache_code]];
-                $result_ref['owner'] = array(
-                    'uuid' => $row['uuid'],
-                    'username' => $row['username'],
-                    'profile_url' => Settings::get('SITE_URL')."viewprofile.php?userid=".$row['user_id']
+                $rs = Db::query("
+                    select user_id, uuid, username
+                    from user
+                    where user_id in ('".implode("','", array_map('\okapi\core\Db::escape_string', array_values($owner_ids)))."')
+                ");
+                $tmp = array();
+                while ($row = Db::fetch_assoc($rs))
+                    $tmp[$row['user_id']] = $row;
+                Db::free_result($rs);
+
+                foreach ($results as $cache_code => &$result_ref)
+                {
+                    $row = $tmp[$owner_ids[$cache_code]];
+                    $tmp = [];
+                    foreach ($owner_fields_exploded as $field)
+                    {
+                        if ($field == 'uuid')
+                            $tmp['uuid'] = $row['uuid'];
+                        elseif ($field == 'username')
+                            $tmp['username'] = $row['username'];
+                        elseif ($field == 'profile_url')
+                            $tmp['profile_url'] = Settings::get('SITE_URL')."viewprofile.php?userid=".$row['user_id'];
+                        elseif ($field == 'internal_id')
+                            $tmp['internal_id'] = $row['user_id'];
+                    }
+                    $result_ref['owner'] = $tmp;
+                }
+            }
+            else
+            {
+                $ownersRequest = new OkapiInternalRequest(
+                    $request->consumer,
+                    $request->token,
+                    array(
+                        'internal_ids' => implode('|', $owner_ids),
+                        'fields' => $owner_fields
+                    )
                 );
+                $ownersRequest->skip_limits = true;
+                try
+                {
+                    $tmp = OkapiServiceRunner::call("services/users/by_internal_ids", $ownersRequest);
+                }
+                catch (Exception $e)
+                {
+                    if (($e instanceof InvalidParam) && ($e->paramName == 'fields')) {
+                        throw new InvalidParam('owner_fields', $e->whats_wrong_about_it);
+                    }
+                    else {
+                        /* Something is wrong with OUR code. */
+                        throw new Exception($e);
+                    }
+                }
+                foreach ($results as $cache_code => &$result_ref) {
+                    $result_ref['owner'] = $tmp[$owner_ids[$cache_code]];
+                }
+                unset($ownersRequest);
             }
+            unset($owner_fields_exploded);
+            unset($basic_owner_fields);
         }
 
         # is_found
@@ -969,7 +1025,8 @@ public static function call(OkapiRequest $request)
                         new OkapiInternalRequest(
                             $request->consumer, $request->token, array(
                                 'log_uuids' => implode("|", $subset),
-                                'fields' => $log_fields
+                                'fields' => $log_fields,
+                                'user_fields' => $log_user_fields,
                             )
                         )
                     );
@@ -986,6 +1043,10 @@ public static function call(OkapiRequest $request)
                 {
                     throw new InvalidParam('log_fields', $e->whats_wrong_about_it);
                 }
+                elseif (($e instanceof InvalidParam) && ($e->paramName == 'user_fields'))
+                {
+                    throw new InvalidParam('log_user_fields', $e->whats_wrong_about_it);
+                }
                 else
                 {
                     /* Something is wrong with OUR code. */
diff --git a/okapi/services/caches/geocaches/docs.xml b/okapi/services/caches/geocaches/docs.xml
@@ -29,12 +29,21 @@
     <opt name='attribution_append' default='full'>
         <p>Same as in the services/caches/geocache method.</p>
     </opt>
+    <opt name='oc_team_annotation' default='description'>
+        Same as in the services/caches/geocache method.
+    </opt>
+    <opt name='owner_fields' default='uuid|username|profile_url'>
+        Same as in the services/caches/geocache method.
+    </opt>
     <opt name='lpc' default='10'>
         Same as in the services/caches/geocache method.
     </opt>
     <opt name='log_fields' default='uuid|date|user|type|comment'>
         Same as in the services/caches/geocache method.
     </opt>
+    <opt name='log_user_fields' default='uuid|username|profile_url'>
+        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>
diff --git a/okapi/services/logs/entries/WebService.php b/okapi/services/logs/entries/WebService.php
@@ -2,10 +2,13 @@
 
 namespace okapi\services\logs\entries;
 
+use Exception;
 use okapi\core\Db;
 use okapi\core\Exception\InvalidParam;
 use okapi\core\Exception\ParamMissing;
 use okapi\core\Okapi;
+use okapi\core\OkapiServiceRunner;
+use okapi\core\Request\OkapiInternalRequest;
 use okapi\core\Request\OkapiRequest;
 use okapi\Settings;
 
@@ -47,6 +50,22 @@ public static function call(OkapiRequest $request)
             if (!in_array($field, self::$valid_field_names))
                 throw new InvalidParam('fields', "'$field' is not a valid field code.");
 
+        if (!in_array('user', $fields))
+            $user_fields = false;
+        else
+        {
+            $user_fields = $request->get_parameter('user_fields');   // validation is done on call
+            if (!$user_fields) {
+                $user_fields = ['uuid', 'username', 'profile_url'];
+                $only_basic_user_fields = true;
+            } else {
+                $user_fields = explode('|', $user_fields);
+                $only_basic_user_fields = count(array_diff(
+                    $user_fields, ['uuid', 'username', 'profile_url', 'internal_id']
+                )) == 0;
+            }
+        }
+
         if (Settings::get('OC_BRANCH') == 'oc.de')
         {
             $teamentry_field = 'cl.oc_team_comment';
@@ -102,18 +121,14 @@ public static function call(OkapiRequest $request)
         ");
         $results = array();
         $log_id2uuid = array(); /* Maps logs' internal_ids to uuids */
+        $log_user_ids = array();
         $flag_options = array('null', 'false', 'true');
         while ($row = Db::fetch_assoc($rs))
         {
             $results[$row['uuid']] = array(
                 'uuid' => $row['uuid'],
                 'cache_code' => $row['cache_code'],
                 'date' => date('c', $row['date']),
-                'user' => array(
-                    'uuid' => $row['user_uuid'],
-                    'username' => $row['username'],
-                    'profile_url' => Settings::get('SITE_URL')."viewprofile.php?userid=".$row['user_id'],
-                ),
                 'type' => Okapi::logtypeid2name($row['type']),
                 'was_recommended' => $row['was_recommended'] ? true : false,
                 'needs_maintenance2' => $flag_options[$row['needs_maintenance2']],
@@ -126,7 +141,23 @@ public static function call(OkapiRequest $request)
                 'last_modified' => date("Y-m-d", strtotime($row['last_modified'])),
                 'internal_id' => $row['id'],
             );
+            if ($user_fields && $only_basic_user_fields) {
+                $tmp = [];
+                foreach ($user_fields as $field)
+                {
+                    if ($field == 'uuid')
+                        $tmp['uuid'] = $row['user_uuid'];
+                    elseif ($field == 'username')
+                        $tmp['username'] = $row['username'];
+                    elseif ($field == 'profile_url')
+                        $tmp['profile_url'] = Settings::get('SITE_URL')."viewprofile.php?userid=".$row['user_id'];
+                    elseif ($field == 'internal_id')
+                        $tmp['internal_id'] = $row['user_id'];
+                }
+                $results[$row['uuid']]['user'] = $tmp;
+            }
             $log_id2uuid[$row['id']] = $row['uuid'];
+            $log_uuid2user_uuid[$row['uuid']] = $row['user_uuid'];
         }
         Db::free_result($rs);
 
@@ -166,6 +197,39 @@ public static function call(OkapiRequest $request)
             Db::free_result($rs);
         }
 
+        # fetch users, if non-default user fields are selected
+
+        if ($user_fields && !$only_basic_user_fields)
+        {
+            $usersRequest = new OkapiInternalRequest(
+                $request->consumer,
+                $request->token,
+                array(
+                    'user_uuids' => implode('|', array_values($log_uuid2user_uuid)),
+                    'fields' => implode('|', $user_fields)
+                )
+            );
+            $usersRequest->skip_limits = true;
+            try
+            {
+                $tmp = OkapiServiceRunner::call("services/users/users", $usersRequest);
+            }
+            catch (Exception $e)
+            {
+                if (($e instanceof InvalidParam) && ($e->paramName == 'fields')) {
+                    throw new InvalidParam('user_fields', $e->whats_wrong_about_it);
+                }
+                else {
+                    /* Something is wrong with OUR code. */
+                    throw new Exception($e);
+                }
+            }
+            foreach ($results as $uuid => &$result_ref) {
+                $result_ref['user'] = $tmp[$log_uuid2user_uuid[$uuid]];
+            }
+            unset($usersRequest);
+        }
+
         # Check which UUIDs were not found and mark them with null.
 
         foreach ($log_uuids as $log_uuid)
diff --git a/okapi/services/logs/entries/docs.xml b/okapi/services/logs/entries/docs.xml
@@ -13,9 +13,15 @@
     </req>
     <opt name='fields' default='date|user|type|comment'>
         <p>Same as in the services/logs/entry method. Pipe-separated list
-        of field names which you are interested with.
+        of field names which you are interested in.
         See services/logs/entry method for a list of available values.</p>
     </opt>
+    <opt name='user_fields' default='uuid|username|profile_url'>
+        Same as in the services/logs/entry method. Pipe-separated list
+        of user fields to include in the <b>user</b> field. For valid
+        field names, see the
+        <a href='%OKAPI:methodargref:services/users/user%'>services/users/user</a> method.
+    </opt>
     <common-format-params/>
     <returns>
         <p>A dictionary. UUIDs you provide will be mapped to dictionary keys,
diff --git a/okapi/services/logs/entry/WebService.php b/okapi/services/logs/entry/WebService.php
@@ -24,10 +24,16 @@ public static function call(OkapiRequest $request)
         if (!$log_uuid) throw new ParamMissing('log_uuid');
         $fields = $request->get_parameter('fields');
         if (!$fields) $fields = "date|user|type|comment";
+        $user_fields = $request->get_parameter('user_fields');
+        if (!$user_fields) $user_fields = "uuid|username|profile_url";
 
         $results = OkapiServiceRunner::call('services/logs/entries', new OkapiInternalRequest(
-            $request->consumer, $request->token, array('log_uuids' => $log_uuid,
-            'fields' => $fields)));
+            $request->consumer, $request->token, array(
+                'log_uuids' => $log_uuid,
+                'fields' => $fields,
+                'user_fields' => $user_fields,
+            )
+        ));
         $result = $results[$log_uuid];
         if ($result == null)
             throw new InvalidParam('log_uuid', "This log entry does not exist.");
diff --git a/okapi/services/logs/entry/docs.xml b/okapi/services/logs/entry/docs.xml
diff --git a/okapi/services/logs/logs/WebService.php b/okapi/services/logs/logs/WebService.php
diff --git a/okapi/services/logs/logs/docs.xml b/okapi/services/logs/logs/docs.xml
