add the contract tab

Author: mlebreuil

CHANGELOG.md

@@ -8,6 +8,7 @@
 ### Version 2.4.5
 * [292](https://github.com/mlebreuil/netbox-contract/issues/292) bug fix. Contract detail show internal party value instead of label.
 
+* [294](https://github.com/mlebreuil/netbox-contract/issues/294) Add `contract_assignments_display` plugin setting (`tab`, `inline`, `both`) for contract assignment UI. The tab view allows customization of the contracts list table columns.
 
 ### Version 2.4.4
 * [288](https://github.com/mlebreuil/netbox-contract/issues/288) Add the possibility to assign contract any object type. By default the following objects types: 'circuits.circuit', 'circuits.virtualcircuit', 'dcim.site', 'dcim.device', 'dcim.rack', 'virtualization.virtualmachine', 'virtualization.cluster', 'ipam.ipaddress', 'ipam.prefix'. This list can be overriden within the PLUGINS_CONFIG configuration parameter. Check the README file or [documentation](https://mlebreuil.github.io/netbox-contract/) for more information.

README.md

@@ -74,12 +74,17 @@ PLUGINS_CONFIG = {
             'ipam.ipaddress',
             'ipam.prefix',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 }
 
 ```
 
 * top_level_menu : If "Contracts" appears under the "Plugins" menu item or on its own
+* contract_assignments_display:
+  * `'tab'` - only the Contracts view tab is visible on the related object page.
+  * `'inline'` - only the inline contract assignments table is shown in object detail; the Contracts tab is hidden.
+  * `'both'` - both tab and inline table are shown (default behavior).
 * default_accounting_dimensions: The accounting dimensions which will appear in the field' background when empty. Note that accounting dimensions are now managed as individual objects. The use of this field is deprecated.  
 * mandatory_contract_fields, mandatory_invoice_fields: Fields which are not required by default and can be set as such. The list of fields is at the bottom of the contract import form.
 * hidden_contract_fields, hidden_invoice_fields: List of fields to be hidden. Fields should not be required to be hidden.

netbox_contract/__init__.py

@@ -27,6 +27,7 @@ class ContractsConfig(PluginConfig):
             'virtualization.virtualmachine',
             'virtualization.cluster',
         ],
+        'contract_assignments_display': 'both',  # options: 'tab', 'inline', 'both'
     }
 
 

netbox_contract/template_content.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from netbox.plugins import PluginTemplateExtension
 
@@ -10,22 +11,34 @@ class ObjectContractAssignments(PluginTemplateExtension):
     models = ASSIGNEMENT_TYPES
 
     def full_width_page(self):
-        object = self.context['object']
-        object_type = ContentType.objects.get_for_model(object)
-
-        contract_assignments = ContractAssignment.objects.filter(
-            content_type__pk=object_type.id, object_id=object.id
-        )
-        assignments_table = tables.ContractAssignmentObjectTable(contract_assignments)
-        assignments_table.configure(self.context['request'])
-
-        return self.render(
-            'contract_assignments_bottom.html',
-            extra_context={
-                'assignments_table': assignments_table,
-            },
+        display = settings.PLUGINS_CONFIG.get('netbox_contract', {}).get(
+            'contract_assignments_display', 'both'
         )
 
+        # 'tab' means only the contract tab is shown; inline table stays hidden.
+        if display == 'tab':
+            return ''
+
+        # 'inline' or 'both' renders inline table; the tab is still built via ObjectChildrenView.
+        if display in ('inline', 'both'):
+            object = self.context['object']
+            object_type = ContentType.objects.get_for_model(object)
+
+            contract_assignments = ContractAssignment.objects.filter(
+                content_type__pk=object_type.id, object_id=object.id
+            )
+            assignments_table = tables.ContractAssignmentObjectTable(contract_assignments)
+            assignments_table.configure(self.context['request'])
+
+            return self.render(
+                'contract_assignments_bottom.html',
+                extra_context={
+                    'assignments_table': assignments_table,
+                },
+            )
+
+        return ''
+
 
 template_extensions = [
     ObjectContractAssignments,

netbox_contract/templates/netbox_contract/object_contracts.html

@@ -0,0 +1,7 @@
+{% extends 'generic/object_children.html' %}
+{% load buttons %}
+
+{% block table_controls %}
+    {# Only the page header action button is needed (avoid duplicate table button) #}
+    {{ block.super }}
+{% endblock table_controls %}

netbox_contract/views.py

@@ -1,19 +1,23 @@
 from datetime import date, timedelta
 
 from dateutil.relativedelta import relativedelta
+from django.apps import apps
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.models import Case, F, When
 from django.db.models.functions import Round
 from django.shortcuts import get_object_or_404, render
+from django.utils.translation import gettext_lazy as _
+from netbox.object_actions import *
 from netbox.views import generic
 from netbox.views.generic.utils import get_prerequisite_model
 from utilities.forms import restrict_form_fields
 from utilities.querydict import normalize_querydict
-from utilities.views import register_model_view
+from utilities.views import ViewTab, get_action_url, register_model_view
 
 from . import filtersets, forms, tables
+from .constants import ASSIGNEMENT_TYPES
 from .models import (
     AccountingDimension,
     Contract,
@@ -182,6 +186,66 @@ class ContractAssignmentBulkDeleteView(generic.BulkDeleteView):
     filterset = filtersets.ContractAssignmentFilterSet
     table = tables.ContractAssignmentListTable
 
+
+class AddContractAssignment(AddObject):
+    label = _('Add contract')
+
+    @classmethod
+    def get_url(cls, obj):
+        # obj will be the parent object in the custom template (ObjectChildren hook)
+        if hasattr(obj, 'pk') and hasattr(obj, '_meta') and obj.pk:
+            parent = obj
+            parent_ct = ContentType.objects.get_for_model(parent)
+            base_url = get_action_url(ContractAssignment, action='add')
+            return (
+                f"{base_url}?content_type={parent_ct.pk}"
+                f"&object_id={parent.pk}&return_url={parent.get_absolute_url()}"
+            )
+
+        # fallback for a class value (if called as model class)
+        return get_action_url(ContractAssignment, action='add')
+
+
+class BaseObjectContractAssignmentView(generic.ObjectChildrenView):
+    child_model = ContractAssignment
+    table = tables.ContractAssignmentObjectTable
+    filterset = filtersets.ContractAssignmentFilterSet
+    template_name = 'netbox_contract/object_contracts.html'
+    actions = (AddContractAssignment, BulkEdit, BulkDelete)
+    tab = ViewTab(
+        label=_('Contracts'),
+        visible=lambda obj: plugin_settings.get('contract_assignments_display', 'both') != 'inline',
+        badge=lambda obj: ContractAssignment.objects.filter(
+            content_type=ContentType.objects.get_for_model(obj), object_id=obj.id
+        ).count(),
+        permission='contracts.view_contractassignment',
+        weight=550,
+        hide_if_empty=True,
+    )
+
+    def get_children(self, request, parent):
+        object_type = ContentType.objects.get_for_model(parent)
+        contract_assignments = ContractAssignment.objects.filter(
+            content_type__pk=object_type.id, object_id=parent.id
+        )
+        return contract_assignments
+
+
+# Dynamically register the view for all supported models
+for model_string in ASSIGNEMENT_TYPES:
+    app_label, model_name = model_string.split('.')
+    model = apps.get_model(app_label, model_name)
+
+    class_name = f"{model_name.title()}ContractAssignmentView"
+    attrs = {
+        'queryset': model.objects.all(),
+        'viewname': f'netbox_contract:{model_name}_contracts',
+    }
+    view_class = type(class_name, (BaseObjectContractAssignmentView,), attrs)
+
+    register_model_view(model, 'contracts', path='contracts')(view_class)
+
+
 # Contract views