From 624eda297f1e240061b02997ddec2b19ef99f1cf Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 7 Feb 2022 16:50:17 -0500 Subject: [PATCH] Clean up and document object, object list templates --- netbox/dcim/views.py | 7 +-- netbox/netbox/views/generic/bulk_views.py | 4 +- netbox/templates/dcim/device/base.html | 8 +--- netbox/templates/dcim/devicetype/base.html | 8 +--- netbox/templates/dcim/moduletype.html | 2 - netbox/templates/dcim/moduletype/base.html | 8 +--- netbox/templates/generic/object.html | 28 ++++++++++-- netbox/templates/generic/object_list.html | 53 ++++++++++++++-------- netbox/templates/ipam/aggregate/base.html | 7 +-- netbox/templates/ipam/iprange/base.html | 7 +-- netbox/templates/ipam/prefix/base.html | 7 +-- 11 files changed, 67 insertions(+), 72 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index c70f33074..1df1eb1ac 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -803,7 +803,6 @@ class DeviceTypeView(generic.ObjectView): return { 'instance_count': instance_count, - 'active_tab': 'devicetype', } @@ -953,11 +952,10 @@ class ModuleTypeView(generic.ObjectView): queryset = ModuleType.objects.prefetch_related('manufacturer') def get_extra_context(self, request, instance): - # instance_count = Module.objects.restrict(request.user).filter(device_type=instance).count() + instance_count = Module.objects.restrict(request.user).filter(module_type=instance).count() return { - # 'instance_count': instance_count, - 'active_tab': 'moduletype', + 'instance_count': instance_count, } @@ -1570,7 +1568,6 @@ class DeviceView(generic.ObjectView): return { 'services': services, 'vc_members': vc_members, - 'active_tab': 'device', } diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 8a6d1e49f..69ab42199 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -7,7 +7,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import FieldDoesNotExist, ValidationError from django.db import transaction, IntegrityError from django.db.models import ManyToManyField, ProtectedError -from django.forms import Form, ModelMultipleChoiceField, MultipleHiddenInput, Textarea +from django.forms import Form, ModelMultipleChoiceField, MultipleHiddenInput from django.http import HttpResponse from django.shortcuts import get_object_or_404, redirect, render from django_tables2.export import TableExport @@ -178,7 +178,7 @@ class ObjectListView(BaseMultiObjectView): }) context = { - 'content_type': content_type, + 'model': model, 'table': table, 'permissions': permissions, 'action_buttons': self.action_buttons, diff --git a/netbox/templates/dcim/device/base.html b/netbox/templates/dcim/device/base.html index 4d24717cd..ff139ee4a 100644 --- a/netbox/templates/dcim/device/base.html +++ b/netbox/templates/dcim/device/base.html @@ -95,13 +95,7 @@ {% endif %} {% endblock %} -{% block tab_items %} - - +{% block extra_tabs %} {% with tab_name='device-bays' devicebay_count=object.devicebays.count %} {% if active_tab == tab_name or devicebay_count %} - +{% block extra_tabs %} {% with tab_name='device-bay-templates' devicebay_count=object.devicebaytemplates.count %} {% if active_tab == tab_name or devicebay_count %} - +{% block extra_tabs %} {% with interface_count=object.interfacetemplates.count %} {% if interface_count %}
  • elements) + object_identifier: Unique identifier for the object + extra_controls: Additional action buttons to display + extra_tabs: Additional tabs to include + content: Page content + +Context: + object: The object instance being viewed +{% endcomment %} + {% block header %}
    {# Breadcrumbs #} @@ -66,11 +78,15 @@ {% block tabs %}
      - {% block tab_items %} - - {% endblock tab_items %} + {# Primary tab #} + + + {# Include any additional tabs #} + {% block extra_tabs %}{% endblock %} + + {# Object journal #} {% if perms.extras.view_journalentry %} {% with journal_viewname=object|viewname:'journal' %} {% url journal_viewname pk=object.pk as journal_url %} @@ -83,6 +99,8 @@ {% endif %} {% endwith %} {% endif %} + + {# Object changelog #} {% if perms.extras.view_objectchange %} {% with changelog_viewname=object|viewname:'changelog' %} {% url changelog_viewname pk=object.pk as changelog_url %} diff --git a/netbox/templates/generic/object_list.html b/netbox/templates/generic/object_list.html index eab544e30..59abac016 100644 --- a/netbox/templates/generic/object_list.html +++ b/netbox/templates/generic/object_list.html @@ -4,20 +4,37 @@ {% load render_table from django_tables2 %} {% load static %} -{% block title %}{{ content_type.model_class|meta:"verbose_name_plural"|bettertitle }}{% endblock %} +{% comment %} +Blocks: + extra_controls: Additional action buttons + bulk_buttons: Additional bulk action buttons to display beneath the objects + list + +Context: + model: The model class being listed + table: The table class used for rendering the list of objects + permissions: A mapping of add/change/delete permissions to boolean indicating + whether the current user possesses each of them. Controls the display of + add/edit/delete buttons. + action_buttons: A list of buttons to display. Options are add, import, export. + filter_form: The bound filterset form for filtering the objects list (optional) + return_url: Return URL to use for bulk actions (optional) +{% endcomment %} + +{% block title %}{{ model|meta:"verbose_name_plural"|bettertitle }}{% endblock %} {% block controls %}
      {% block extra_controls %}{% endblock %} {% if permissions.add and 'add' in action_buttons %} - {% add_button content_type.model_class|validated_viewname:"add" %} + {% add_button model|validated_viewname:"add" %} {% endif %} {% if permissions.add and 'import' in action_buttons %} - {% import_button content_type.model_class|validated_viewname:"import" %} + {% import_button model|validated_viewname:"import" %} {% endif %} {% if 'export' in action_buttons %} - {% export_button content_type %} + {% export_button model|content_type %} {% endif %}
      @@ -25,22 +42,20 @@ {% block tabs %}
        - {% block tab_items %} + + {% if filter_form %} - {% if filter_form %} - - {% endif %} - {% endblock tab_items %} + {% endif %}
      {% endblock tabs %} @@ -57,7 +72,7 @@ {# "Select all" form #} {% if table.paginator.num_pages > 1 %} - {% with bulk_edit_url=content_type.model_class|validated_viewname:"bulk_edit" bulk_delete_url=content_type.model_class|validated_viewname:"bulk_delete" %} + {% with bulk_edit_url=model|validated_viewname:"bulk_edit" bulk_delete_url=model|validated_viewname:"bulk_delete" %}
      {% csrf_token %} @@ -102,7 +117,7 @@ {# Form buttons #} {% if permissions.change or permissions.delete %} - {% with bulk_edit_url=content_type.model_class|validated_viewname:"bulk_edit" bulk_delete_url=content_type.model_class|validated_viewname:"bulk_delete" %} + {% with bulk_edit_url=model|validated_viewname:"bulk_edit" bulk_delete_url=model|validated_viewname:"bulk_delete" %}
      {% block bulk_buttons %}{% endblock %} diff --git a/netbox/templates/ipam/aggregate/base.html b/netbox/templates/ipam/aggregate/base.html index 09e17cf4f..c69661a65 100644 --- a/netbox/templates/ipam/aggregate/base.html +++ b/netbox/templates/ipam/aggregate/base.html @@ -7,12 +7,7 @@
    • {{ object.rir }}
      • {% endblock %} -{% block tab_items %} - +{% block extra_tabs %} {% if perms.ipam.view_prefix %} +{% block extra_tabs %} {% if perms.ipam.view_ipaddress %} +{% block extra_tabs %}