Introducing JoinManager (wip)

Author: GeoSander

pygeoapi/api/joins.py

@@ -28,6 +28,7 @@
 
 import logging
 from typing import Any
+from datetime import datetime, timedelta, timezone
 
 from pygeoapi import l10n, join_util
 from pygeoapi.api import (
@@ -39,7 +40,8 @@
 from pygeoapi.provider.base import ProviderTypeError, ProviderGenericError
 from pygeoapi.util import (
     get_provider_by_type, to_json, filter_providers_by_type,
-    filter_dict_by_key_value, get_current_datetime, render_j2_template
+    filter_dict_by_key_value, get_current_datetime, render_j2_template,
+    str_to_datetime
 )
 
 LOGGER = logging.getLogger(__name__)
@@ -707,6 +709,12 @@ def join_details(api: API, request: APIRequest,
     l10n.set_response_language(headers, request.locale)
 
     if request.format == F_HTML:  # render
+        join_created = str_to_datetime(output['details']['created'])
+        if datetime.now(timezone.utc) - join_created < timedelta(seconds=10):
+            # If join is less than 10 seconds old, we were probably redirected
+            # by create_join(): add a message that join was successful
+            output['description'] = l10n.translate(
+                'Join source created successfully.', request.locale)
         title = f'{collections[dataset]['title']} - Join Source'
         content = _render_html(api, request, dataset,
                                'collections/joinsource.html', title, output)
@@ -761,6 +769,19 @@ def create_join(api: API, request: APIRequest,
 
         uri = f'{api.get_collections_url()}/{dataset}'
         join_id = details['id']
+
+        # Set response language to requested provider locale
+        # (if it supports language) and/or otherwise the requested pygeoapi
+        # locale (or fallback default locale)
+        l10n.set_response_language(headers, prv_locale, request.locale)
+
+        if request.format == F_HTML:
+            # For HTML only, we'll redirect to the join details page instead
+            # to avoid form resubmission. This is known as the PRG pattern:
+            # https://en.wikipedia.org/wiki/Post/Redirect/Get
+            headers['Location'] = f'{uri}/joins/{join_id}'
+            return headers, HTTPStatus.SEE_OTHER, 'created successfully'
+
         output = {
             'id': join_id,
             'timeStamp': get_current_datetime(),
@@ -819,19 +840,6 @@ def create_join(api: API, request: APIRequest,
         msg = f'Failed to create join: {str(e)}'
         return _server_error(api, request, headers, msg)
 
-    # Set response language to requested provider locale
-    # (if it supports language) and/or otherwise the requested pygeoapi
-    # locale (or fallback default locale)
-    l10n.set_response_language(headers, prv_locale, request.locale)
-
-    if request.format == F_HTML:
-        # Render same page as join details to show result of POST
-        title = f'{collections[dataset]['title']} - Join Source'
-        content = _render_html(api, request, dataset,
-                               'collections/joinsource.html', title, output,
-                               description="Join source created successfully.")
-        return headers, HTTPStatus.OK, content
-
     return headers, HTTPStatus.OK, to_json(output, api.pretty_print)
 
 

pygeoapi/flask_app.py

@@ -436,8 +436,8 @@ def joins(collection_id, joinId=None):
                                       collection_id, joinId)
     elif request.method == 'POST':
         # Create a new join
-        return execute_from_flask(joins_api.create_join, request,
-                                  collection_id)
+        return execute_from_flask(joins_api.create_join,
+                                  request, collection_id)
     else:
         # Delete an existing join
         return execute_from_flask(joins_api.delete_join, request,

pygeoapi/join/__init__.py

@@ -0,0 +1,27 @@
+# =================================================================
+# Authors: Sander Schaminee <sander.schaminee@geocat.net>
+#
+# Copyright (c) 2025 Sander Schaminee
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================