Token urls

CONTRIBUTING.md

@@ -7,10 +7,10 @@
 
 
 There are two primary ways to help:
+
  - Using the issue tracker, and
  - Changing the code-base.
 
-
 ## Using the issue tracker
 
 Use the issue tracker to suggest feature requests, report bugs, and ask questions.

README.rst

@@ -117,6 +117,18 @@ Shared pages will also have a new dropdown menu option that links to this sharin
     :alt: Dropdown with sharing link
     :width: 640px
 
+To use tokens in place of the page path on the sharing site, add the following setting:
+
+.. code-block:: python
+
+  WAGTAILSHARING_TOKENIZE_URL = True
+
+In some environments such as Heroku, SERVER_PORT set at release time and the real port is fowarded, so the following is needed in settings:
+
+.. code-block:: python
+
+  USE_X_FORWARDED_PORT = True
+
 Hooks
 -----
 

pyproject.toml

@@ -10,6 +10,7 @@ authors = [
 ]
 dependencies = [
     "wagtail>=5.1",
+    "pyjwt>=2.0,<3.0"
 ]
 classifiers = [
     "Framework :: Django",

wagtailsharing/helpers.py

@@ -1,8 +1,19 @@
+from django.conf import settings
+
 from wagtail.models import Site
 
+import jwt
+
 from wagtailsharing.models import SharingSite
 
 
+def get_tokenized_sharing_url(sharing_site, page_path):
+    share_path = getattr(settings, "WAGTAILSHARING_TOKEN_SHARE_PATH", "share")
+    payload = {"path": page_path}
+    hash = jwt.encode(payload, settings.SECRET_KEY, algorithm="HS256")
+    return "/".join([sharing_site.root_url, share_path, hash])
+
+
 def get_sharing_url(page):
     """Get a sharing URL for a page, if available."""
 
@@ -27,4 +38,7 @@ def get_sharing_url(page):
         # Site is not shared.
         return None
 
+    if getattr(settings, "WAGTAILSHARING_TOKENIZE_URL", False):
+        return get_tokenized_sharing_url(sharing_site, page_path)
+
     return sharing_site.root_url + page_path

wagtailsharing/urls.py

@@ -1,9 +1,10 @@
+from django.conf import settings
 from django.urls import re_path
 
 from wagtail.urls import serve_pattern
 from wagtail.urls import urlpatterns as wagtailcore_urlpatterns
 
-from wagtailsharing.views import ServeView
+from wagtailsharing.views import ServeView, TokenServeView
 
 
 urlpatterns = [
@@ -12,3 +13,20 @@
     else urlpattern
     for urlpattern in wagtailcore_urlpatterns
 ]
+
+if getattr(settings, "WAGTAILSHARING_TOKENIZE_URL", False):
+    share_path = getattr(settings, "WAGTAILSHARING_TOKEN_SHARE_PATH", "share")
+    urlpatterns = wagtailcore_urlpatterns + [
+        re_path(
+            rf"^{share_path}/([\w\.\-\_]+)/$",
+            TokenServeView.as_view(),
+            name="wagtail_serve",
+        )
+    ]
+else:
+    urlpatterns = [
+        re_path(serve_pattern, ServeView.as_view(), name="wagtail_serve")
+        if urlpattern.name == "wagtail_serve"
+        else urlpattern
+        for urlpattern in wagtailcore_urlpatterns
+    ]

wagtailsharing/views.py

@@ -1,5 +1,7 @@
 import inspect
+import logging
 
+from django.conf import settings
 from django.http import Http404, HttpResponse
 from django.views.generic import View
 
@@ -9,19 +11,26 @@
 from wagtail.url_routing import RouteResult
 from wagtail.views import serve as wagtail_serve
 
+import jwt
+
 from wagtailsharing.models import SharingSite
 
 
 class ServeView(View):
-    def dispatch(self, request, path):
-        if request.method.upper() != "GET":
-            return wagtail_serve(request, path)
-
+    def get_sharing_site(self, request, path):
         try:
             sharing_site = SharingSite.find_for_request(request)
         except SharingSite.DoesNotExist:
             sharing_site = None
 
+        return sharing_site
+
+    def dispatch(self, request, path):
+        if request.method.upper() != "GET":
+            return wagtail_serve(request, path)
+
+        sharing_site = self.get_sharing_site(request, path)
+
         if not sharing_site:
             return wagtail_serve(request, path)
 
@@ -109,3 +118,30 @@ def serve(page, request, args, kwargs):
                 return result
 
         return response
+
+
+class TokenServeView(ServeView):
+    def dispatch(self, request, path):
+        if request.method.upper() != "GET":
+            return wagtail_serve(request, path)
+
+        sharing_site = self.get_sharing_site(request, path)
+
+        if not sharing_site:
+            return wagtail_serve(request, path)
+
+        try:
+            # Get the wagtail path from the JWT token
+            data = jwt.decode(path, settings.SECRET_KEY, algorithms=["HS256"])
+            decoded_path = data["path"]
+        except Exception as e:
+            logging.warn(
+                f"Could not decode Wagtail path from sharing link: {e}"
+            )
+            return wagtail_serve(request, path)
+
+        page, args, kwargs = self.route(
+            sharing_site.site, request, decoded_path
+        )
+
+        return self.serve(page, request, args, kwargs)