Add autolinks

Author: fsbraun

djangocms_rest/plugin_rendering.py

@@ -2,6 +2,8 @@
 from typing import Any, Iterable, Optional, TypeVar
 
 from django.contrib.sites.shortcuts import get_current_site
+from django.core.exceptions import ValidationError
+from django.core.validators import URLValidator
 from django.db import models
 from django.utils.html import escape, mark_safe
 
@@ -88,14 +90,27 @@ def escapestr(s: str) -> str:
     return escape(json.dumps(s)[1:-1])  # Remove quotes added by json.dumps
 
 
+def is_valid_url(url):
+    validator = URLValidator()
+    try:
+        validator(url)
+        return True
+    except ValidationError:
+        return False
+
+
 def highlight_data(json_data: Any, drop_frame: bool = False) -> str:
     """
     Highlight single JSON data element.
     """
     if isinstance(json_data, str):
+        classes = "str"
         if len(json_data) > 60:
-            return f'<span class="str">"<span class="ellipsis">{escapestr(json_data)}</span>"</span>'
-        return f'<span class="str">"{escapestr(json_data)}"</span>'
+            classes = "str ellipsis"
+
+        if is_valid_url(json_data):
+            return f'<span class="{ classes }">"<a href="{ json_data }">{escapestr(json_data)}</a>"</span>'
+        return f'<span class="{ classes }">"{escapestr(json_data)}"</span>'
     if isinstance(json_data, bool):
         return f'<span class="bool">{str(json_data).lower()}</span>'
     if isinstance(json_data, (int, float)):

djangocms_rest/serializers/pages.py

@@ -166,7 +166,9 @@ def to_representation(self, page_content: PageContent) -> dict:
         data = self.get_base_representation(page_content)
         data["placeholders"] = PlaceholderRelationSerializer(
             placeholders_data,
+            language=page_content.language,
             many=True,
+            context={"request": self.request},
         ).data
         return data
 
@@ -193,6 +195,8 @@ def to_representation(self, page_content: PageContent) -> dict:
         data = self.get_base_representation(page_content)
         data["placeholders"] = PlaceholderRelationSerializer(
             placeholders_data,
+            language=page_content.language,
+            context={"request": self.request},
             many=True,
         ).data
         return data

djangocms_rest/serializers/placeholders.py

@@ -1,8 +1,10 @@
 from django.template import Context
+from django.urls import reverse
 
 from rest_framework import serializers
 
 from djangocms_rest.serializers.utils.render import render_html
+from djangocms_rest.utils import get_absolute_frontend_url
 
 
 class PlaceholderSerializer(serializers.Serializer):
@@ -49,7 +51,28 @@ class PlaceholderRelationSerializer(serializers.Serializer):
     content_type_id = serializers.IntegerField()
     object_id = serializers.IntegerField()
     slot = serializers.CharField()
+    details = serializers.URLField()
 
     def __init__(self, *args, **kwargs):
+        language = kwargs.pop("language", None)
         super().__init__(*args, **kwargs)
         self.request = self.context.get("request")
+        self.language = language
+
+    def to_representation(self, instance):
+        instance["details"] = self.get_details(instance)
+        return super().to_representation(instance)
+
+    def get_details(self, instance):
+        return get_absolute_frontend_url(
+            self.request,
+            reverse(
+                "placeholder-detail",
+                args=[
+                    self.language,
+                    instance.get("content_type_id"),
+                    instance.get("object_id"),
+                    instance.get("slot"),
+                ],
+            ),
+        )

djangocms_rest/views.py

@@ -1,4 +1,5 @@
 from django.contrib.sites.shortcuts import get_current_site
+from django.utils.functional import lazy
 
 from cms.models import Page, PageContent, Placeholder
 from cms.utils.conf import get_languages
@@ -22,7 +23,6 @@
 from djangocms_rest.serializers.plugins import PluginDefinitionSerializer
 from djangocms_rest.utils import get_object, get_site_filtered_queryset
 from djangocms_rest.views_base import BaseAPIView, BaseListAPIView
-from django.utils.functional import lazy
 
 
 try:
@@ -225,6 +225,7 @@ class PluginDefinitionView(BaseAPIView):
     """
 
     serializer_class = PluginDefinitionSerializer
+    queryset = Page.objects.none()  # Dummy queryset to satisfy DRF
 
     def get(self, request: Request) -> Response:
         """Get all plugin definitions"""

tests/test_plugin_renderer.py

@@ -184,7 +184,7 @@ def test_edit_endpoint(self):
         # Test image plugin resolves image URL
         self.assertContains(
             response,
-            f'"filer_image"</span>: <span class="str">"<span class="ellipsis">http://testserver{self.image_plugin.filer_image.url}</span>"</span>',
+            f'"filer_image"</span>: <span class="str ellipsis">"http://testserver{self.image_plugin.filer_image.url}"</span>',
         )
 
         # Test for rendering of numbers