From 807753aa35a1de55650323a60371ceb16414bf7a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 Jan 2023 16:16:32 -0500 Subject: [PATCH] Enable HTMX rendering for embedded tables --- netbox/netbox/tables/tables.py | 13 ++- netbox/netbox/views/generic/bulk_views.py | 3 +- netbox/templates/dcim/connections_list.html | 2 +- .../templates/dcim/device/consoleports.html | 2 +- .../dcim/device/consoleserverports.html | 2 +- netbox/templates/dcim/device/devicebays.html | 2 +- netbox/templates/dcim/device/frontports.html | 2 +- netbox/templates/dcim/device/interfaces.html | 2 +- netbox/templates/dcim/device/inventory.html | 2 +- netbox/templates/dcim/device/modulebays.html | 2 +- .../templates/dcim/device/poweroutlets.html | 2 +- netbox/templates/dcim/device/powerports.html | 2 +- netbox/templates/dcim/device/rearports.html | 2 +- .../dcim/devicetype/component_templates.html | 4 +- .../dcim/moduletype/component_templates.html | 4 +- netbox/templates/generic/object_list.html | 2 +- netbox/templates/inc/paginator_htmx.html | 8 +- netbox/templates/inc/table_htmx.html | 109 +++++++++--------- netbox/templates/ipam/aggregate/prefixes.html | 2 +- .../templates/ipam/iprange/ip_addresses.html | 2 +- .../templates/ipam/prefix/ip_addresses.html | 2 +- netbox/templates/ipam/prefix/ip_ranges.html | 2 +- netbox/templates/ipam/prefix/prefixes.html | 2 +- netbox/templates/ipam/vlan/interfaces.html | 2 +- netbox/templates/ipam/vlan/vminterfaces.html | 2 +- netbox/templates/search.html | 2 +- .../virtualization/cluster/devices.html | 2 +- .../cluster/virtual_machines.html | 2 +- .../virtualmachine/interfaces.html | 2 +- netbox/utilities/htmx.py | 14 +++ 30 files changed, 112 insertions(+), 89 deletions(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 3a2e71084..741e7a2c1 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -4,6 +4,8 @@ from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType from django.core.exceptions import FieldDoesNotExist from django.db.models.fields.related import RelatedField +from django.urls import reverse +from django.urls.exceptions import NoReverseMatch from django.utils.safestring import mark_safe from django.utils.translation import gettext as _ from django_tables2.data import TableQuerysetData @@ -12,7 +14,7 @@ from extras.models import CustomField, CustomLink from extras.choices import CustomFieldVisibilityChoices from netbox.tables import columns from utilities.paginator import EnhancedPaginator, get_paginate_count -from utilities.utils import highlight_string, title +from utilities.utils import get_viewname, highlight_string, title __all__ = ( 'BaseTable', @@ -197,6 +199,15 @@ class NetBoxTable(BaseTable): super().__init__(*args, extra_columns=extra_columns, **kwargs) + @property + def htmx_url(self): + viewname = get_viewname(self._meta.model, action='list') + try: + return reverse(viewname) + except NoReverseMatch: + pass + return '' + class SearchTable(tables.Table): object_type = columns.ContentTypeColumn( diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index ab3e8f100..4953260d4 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -20,7 +20,7 @@ from utilities.choices import ImportFormatChoices from utilities.error_handlers import handle_protectederror from utilities.exceptions import AbortRequest, AbortTransaction, PermissionsViolation from utilities.forms import BulkRenameForm, ConfirmationForm, ImportForm, restrict_form_fields -from utilities.htmx import is_htmx +from utilities.htmx import is_embedded, is_htmx from utilities.permissions import get_permission_for_model from utilities.views import GetReturnURLMixin from .base import BaseMultiObjectView @@ -161,6 +161,7 @@ class ObjectListView(BaseMultiObjectView, ActionsMixin, TableMixin): # If this is an HTMX request, return only the rendered table HTML if is_htmx(request): + table.embedded = is_embedded(request) return render(request, 'htmx/table.html', { 'table': table, }) diff --git a/netbox/templates/dcim/connections_list.html b/netbox/templates/dcim/connections_list.html index ef8bef828..0d67dcaf0 100644 --- a/netbox/templates/dcim/connections_list.html +++ b/netbox/templates/dcim/connections_list.html @@ -12,7 +12,7 @@
{% include 'inc/table_controls_htmx.html' %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/consoleports.html b/netbox/templates/dcim/device/consoleports.html index 1f7cd037e..ccd12f61c 100644 --- a/netbox/templates/dcim/device/consoleports.html +++ b/netbox/templates/dcim/device/consoleports.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/consoleserverports.html b/netbox/templates/dcim/device/consoleserverports.html index 259a072b4..43396651d 100644 --- a/netbox/templates/dcim/device/consoleserverports.html +++ b/netbox/templates/dcim/device/consoleserverports.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/devicebays.html b/netbox/templates/dcim/device/devicebays.html index 5081b752b..9453b9a59 100644 --- a/netbox/templates/dcim/device/devicebays.html +++ b/netbox/templates/dcim/device/devicebays.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/frontports.html b/netbox/templates/dcim/device/frontports.html index 044337d00..dd0767d95 100644 --- a/netbox/templates/dcim/device/frontports.html +++ b/netbox/templates/dcim/device/frontports.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/interfaces.html b/netbox/templates/dcim/device/interfaces.html index 9de486a6f..c0e9a38b6 100644 --- a/netbox/templates/dcim/device/interfaces.html +++ b/netbox/templates/dcim/device/interfaces.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/inventory.html b/netbox/templates/dcim/device/inventory.html index 065fd92f6..9e11031ec 100644 --- a/netbox/templates/dcim/device/inventory.html +++ b/netbox/templates/dcim/device/inventory.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/modulebays.html b/netbox/templates/dcim/device/modulebays.html index 6358a3815..7f0aacf1f 100644 --- a/netbox/templates/dcim/device/modulebays.html +++ b/netbox/templates/dcim/device/modulebays.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/poweroutlets.html b/netbox/templates/dcim/device/poweroutlets.html index 35a9795d5..66b21b7af 100644 --- a/netbox/templates/dcim/device/poweroutlets.html +++ b/netbox/templates/dcim/device/poweroutlets.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/powerports.html b/netbox/templates/dcim/device/powerports.html index 69485c985..d9e1e121a 100644 --- a/netbox/templates/dcim/device/powerports.html +++ b/netbox/templates/dcim/device/powerports.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/device/rearports.html b/netbox/templates/dcim/device/rearports.html index 109e195dc..ce194cc78 100644 --- a/netbox/templates/dcim/device/rearports.html +++ b/netbox/templates/dcim/device/rearports.html @@ -10,7 +10,7 @@ {% csrf_token %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/devicetype/component_templates.html b/netbox/templates/dcim/devicetype/component_templates.html index 002a2044b..ca552a555 100644 --- a/netbox/templates/dcim/devicetype/component_templates.html +++ b/netbox/templates/dcim/devicetype/component_templates.html @@ -8,7 +8,7 @@ {% csrf_token %}
{{ title }}
-
+
{% include 'htmx/table.html' %}
@@ -36,7 +36,7 @@ {% else %}
{{ title }}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/dcim/moduletype/component_templates.html b/netbox/templates/dcim/moduletype/component_templates.html index d2806330a..15dedc0e1 100644 --- a/netbox/templates/dcim/moduletype/component_templates.html +++ b/netbox/templates/dcim/moduletype/component_templates.html @@ -8,7 +8,7 @@ {% csrf_token %}
{{ title }}
-
+
{% include 'htmx/table.html' %}
@@ -36,7 +36,7 @@ {% else %}
{{ title }}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/generic/object_list.html b/netbox/templates/generic/object_list.html index 8b3e317c0..e9deb4ff8 100644 --- a/netbox/templates/generic/object_list.html +++ b/netbox/templates/generic/object_list.html @@ -110,7 +110,7 @@ Context: {% endif %}
-
+
{% include 'htmx/table.html' %}
diff --git a/netbox/templates/inc/paginator_htmx.html b/netbox/templates/inc/paginator_htmx.html index e96dac858..c580bd9fc 100644 --- a/netbox/templates/inc/paginator_htmx.html +++ b/netbox/templates/inc/paginator_htmx.html @@ -8,7 +8,7 @@ {% if page.has_previous %} @@ -19,7 +19,7 @@ {% if p %} @@ -34,7 +34,7 @@ {% if page.has_next %} @@ -56,7 +56,7 @@
  • {{ n }} diff --git a/netbox/templates/inc/table_htmx.html b/netbox/templates/inc/table_htmx.html index 45bfb390d..4eedce72d 100644 --- a/netbox/templates/inc/table_htmx.html +++ b/netbox/templates/inc/table_htmx.html @@ -1,59 +1,56 @@ {% load django_tables2 %} - -
    - - {% if table.show_header %} - + + {% if table.show_header %} + + + {% for column in table.columns %} + {% if column.orderable %} + + {% if column.is_ordered %} +
    + +
    + {% endif %} + {{ column.header }} + + {% else %} + {{ column.header }} + {% endif %} + {% endfor %} + + + {% endif %} + + {% for row in table.page.object_list|default:table.rows %} + + {% for column, cell in row.items %} + {{ cell }} + {% endfor %} + + {% empty %} + {% if table.empty_text %} - {% for column in table.columns %} - {% if column.orderable %} - - {% if column.is_ordered %} -
    - -
    - {% endif %} - {{ column.header }} - - {% else %} - {{ column.header }} - {% endif %} - {% endfor %} + — {{ table.empty_text }} — - - {% endif %} - - {% for row in table.page.object_list|default:table.rows %} - - {% for column, cell in row.items %} - {{ cell }} - {% endfor %} - - {% empty %} - {% if table.empty_text %} - - — {{ table.empty_text }} — - - {% endif %} - {% endfor %} - - {% if table.has_footer %} - - - {% for column in table.columns %} - {{ column.footer }} - {% endfor %} - - - {% endif %} - -
    + {% endif %} + {% endfor %} + + {% if table.has_footer %} + + + {% for column in table.columns %} + {{ column.footer }} + {% endfor %} + + + {% endif %} + diff --git a/netbox/templates/ipam/aggregate/prefixes.html b/netbox/templates/ipam/aggregate/prefixes.html index 8256236f4..a1d3bd276 100644 --- a/netbox/templates/ipam/aggregate/prefixes.html +++ b/netbox/templates/ipam/aggregate/prefixes.html @@ -18,7 +18,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/iprange/ip_addresses.html b/netbox/templates/ipam/iprange/ip_addresses.html index 61b2ee335..9f77f6c78 100644 --- a/netbox/templates/ipam/iprange/ip_addresses.html +++ b/netbox/templates/ipam/iprange/ip_addresses.html @@ -16,7 +16,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/prefix/ip_addresses.html b/netbox/templates/ipam/prefix/ip_addresses.html index 31a22497d..fe68039f8 100644 --- a/netbox/templates/ipam/prefix/ip_addresses.html +++ b/netbox/templates/ipam/prefix/ip_addresses.html @@ -16,7 +16,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/prefix/ip_ranges.html b/netbox/templates/ipam/prefix/ip_ranges.html index 45b1d4fd0..4452fd5a7 100644 --- a/netbox/templates/ipam/prefix/ip_ranges.html +++ b/netbox/templates/ipam/prefix/ip_ranges.html @@ -16,7 +16,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/prefix/prefixes.html b/netbox/templates/ipam/prefix/prefixes.html index 46fa29581..5fc931f74 100644 --- a/netbox/templates/ipam/prefix/prefixes.html +++ b/netbox/templates/ipam/prefix/prefixes.html @@ -18,7 +18,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/vlan/interfaces.html b/netbox/templates/ipam/vlan/interfaces.html index 5707d5364..f7bcc8563 100644 --- a/netbox/templates/ipam/vlan/interfaces.html +++ b/netbox/templates/ipam/vlan/interfaces.html @@ -7,7 +7,7 @@
    {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/ipam/vlan/vminterfaces.html b/netbox/templates/ipam/vlan/vminterfaces.html index ef4a0730a..a485b33eb 100644 --- a/netbox/templates/ipam/vlan/vminterfaces.html +++ b/netbox/templates/ipam/vlan/vminterfaces.html @@ -7,7 +7,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/search.html b/netbox/templates/search.html index e801422c9..74eaaac20 100644 --- a/netbox/templates/search.html +++ b/netbox/templates/search.html @@ -30,7 +30,7 @@
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/virtualization/cluster/devices.html b/netbox/templates/virtualization/cluster/devices.html index cb4a1b3ee..083798233 100644 --- a/netbox/templates/virtualization/cluster/devices.html +++ b/netbox/templates/virtualization/cluster/devices.html @@ -8,7 +8,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/virtualization/cluster/virtual_machines.html b/netbox/templates/virtualization/cluster/virtual_machines.html index 9cb33258f..79c489d6b 100644 --- a/netbox/templates/virtualization/cluster/virtual_machines.html +++ b/netbox/templates/virtualization/cluster/virtual_machines.html @@ -8,7 +8,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/templates/virtualization/virtualmachine/interfaces.html b/netbox/templates/virtualization/virtualmachine/interfaces.html index eff98cdd6..71456d104 100644 --- a/netbox/templates/virtualization/virtualmachine/interfaces.html +++ b/netbox/templates/virtualization/virtualmachine/interfaces.html @@ -9,7 +9,7 @@ {% csrf_token %}
    -
    +
    {% include 'htmx/table.html' %}
    diff --git a/netbox/utilities/htmx.py b/netbox/utilities/htmx.py index 8fc568e2b..347453e94 100644 --- a/netbox/utilities/htmx.py +++ b/netbox/utilities/htmx.py @@ -1,5 +1,19 @@ +from urllib.parse import urlparse + + def is_htmx(request): """ Returns True if the request was made by HTMX; False otherwise. """ return 'Hx-Request' in request.headers + + +def is_embedded(request): + """ + Returns True if the request indicates that it originates from a URL different from + the path being requested. + """ + hx_current_url = request.headers.get('HX-Current-URL', None) + if not hx_current_url: + return False + return request.path != urlparse(hx_current_url).path