From ced47590b72f97318d07a73d5ee6e0b56c06a886 Mon Sep 17 00:00:00 2001
From: jeremystretch <jstretch@netboxlabs.com>
Date: Wed, 31 May 2023 15:00:27 -0400
Subject: [PATCH] Introduce htmx_table template tag for embedding HTMX-backed
 object tables

---
 netbox/netbox/tables/columns.py               |  4 ++--
 .../inc/panels/image_attachments.html         |  8 ++------
 .../templates/builtins/htmx_table.html        |  4 ++++
 .../utilities/templatetags/builtins/tags.py   | 20 +++++++++++++++++++
 4 files changed, 28 insertions(+), 8 deletions(-)
 create mode 100644 netbox/utilities/templates/builtins/htmx_table.html

diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py
index 1446ee277..9ef327026 100644
--- a/netbox/netbox/tables/columns.py
+++ b/netbox/netbox/tables/columns.py
@@ -236,9 +236,9 @@ class ActionsColumn(tables.Column):
         model = table.Meta.model
         if request := getattr(table, 'context', {}).get('request'):
             return_url = request.GET.get('return_url', request.get_full_path())
+            url_appendix = f'?return_url={quote(return_url)}'
         else:
-            return_url = ''
-        url_appendix = f'?return_url={quote(return_url)}' if return_url else ''
+            url_appendix = ''
 
         html = ''
 
diff --git a/netbox/templates/inc/panels/image_attachments.html b/netbox/templates/inc/panels/image_attachments.html
index 463b6716b..a09fe78d5 100644
--- a/netbox/templates/inc/panels/image_attachments.html
+++ b/netbox/templates/inc/panels/image_attachments.html
@@ -1,12 +1,8 @@
 {% load helpers %}
 
 <div class="card">
-  <h5 class="card-header">
-    Images
-  </h5>
-  <div class="card-body htmx-container table-responsive"
-  hx-get="{% url 'extras:imageattachment_list' %}?content_type_id={{ object|content_type_id }}&object_id={{ object.pk }}&return_url={{ request.path }}"
-  hx-trigger="load"></div>
+  <h5 class="card-header">Images</h5>
+  {% htmx_table 'extras:imageattachment_list' content_type_id=object|content_type_id object_id=object.pk %}
   {% if perms.extras.add_imageattachment %}
     <div class="card-footer text-end noprint">
       <a href="{% url 'extras:imageattachment_add' %}?content_type={{ object|content_type_id }}&object_id={{ object.pk }}" class="btn btn-primary btn-sm">
diff --git a/netbox/utilities/templates/builtins/htmx_table.html b/netbox/utilities/templates/builtins/htmx_table.html
new file mode 100644
index 000000000..7e871931c
--- /dev/null
+++ b/netbox/utilities/templates/builtins/htmx_table.html
@@ -0,0 +1,4 @@
+<div class="card-body htmx-container table-responsive"
+  hx-get="{% url viewname %}{% if url_params %}?{{ url_params.urlencode }}{% endif %}"
+  hx-trigger="load"
+></div>
diff --git a/netbox/utilities/templatetags/builtins/tags.py b/netbox/utilities/templatetags/builtins/tags.py
index cdc517b97..dc86586e7 100644
--- a/netbox/utilities/templatetags/builtins/tags.py
+++ b/netbox/utilities/templatetags/builtins/tags.py
@@ -1,4 +1,5 @@
 from django import template
+from django.http import QueryDict
 
 __all__ = (
     'badge',
@@ -74,3 +75,22 @@ def checkmark(value, show_false=True, true='Yes', false='No'):
         'true_label': true,
         'false_label': false,
     }
+
+
+@register.inclusion_tag('builtins/htmx_table.html', takes_context=True)
+def htmx_table(context, viewname, return_url=None, **kwargs):
+    """
+    Embed an object list table retrieved using HTMX. Any extra keyword arguments are passed as URL query parameters.
+
+    Args:
+        context: The current request context
+        viewname: The name of the view to use for the HTMX request (e.g. `dcim:site_list`)
+        return_url: The URL to pass as the `return_url`. If not provided, the current request's path will be used.
+    """
+    url_params = QueryDict(mutable=True)
+    url_params.update(kwargs)
+    url_params['return_url'] = return_url or context['request'].path
+    return {
+        'viewname': viewname,
+        'url_params': url_params,
+    }